com.ibm.dse.base
Class DataField

java.lang.Object
  |
  +--com.ibm.dse.base.DataElement
        |
        +--com.ibm.dse.base.DataField
Direct Known Subclasses:
CounterElement, DataField, OperField, TraceRequesterField

public class DataField
extends DataElement

The DataField class is the basic unit of the data container. It can be ordered by collections.

See Also:
Serialized Form

Field Summary
protected  java.lang.Object value
           
 
Fields inherited from class com.ibm.dse.base.DataElement
description, name, state
 
Constructor Summary
DataField()
          This constructor creates the DataField object.
DataField(java.lang.String aName)
          This constructor creates the DataField object with the id aName.
 
Method Summary
 java.lang.Object clone()
          Returns a new DataField cloned from the current one.
 java.lang.Object getValue()
          Gets the value property (java.lang.Object) value.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a DataField with the aTag attributes.
 Vector nestedElements()
          Returns an empty Vector.
 void nestedElements(java.util.Hashtable theTable)
          Returns all the DataElements included in this collection at any level.
 Vector nestedFields()
          Returns a Vector containing itself.
 void readExternal(java.io.ObjectInput s)
          Invokes the object creation from an ObjectInput.
 void setValidValue(boolean aValue)
          Set the value attribute to the corresponding Boolean making the conversion from boolean.
 void setValidValue(byte aValue)
          Sets the value attribute to the corresponding Byte making the conversion from byte.
 void setValidValue(char aValue)
          Sets the value attribute to the corresponding Character making the conversion from char.
 void setValidValue(double aValue)
          Sets the value attribute to the corresponding Double making the conversion from double.
 void setValidValue(float aValue)
          Sets the value attribute to the corresponding Float making the conversion from float.
 void setValidValue(int aValue)
          Sets the value attribute to the corresponding Integer making the conversion from int.
 void setValidValue(long aValue)
          Sets the value attribute to the corresponding Long making the conversion from long.
 void setValidValue(java.lang.Object aValue)
          Sets the value property (java.lang.Object) value.
 void setValue(boolean aValue)
          Set the value attribute to the corresponding Boolean making the conversion from boolean.
 void setValue(byte aValue)
          Sets the value attribute to the corresponding Byte making the conversion from byte.
 void setValue(char aValue)
          Sets the value attribute to the corresponding Character making the conversion from char.
 void setValue(double aValue)
          Sets the value attribute to the corresponding Double making the conversion from double.
 void setValue(float aValue)
          Sets the value attribute to the corresponding Float making the conversion from float.
 void setValue(int aValue)
          Sets the value attribute to the corresponding Integer making the conversion from int.
 void setValue(long aValue)
          Sets the value attribute to the corresponding Long making the conversion from long.
 void setValue(java.lang.Object aValue)
          Sets the value property (java.lang.Object) value.
 java.lang.String toString()
          Returns a visual representation of the DataField.
 java.lang.Object validate(java.lang.Object toValidate)
          Validates an object using its property descriptor
protected  void validateState(java.lang.Object toValidate)
          Validates an object using the state attribute.
 void writeExternal(java.io.ObjectOutput s)
          Provides concrete serialization handling for DataField.
 
Methods inherited from class com.ibm.dse.base.DataElement
externalizer, getDescription, getDescriptor, getElementAt, getErrorInfo, getExternalizer, getKey, getName, getState, getTagName, readExternal, readObject, removeElementAt, removeExternal, setDescription, setDescriptor, setErrorInfo, setExternalizer, setName, setState, toStrings, toTags, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

value

protected java.lang.Object value
Constructor Detail

DataField

public DataField()
This constructor creates the DataField object.

DataField

public DataField(java.lang.String aName)
          throws java.io.IOException
This constructor creates the DataField object with the id aName.
Parameters:
aName - java.lang.String
Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a new DataField cloned from the current one.
Overrides:
clone in class DataElement
Returns:
java.lang.Object

getValue

public java.lang.Object getValue()
Gets the value property (java.lang.Object) value.
Overrides:
getValue in class DataElement
Returns:
The value property value.
See Also:
setValue(byte)

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException
Initializes a DataField with the aTag attributes.
Parameters:
aTag - Tag
Returns:
DataField

nestedElements

public Vector nestedElements()
Returns an empty Vector.
Overrides:
nestedElements in class DataElement
Returns:
com.ibm.dse.base.Vector

nestedElements

public void nestedElements(java.util.Hashtable theTable)
Returns all the DataElements included in this collection at any level.
Overrides:
nestedElements in class DataElement
Returns:
java.util.Hashtable

nestedFields

public Vector nestedFields()
Returns a Vector containing itself.
Overrides:
nestedFields in class DataElement
Returns:
com.ibm.dse.base.Vector

readExternal

public void readExternal(java.io.ObjectInput s)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Invokes the object creation from an ObjectInput.
Overrides:
readExternal in class DataElement
Parameters:
s - java.io.ObjectInput
Throws:
java.io.IOException. -  
java.lang.ClassNotFoundException. -  

setValidValue

public void setValidValue(byte aValue)
                   throws DSETypeException
Sets the value attribute to the corresponding Byte making the conversion from byte.
Parameters:
aValue - byte

setValidValue

public void setValidValue(char aValue)
                   throws DSETypeException
Sets the value attribute to the corresponding Character making the conversion from char.
Parameters:
aValue - char

setValidValue

public void setValidValue(double aValue)
                   throws DSETypeException
Sets the value attribute to the corresponding Double making the conversion from double.
Parameters:
aValue - double

setValidValue

public void setValidValue(float aValue)
                   throws DSETypeException
Sets the value attribute to the corresponding Float making the conversion from float.
Parameters:
aValue - float

setValidValue

public void setValidValue(int aValue)
                   throws DSETypeException
Sets the value attribute to the corresponding Integer making the conversion from int.
Parameters:
aValue - int

setValidValue

public void setValidValue(long aValue)
                   throws DSETypeException
Sets the value attribute to the corresponding Long making the conversion from long.
Parameters:
aValue - long

setValidValue

public void setValidValue(java.lang.Object aValue)
                   throws DSETypeException
Sets the value property (java.lang.Object) value.
Parameters:
value - The new value for the property.
See Also:
getValue()

setValidValue

public void setValidValue(boolean aValue)
                   throws DSETypeException
Set the value attribute to the corresponding Boolean making the conversion from boolean.
Parameters:
aValue - boolean

setValue

public void setValue(byte aValue)
Sets the value attribute to the corresponding Byte making the conversion from byte.
Parameters:
aValue - byte

setValue

public void setValue(char aValue)
Sets the value attribute to the corresponding Character making the conversion from char.
Parameters:
aValue - char

setValue

public void setValue(double aValue)
Sets the value attribute to the corresponding Double making the conversion from double.
Parameters:
aValue - double

setValue

public void setValue(float aValue)
Sets the value attribute to the corresponding Float making the conversion from float.
Parameters:
aValue - float

setValue

public void setValue(int aValue)
Sets the value attribute to the corresponding Integer making the conversion from int.
Parameters:
aValue - int

setValue

public void setValue(long aValue)
Sets the value attribute to the corresponding Long making the conversion from long.
Parameters:
aValue - long

setValue

public void setValue(java.lang.Object aValue)
Sets the value property (java.lang.Object) value.
Overrides:
setValue in class DataElement
Parameters:
value - The new value for the property.
See Also:
getValue()

setValue

public void setValue(boolean aValue)
Set the value attribute to the corresponding Boolean making the conversion from boolean.
Parameters:
aValue - boolean

toString

public java.lang.String toString()
Returns a visual representation of the DataField.
Overrides:
toString in class java.lang.Object
Returns:
java.lang.String

validate

public java.lang.Object validate(java.lang.Object toValidate)
                          throws DSETypeException
Validates an object using its property descriptor
Overrides:
validate in class DataElement
Returns:
java.lang.Object
Throws:
DSETypeException - If the object has not been successfully validated

validateState

protected void validateState(java.lang.Object toValidate)
                      throws DSETypeException
Validates an object using the state attribute.
Parameters:
toValidate - java.lang.Object
Throws:
DSETypeException -  

writeExternal

public void writeExternal(java.io.ObjectOutput s)
                   throws java.io.IOException
Provides concrete serialization handling for DataField.
Overrides:
writeExternal in class DataElement
Parameters:
s - java.io.ObjectOutput
Throws:
java.io.IOException. -