IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.bean
Class BeanDataField

java.lang.Object
  extended by com.ibm.btt.base.DataElement
      extended by com.ibm.btt.base.DataField
          extended by com.ibm.btt.bean.BeanDataField
All Implemented Interfaces:
DSECloneable, TypedData, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class BeanDataField
extends DataField

The BeanDataField class is the basic unit of the bean collection. This class provides a protocol for accessing the bean's attribute by name, and for changing bean's attribute value .

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.btt.base.DataField
value
 
Fields inherited from class com.ibm.btt.base.DataElement
description, name, parameters, state
 
Constructor Summary
  BeanDataField()
          This constructor creates the BeanDataField object.
protected BeanDataField(java.lang.String attributeName, java.lang.Object parent)
           
protected BeanDataField(java.lang.String attributeName, java.lang.Object parent, java.lang.Object value)
           
 
Method Summary
 java.lang.Object clone()
          Returns a new DataField cloned from the current one.
 Externalizer externalizer()
          Deprecated. 
protected  java.lang.Object getBean()
           
protected  java.lang.Object getBeanValue()
           
 java.lang.String getCompositeKey()
          Deprecated. 
 java.lang.String getDescription()
          Deprecated. 
 PropertyDescription getDescriptor()
          Deprecated. 
 DataElement getElementAt(java.lang.String name)
          Deprecated. 
 ErrorInfo getErrorInfo()
          Deprecated. 
 Key getKey()
          Deprecated. 
 ElementState getState()
          Deprecated. 
 java.lang.Object getValue()
          Gets the value property (java.lang.Object) value.
 boolean isAmended()
          Deprecated. 
 boolean isCached()
          Deprecated. 
 boolean isSerializable()
          Deprecated. 
 Vector nestedElements()
          Deprecated. 
 void nestedElements(java.util.Hashtable theTable)
          Deprecated. 
 Vector nestedFields()
          Deprecated. 
 void readExternal(java.io.ObjectInput s)
          Invokes the object creation from an ObjectInput.
protected  void refreshBeanValue(java.lang.Object value)
           
 DataElement removeElementAt(java.lang.String name)
          Throws an exception.
 void setAmended(boolean value)
          This is an override method,not suggest to use,it do nothing
protected  void setBean(java.lang.Object parent)
           
 void setCompositeKey(java.lang.String compositeKey)
          Deprecated. 
 void setDescription(java.lang.String description)
          Deprecated. 
 void setDescriptor(PropertyDescription descriptor)
          Deprecated. 
 void setErrorInfo(ErrorInfo anErrorInfo)
          Deprecated. 
 void setIsCached(boolean cached)
          Deprecated. 
 void setParameter(java.lang.String parameterName, java.lang.Object parameterValue)
          Deprecated. 
 void setParameters(Hashtable theParameters)
          Deprecated. 
 void setState(ElementState state)
          Deprecated. 
 void setValidValue(boolean value)
          Set the value attribute to the corresponding Boolean making the conversion from boolean.
 void setValidValue(byte value)
          Sets the value attribute to the corresponding Byte making the conversion from byte.
 void setValidValue(char value)
          Sets the value attribute to the corresponding Character making the conversion from char.
 void setValidValue(double value)
          Sets the value attribute to the corresponding Double making the conversion from double.
 void setValidValue(float value)
          Sets the value attribute to the corresponding Float making the conversion from float.
 void setValidValue(int value)
          Sets the value attribute to the corresponding Integer making the conversion from int.
 void setValidValue(long value)
          Sets the value attribute to the corresponding Long making the conversion from long.
 void setValidValue(java.lang.Object value)
          Sets the value property (java.lang.Object) value.
 void setValue(boolean value)
          Set the value attribute to the corresponding Boolean making the conversion from boolean.
 void setValue(byte value)
          Sets the value attribute to the corresponding Byte making the conversion from byte.
 void setValue(char value)
          Sets the value attribute to the corresponding Character making the conversion from char.
 void setValue(double value)
          Sets the value attribute to the corresponding Double making the conversion from double.
 void setValue(float value)
          Sets the value attribute to the corresponding Float making the conversion from float.
 void setValue(int value)
          Sets the value attribute to the corresponding Integer making the conversion from int.
 void setValue(long value)
          Sets the value attribute to the corresponding Long making the conversion from long.
 void setValue(java.lang.Object value)
          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)
          Deprecated. 
 java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType)
          Deprecated. 
 java.lang.Object validateObject(java.lang.Object toValidate)
          Deprecated. 
protected  void validateState(java.lang.Object toValidate)
          Deprecated. 
 void writeExternal(java.io.ObjectOutput s)
          Provides concrete serialization handling for DataField.
 
Methods inherited from class com.ibm.btt.base.DataField
initializeFrom
 
Methods inherited from class com.ibm.btt.base.DataElement
getExternalizer, getName, getParameter, getParameters, getTagName, readExternal, readObject, removeExternal, setExternalizer, setName, setSerializable, toStrings, toTags, tryGetElementAt, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BeanDataField

public BeanDataField()
This constructor creates the BeanDataField object.


BeanDataField

protected BeanDataField(java.lang.String attributeName,
                        java.lang.Object parent)

BeanDataField

protected BeanDataField(java.lang.String attributeName,
                        java.lang.Object parent,
                        java.lang.Object value)
Method Detail

getValue

public java.lang.Object getValue()
Description copied from class: DataField
Gets the value property (java.lang.Object) value.

Overrides:
getValue in class DataField
Returns:
- The value property value
See Also:
DataField.setValue(byte)

getBean

protected java.lang.Object getBean()

setBean

protected void setBean(java.lang.Object parent)

getBeanValue

protected java.lang.Object getBeanValue()

refreshBeanValue

protected void refreshBeanValue(java.lang.Object value)

setValue

public void setValue(boolean value)
Description copied from class: DataField
Set the value attribute to the corresponding Boolean making the conversion from boolean.

Overrides:
setValue in class DataField
Parameters:
value - boolean

setValue

public void setValue(byte value)
Description copied from class: DataField
Sets the value attribute to the corresponding Byte making the conversion from byte.

Overrides:
setValue in class DataField
Parameters:
value - byte

setValue

public void setValue(char value)
Description copied from class: DataField
Sets the value attribute to the corresponding Character making the conversion from char.

Overrides:
setValue in class DataField
Parameters:
value - char

setValue

public void setValue(double value)
Description copied from class: DataField
Sets the value attribute to the corresponding Double making the conversion from double.

Overrides:
setValue in class DataField
Parameters:
value - double

setValue

public void setValue(float value)
Description copied from class: DataField
Sets the value attribute to the corresponding Float making the conversion from float.

Overrides:
setValue in class DataField
Parameters:
value - float

setValue

public void setValue(int value)
Description copied from class: DataField
Sets the value attribute to the corresponding Integer making the conversion from int.

Overrides:
setValue in class DataField
Parameters:
value - int

clone

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

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

nestedElements

@Deprecated
public Vector nestedElements()
Deprecated. 

Description copied from class: DataField
Returns an empty Vector.

Overrides:
nestedElements in class DataField
Returns:
com.ibm.btt.base.Vector

nestedElements

@Deprecated
public void nestedElements(java.util.Hashtable theTable)
Deprecated. 

Description copied from class: DataField
Returns all the DataElements included in this collection at any level.

Overrides:
nestedElements in class DataField

nestedFields

@Deprecated
public Vector nestedFields()
Deprecated. 

Description copied from class: DataField
Returns a Vector containing itself.

Overrides:
nestedFields in class DataField
Returns:
com.ibm.btt.base.Vector

setValidValue

public void setValidValue(boolean value)
                   throws DSETypeException
Description copied from class: DataField
Set the value attribute to the corresponding Boolean making the conversion from boolean.

Overrides:
setValidValue in class DataField
Parameters:
value - boolean
Throws:
DSETypeException

setValidValue

public void setValidValue(byte value)
                   throws DSETypeException
Description copied from class: DataField
Sets the value attribute to the corresponding Byte making the conversion from byte.

Overrides:
setValidValue in class DataField
Parameters:
value - byte
Throws:
DSETypeException

setValidValue

public void setValidValue(char value)
                   throws DSETypeException
Description copied from class: DataField
Sets the value attribute to the corresponding Character making the conversion from char.

Overrides:
setValidValue in class DataField
Parameters:
value - char
Throws:
DSETypeException

setValidValue

public void setValidValue(double value)
                   throws DSETypeException
Description copied from class: DataField
Sets the value attribute to the corresponding Double making the conversion from double.

Overrides:
setValidValue in class DataField
Parameters:
value - double
Throws:
DSETypeException

setValidValue

public void setValidValue(float value)
                   throws DSETypeException
Description copied from class: DataField
Sets the value attribute to the corresponding Float making the conversion from float.

Overrides:
setValidValue in class DataField
Parameters:
value - float
Throws:
DSETypeException

setValidValue

public void setValidValue(int value)
                   throws DSETypeException
Description copied from class: DataField
Sets the value attribute to the corresponding Integer making the conversion from int.

Overrides:
setValidValue in class DataField
Parameters:
value - int
Throws:
DSETypeException

setValidValue

public void setValidValue(long value)
                   throws DSETypeException
Description copied from class: DataField
Sets the value attribute to the corresponding Long making the conversion from long.

Overrides:
setValidValue in class DataField
Parameters:
value - long
Throws:
DSETypeException

setValidValue

public void setValidValue(java.lang.Object value)
                   throws DSETypeException
Description copied from class: DataField
Sets the value property (java.lang.Object) value.

Overrides:
setValidValue in class DataField
Throws:
DSETypeException

toString

public java.lang.String toString()
Description copied from class: DataField
Returns a visual representation of the DataField.

Overrides:
toString in class DataField
Returns:
java.lang.String

validate

@Deprecated
public java.lang.Object validate(java.lang.Object toValidate,
                                            java.lang.String convType)
                          throws DSETypeException
Deprecated. 

Description copied from class: DataField
Validates an object using its property descriptor and returns the validated object.

Overrides:
validate in class DataField
Parameters:
toValidate - java.lang.Object
convType - String
Returns:
java.lang.Object
Throws:
DSETypeException - - If the object has not been successfully validated

validateState

@Deprecated
protected void validateState(java.lang.Object toValidate)
                      throws DSETypeException
Deprecated. 

Description copied from class: DataField
Validates an object using the state attribute.

Overrides:
validateState in class DataField
Parameters:
toValidate - java.lang.Object
Throws:
DSETypeException

setValue

public void setValue(long value)
Description copied from class: DataField
Sets the value attribute to the corresponding Long making the conversion from long.

Overrides:
setValue in class DataField
Parameters:
value - long

setValue

public void setValue(java.lang.Object value)
              throws DSEInvalidArgumentException
Description copied from class: DataField
Sets the value property (java.lang.Object) value.

Overrides:
setValue in class DataField
Parameters:
value - java.lang.Object
Throws:
DSEInvalidArgumentException

externalizer

@Deprecated
public Externalizer externalizer()
                          throws java.io.IOException
Deprecated. 

Description copied from class: DataElement
Returns the externalizer instance of this class.

Overrides:
externalizer in class DataElement
Returns:
com.ibm.btt.base.Externalizer
Throws:
java.io.IOException

getCompositeKey

@Deprecated
public java.lang.String getCompositeKey()
Deprecated. 

Description copied from class: DataElement
Returns the compositeKey.

Overrides:
getCompositeKey in class DataElement
Returns:
String

getDescription

@Deprecated
public java.lang.String getDescription()
Deprecated. 

Description copied from class: DataElement
Returns the description of the data.

Overrides:
getDescription in class DataElement
Returns:
java.lang.String

getDescriptor

@Deprecated
public PropertyDescription getDescriptor()
Deprecated. 

Description copied from class: DataElement
Returns the PropertyDescriptor for this business object.

Specified by:
getDescriptor in interface TypedData
Overrides:
getDescriptor in class DataElement
Returns:
PropertyDescription

getElementAt

@Deprecated
public DataElement getElementAt(java.lang.String name)
                         throws DSEObjectNotFoundException
Deprecated. 

Description copied from class: DataElement
Throws an exception. Implemented in order to provide polymorphism.

Overrides:
getElementAt in class DataElement
Parameters:
name - java.lang.String
Throws:
DSEObjectNotFoundException

getErrorInfo

@Deprecated
public ErrorInfo getErrorInfo()
Deprecated. 

Description copied from class: DataElement
Returns the errorInfo property.

Overrides:
getErrorInfo in class DataElement
Returns:
com.ibm.btt.base.ErrorInfo

getKey

@Deprecated
public Key getKey()
           throws DSETypeException
Deprecated. 

Description copied from class: DataElement
Returns a Key object which can be used to identify this business object. For business objects which are not Typed, of simple Type, or simply do not support unique Keys, a Key with a value of zero is returned.

Specified by:
getKey in interface TypedData
Overrides:
getKey in class DataElement
Returns:
Key
Throws:
DSETypeException - - If the key can not be built from this business object

getState

@Deprecated
public ElementState getState()
Deprecated. 

Description copied from class: DataElement
Gets the state property.

Overrides:
getState in class DataElement
Returns:
com.ibm.btt.base.types.ElementState

isAmended

@Deprecated
public boolean isAmended()
Deprecated. 

Description copied from class: DataElement
Returns true if the amended flag is activated and false otherwise.

Overrides:
isAmended in class DataElement
Returns:
boolean

isCached

@Deprecated
public boolean isCached()
Deprecated. 

Description copied from class: DataElement
Returns the isCached.

Overrides:
isCached in class DataElement
Returns:
boolean

isSerializable

@Deprecated
public boolean isSerializable()
Deprecated. 

Overrides:
isSerializable in class DataElement
Returns:
true if this data element is serializable.

removeElementAt

public DataElement removeElementAt(java.lang.String name)
                            throws DSEObjectNotFoundException
Description copied from class: DataElement
Throws an exception. Implemented to provide polymorphism.

Overrides:
removeElementAt in class DataElement
Parameters:
name - java.lang.String
Returns:
com.ibm.btt.base.DataElement
Throws:
DSEObjectNotFoundException

setAmended

public void setAmended(boolean value)
This is an override method,not suggest to use,it do nothing

Overrides:
setAmended in class DataElement
Parameters:
value - boolean

setCompositeKey

@Deprecated
public void setCompositeKey(java.lang.String compositeKey)
Deprecated. 

Description copied from class: DataElement
Sets the compositeKey.

Overrides:
setCompositeKey in class DataElement

setDescription

@Deprecated
public void setDescription(java.lang.String description)
Deprecated. 

Description copied from class: DataElement
Sets the value of description.

Overrides:
setDescription in class DataElement
Parameters:
description - java.lang.String

setDescriptor

@Deprecated
public void setDescriptor(PropertyDescription descriptor)
Deprecated. 

Description copied from class: DataElement
Sets the PropertyDescriptor for this business object to that passed.

Specified by:
setDescriptor in interface TypedData
Overrides:
setDescriptor in class DataElement
Parameters:
descriptor - PropertyDescription

setErrorInfo

@Deprecated
public void setErrorInfo(ErrorInfo anErrorInfo)
Deprecated. 

Description copied from class: DataElement
Sets the errorInfo attribute.

Overrides:
setErrorInfo in class DataElement

setIsCached

@Deprecated
public void setIsCached(boolean cached)
Deprecated. 

Description copied from class: DataElement
Sets the isCached.

Overrides:
setIsCached in class DataElement

setParameter

@Deprecated
public void setParameter(java.lang.String parameterName,
                                    java.lang.Object parameterValue)
Deprecated. 

Description copied from class: DataElement
Sets the value of the element in the Hashtable of paramaters.

Overrides:
setParameter in class DataElement
Parameters:
parameterName - String
parameterValue - Object

setParameters

@Deprecated
public void setParameters(Hashtable theParameters)
Deprecated. 

Description copied from class: DataElement
Sets the Hashtable of paramaters for this business object.

Overrides:
setParameters in class DataElement

setState

@Deprecated
public void setState(ElementState state)
Deprecated. 

Description copied from class: DataElement
Sets the state property.

Overrides:
setState in class DataElement
Parameters:
state - com.ibm.btt.base.types.ElementState

validate

@Deprecated
public java.lang.Object validate(java.lang.Object toValidate)
                          throws DSETypeException
Deprecated. 

Description copied from class: DataElement
Validates the object using its property descriptor.

Overrides:
validate in class DataElement
Returns:
java.lang.Object
Throws:
DSETypeException - - If the object has not been successfully validated

validateObject

@Deprecated
public java.lang.Object validateObject(java.lang.Object toValidate)
                                throws DSETypeException
Deprecated. 

Description copied from class: DataElement
Validates an object using its validator directly without conversion. If validator is not defined, the object is returned.

Overrides:
validateObject in class DataElement
Returns:
java.lang.Object - The validated object
Throws:
DSETypeException - - If the object has not been successfully validated

readExternal

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

Specified by:
readExternal in interface java.io.Externalizable
Overrides:
readExternal in class DataField
Parameters:
s - java.io.ObjectInput
Throws:
java.io.IOException
java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput s)
                   throws java.io.IOException
Description copied from class: DataField
Provides concrete serialization handling for DataField.

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

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010