IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class DataField

java.lang.Object
  extended by com.ibm.btt.base.DataElement
      extended by com.ibm.btt.base.DataField
All Implemented Interfaces:
DSECloneable, TypedData, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
BeanDataField, BooleanDataField, ByteDataField, CharDataField, DoubleDataField, FloatDataField, IndexDataField, IntDataField, ListDataField, LongDataField, MapDataField, OperField, ShortDataField, TraceRequesterField

@ATTR(value="value#String#IMPLIED")
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.btt.base.DataElement
description, direction, externalizer, name, parameters, state
 
Constructor Summary
DataField()
          This constructor creates the DataField object.
DataField(java.lang.String aName)
          This constructor creates the DataField object with the aName id.
 
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 setValidValue(short aValue)
          Set the value attribute to the corresponding Short making the conversion from short.
 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.
 void setValue(short aValue)
          Set the value attribute to the corresponding Short making the conversion from short.
 java.lang.String toString()
          Returns a visual representation of the DataField.
 java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType)
          Validates an object using its property descriptor and returns the validated object.
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.btt.base.DataElement
externalizer, getCompositeKey, getDescription, getDescriptor, getDirection, getElementAt, getErrorInfo, getExternalizer, getKey, getName, getParameter, getParameters, getState, getTagName, isAmended, isCached, isSerializable, readExternal, readObject, removeElementAt, removeExternal, setAmended, setCompositeKey, setDescription, setDescriptor, setDirection, setErrorInfo, setExternalizer, setIsCached, setName, setParameter, setParameters, setSerializable, setState, toStrings, toTags, tryGetElementAt, validate, validateObject, 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 aName id.

Parameters:
aName - java.lang.String
Throws:
java.io.IOException
Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a new DataField cloned from the current one.

Specified by:
clone in interface DSECloneable
Overrides:
clone in class DataElement
Returns:
java.lang.Object
Throws:
java.lang.CloneNotSupportedException - - if a problem occurs trying to clone the object

getValue

public java.lang.Object getValue()
Gets the value property (java.lang.Object) value.

Specified by:
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 - The intialized DataField
Throws:
java.io.IOException

nestedElements

public Vector nestedElements()
Returns an empty Vector.

Specified by:
nestedElements in class DataElement
Returns:
com.ibm.btt.base.Vector

nestedElements

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

Specified by:
nestedElements in class DataElement

nestedFields

public Vector nestedFields()
Returns a Vector containing itself.

Specified by:
nestedFields in class DataElement
Returns:
com.ibm.btt.base.Vector

readExternal

public void readExternal(java.io.ObjectInput s)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Invokes the object creation from an ObjectInput.

Specified by:
readExternal in interface java.io.Externalizable
Overrides:
readExternal in class DataElement
Parameters:
s - java.io.ObjectInput
Throws:
java.io.IOException.
java.lang.ClassNotFoundException.
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
Throws:
DSETypeException

setValidValue

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

Parameters:
aValue - char
Throws:
DSETypeException

setValidValue

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

Parameters:
aValue - double
Throws:
DSETypeException

setValidValue

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

Parameters:
aValue - float
Throws:
DSETypeException

setValidValue

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

Parameters:
aValue - int
Throws:
DSETypeException

setValidValue

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

Parameters:
aValue - long
Throws:
DSETypeException

setValidValue

public void setValidValue(java.lang.Object aValue)
                   throws DSETypeException
Sets the value property (java.lang.Object) value.

Throws:
DSETypeException

setValidValue

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

Parameters:
aValue - boolean
Throws:
DSETypeException

setValidValue

public void setValidValue(short aValue)
                   throws DSETypeException
Set the value attribute to the corresponding Short making the conversion from short.

Parameters:
aValue - short
Throws:
DSETypeException

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)
              throws DSEInvalidArgumentException
Sets the value property (java.lang.Object) value.

Specified by:
setValue in class DataElement
Parameters:
aValue - java.lang.Object
Throws:
DSEInvalidArgumentException

setValue

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

Parameters:
aValue - boolean

setValue

public void setValue(short aValue)
Set the value attribute to the corresponding Short making the conversion from short.

Parameters:
aValue - short

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,
                                 java.lang.String convType)
                          throws DSETypeException
Validates an object using its property descriptor and returns the validated object.

Specified by:
validate in class DataElement
Parameters:
toValidate - java.lang.Object
convType - String
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.

Specified by:
writeExternal in interface java.io.Externalizable
Overrides:
writeExternal in class DataElement
Parameters:
s - java.io.ObjectOutput
Throws:
java.io.IOException.
java.io.IOException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011