com.infoengine.connector
Class Attribute

java.lang.Object
  com.infoengine.connector.Data
      com.infoengine.connector.Attribute

All Implemented Interfaces:

java.io.Serializable

public class Attribute
extends Data

represents Info*Engine attribute data
Attributes have names and can contain one or more Objects as values.
Attributes are contained within Elements. The concept of State here is simply a place holder for Info*Engine attribute state information. If state for an attribute value is non-null then the state value should be the external form of a State object. If this group was generated as the result of deserializing Info*Engine XML and the state for an attribute value is non-null then the state value will be the external form of a State object.

See Also:

Group, Element, Serialized Form

Constructor Summary

Attribute()
create a new unnamed attribute

Attribute(java.lang.String name)
create a new named attribute

Attribute(java.lang.String name, java.lang.Object value)
create a new named attrbute with a value

Method Summary

void	addValue(java.lang.Object value) add a value to this attribute.
void	addValue(java.lang.Object value, java.lang.String state) add a value with a state to this attribute
boolean	equals(java.lang.Object other) test this attribute against another for equality
java.lang.String	getName() get this attribute's name
int	getSize() return the number of values this attribute has
java.lang.String	getState() retrieve the state of the first attribute value
java.lang.String	getStateAt(int index) retrieve the state of a specific attribute by index
java.lang.Object	getValue() get the value of this attribute.
java.lang.Object	getValueAt(int index) get an attribute value by index
java.util.Enumeration	getValues() get an Enumeration of this attributes values.
int	hashCode() generate this attribute's hashCode the value is based on attribute name, all its values and metadata.
void	setState(java.lang.String state) set the state of the first attribute value
void	setStateAt(java.lang.String state, int index) set the state of an attribute value by index.
void	setValue(java.lang.Object value) set this attributes value.
void	setValueAt(java.lang.Object value, int index) set an attribute value by index.
java.lang.String	toString() return a String representation of this Attribute (resembles XML useful for debugging only)

Methods inherited from class com.infoengine.connector.Data

addMetaValue, getMetaNames, getMetaValue, getMetaValues, removeMetaValues, setMetaValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Attribute

public Attribute()

create a new unnamed attribute

Attribute

public Attribute(java.lang.String name)

create a new named attribute

Parameters:

name - attribute name

Attribute

public Attribute(java.lang.String name,
                 java.lang.Object value)

create a new named attrbute with a value

Parameters:

name - attribute name

value - attribute value

Method Detail

setValue

public void setValue(java.lang.Object value)

set this attributes value. all other value(s) will be replaced with the single new value.

Parameters:

value - the new value

addValue

public void addValue(java.lang.Object value)

add a value to this attribute.

Parameters:

value - a new value to add

addValue

public void addValue(java.lang.Object value,
                     java.lang.String state)

add a value with a state to this attribute

Parameters:

value - a new value to add

state - the state of that value

getValue

public java.lang.Object getValue()

get the value of this attribute. if the attribute is multi-valued then the first value is returned.

Returns:

Object or null if no value

getValues

public java.util.Enumeration getValues()

get an Enumeration of this attributes values.

Returns:

Enumeration

getSize

public int getSize()

return the number of values this attribute has

Returns:

int

getValueAt

public java.lang.Object getValueAt(int index)

get an attribute value by index

Parameters:

index - the index of the value to retrieve

Returns:

Object the value at index or null if invalid index.

setValueAt

public void setValueAt(java.lang.Object value,
                       int index)

set an attribute value by index. if index is greater than the number of current attributes then the result is the same as calling addValue.

Parameters:

value - the value to set

index - the index to replace

getName

public java.lang.String getName()

get this attribute's name

Returns:

String

getState

public java.lang.String getState()

retrieve the state of the first attribute value

Returns:

String

getStateAt

public java.lang.String getStateAt(int index)

retrieve the state of a specific attribute by index

Returns:

String or null if null state or invalid index

setState

public void setState(java.lang.String state)

set the state of the first attribute value

Parameters:

state - the new attribute state

setStateAt

public void setStateAt(java.lang.String state,
                       int index)

set the state of an attribute value by index. the call is ignored if index is invalid

Parameters:

state - the new attribute state

index - the attribute index

equals

public boolean equals(java.lang.Object other)

test this attribute against another for equality

Overrides:

equals in class Data

Returns:

boolean

hashCode

public int hashCode()

generate this attribute's hashCode
the value is based on attribute name, all its values and metadata.

Overrides:

hashCode in class Data

Returns:

int

toString

public java.lang.String toString()

return a String representation of this Attribute (resembles XML useful for debugging only)

Overrides:

toString in class java.lang.Object

Returns:

String