IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class LazyKeyedCollection

java.lang.Object
  extended by com.ibm.btt.base.DataElement
      extended by com.ibm.btt.base.DataCollection
          extended by com.ibm.btt.base.KeyedCollection
              extended by com.ibm.btt.base.LazyKeyedCollection
All Implemented Interfaces:
DSECloneable, TypedData, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class LazyKeyedCollection
extends KeyedCollection

See Also:
Serialized Form

Field Summary
(package private)  KeyedCollection kCollInstance
           
(package private)  LazyRefDataTag refDataTag
           
(package private)  KeyedCollection tempKCollInstance
           
 
Fields inherited from class com.ibm.btt.base.KeyedCollection
bufferSize, DEFAULT_BUFFER_SIZE, DEFAULT_COMPRESSION, elements, nestedElements, nextItem, order
 
Fields inherited from class com.ibm.btt.base.DataElement
description, direction, externalizer, name, parameters, state
 
Constructor Summary
LazyKeyedCollection()
           
 
Method Summary
 void addElement(DataElement aDataElement)
          Add an entry to the hashtable of elements using as key the dataElement name.
 void addElement(java.lang.String aName, java.lang.Object aValue, java.lang.String aPath, java.lang.String aType)
          Adds a data element (instance of aType) to the KeyedCollection when the dynamic behavior is active.
 Hashtable calculeNestedElements()
          Gets the nested elements property (java.util.Hashtable) value.
 Hashtable calculeNestedQualifiedElements()
          Returns a Hashtable with the elements present at any level of this KeyedCollection.
 java.lang.Object clone()
          Returns a new KeyedCollection cloned from the current one
 java.lang.String getDescription()
          Returns the description of the data.
 PropertyDescription getDescriptor()
          Returns the PropertyDescriptor for this business object.
 java.lang.String getDirection()
          Returns the Direction property, initialize it if not defined
 java.lang.String getDynamic()
          Gets the dynamic property (String) value.
 DataElement getElementAt(int index)
          Returns the value of the element located at the index position.
 DataElement getElementAt(java.lang.String aName)
          Returns the data element identified by its name.
 DataElement getElementAtAnyLevel(java.lang.String aName)
          Returns the first element that matches aName at any level of depth of the keyedCollection.
protected  DataElement getElementAtFirstLevel(java.lang.String aName)
          Returns the element that matches aName.
 Hashtable getElements()
          Gets the elements property (java.util.Hashtable) value.
 java.util.Enumeration getEnumeration()
          Returns the elements of the keyedCollection as an Enumeration.
 int getIndexOf(int from, java.lang.String aName)
          Returns the position of the element aName.
 int getIndexOf(java.lang.String aName)
          Returns the position of the element aName.
 Key getKey()
          Returns a Key object which can be used to identify this business object.
 Hashtable getNestedElements()
          Gets the nested elements property (java.util.Hashtable) value.
 Hashtable getOrder()
          Gets the order property (java.util.Hashtable) value.
 java.util.Vector getOrderVector()
          Gets the order property (java.util.Vector) value.
 java.lang.Object getParameter(java.lang.String parameterName)
          Returns the value of the element in the hashtable of parameters.
 Hashtable getParameters()
          Returns the Hashtable of parameters for this business object.
 LazyRefDataTag getRefDataTag()
           
 ElementState getState()
          Gets the state property.
 KeyedCollection getTempKCollInstance()
           
 java.lang.Object getValue()
          Returns the elements of the keyedCollections.
 java.lang.Object getValueAt(java.lang.String aCompositeKey)
          Returns the value of an element located in the path aCompositeKey.
 java.lang.Object initializeFrom(Tag aTag)
          Initialize a keyedCollection from its tag in XML.
protected  void instanceLazyObject()
           
protected  void instanceTemplateObject()
           
 boolean isAmended()
          Returns true if the amended flag is activated and false otherwise.
 boolean isCompressable()
           
 boolean isDynamic()
          Returns the boolean value of the dynamic property.
 void nestedElements(java.util.Hashtable theTable)
          Parse all the DataElements included in this collection at any level.
 Vector nestedFields()
          Returns all the DataFields at any level included in this collection.
 Vector nestedKeyedCollections()
          This method parse the current collection, return all keycollections which are first level childs of current collection, and also return all DataElements of any level in the keycollections which are first level childs of current collection,
 void nestedQualifiedElements(java.util.Hashtable theTable, java.lang.String Path)
          Adds, using their qualified names, all elements of this DataCollection to the Hashtable passed by parameter.
 void readFromStream(java.io.ObjectInput s)
          Invokes the object creation from an ObjectInput.
 void removeAll()
          Removes all elements of the keyedCollection.
 DataElement removeElementAt(int index)
          Removes the element at the index indicated by the index parameter.
 DataElement removeElementAt(java.lang.String aName)
          Removes the named data element.
protected  DataElement removeElementAtFirstLevel(java.lang.String aName)
          Removes the element identified by aName.
protected  void reorderElements(int from)
          Reorders all the elements from the index indicated by the from parameter to the last element.
 void setAmended(boolean aValue)
          Sets the amended flag to aValue.
 void setCompressable(boolean compress)
          set compress flag
 void setDescription(java.lang.String aDescription)
          Sets the value of description.
 void setDescriptor(PropertyDescription descriptor)
          Sets the PropertyDescriptor for this business object to that passed.
 void setDirection(java.lang.String dir)
          Set a new value for Direction property
 void setDynamic(boolean aValue)
          Sets the dynamic property value.
 void setDynamic(java.lang.String aValue)
          Sets the dynamic property (java.lang.String) value.
 void setElements(Hashtable anElements)
          Sets the elements property (java.util.Hashtable) value.
 void setErrorInfo(ErrorInfo anErrorInfo)
          Sets the errorInfo attribute.
 void setName(java.lang.String aName)
          Sets the name property (java.lang.String) value.
 void setOrder(Hashtable anOrder)
          Sets the order property (java.util.Vector) value from a Hashtable.
 void setOrder(java.util.Vector anOrder)
          Sets the order property (java.util.Hashtable) value.
 void setParameter(java.lang.String parameterName, java.lang.Object parameterValue)
          Sets the value of the element in the Hashtable of paramaters.
 void setParameters(Hashtable theParameters)
          Sets the Hashtable of paramaters for this business object.
 void setRefDataTag(LazyRefDataTag refDataTag)
           
 void setState(ElementState aState)
          Sets the state property.
 void setValue(java.lang.Object aValue)
          Sets the value to the KeyedCollection from a Hashtable.
 void setValueAt(java.lang.String aName, java.lang.Object aValue)
          This method calls the addElement method to create the DataElement aName with the value aValue.
 void setValueAt(java.lang.String aName, java.lang.Object aValue, java.lang.String aType)
          Calls the addElement() method to create the aName DataElement (instance of aType) with its value set to aValue.
 int size()
          Returns the number of elements in the keyedCollection.
 java.lang.String toString()
          Returns a visual representation of the keyedCollection.
 Vector toStrings()
          Returns a visual representation of the keyedCollection.
 DataElement tryGetElementAt(java.lang.String aName)
          Returns the data element identified by its name.
 DataElement tryGetElementAtAnyLevel(java.lang.String aName)
          Returns the first element that matches aName at any level of depth of the keyedCollection.
protected  DataElement tryGetElementAtFirstLevel(java.lang.String aName)
          Returns the element that matches aName.
 java.lang.Object tryGetValueAt(java.lang.String aCompositeKey)
          Returns the value of an element located in the path aCompositeKey.
 int trySetValueAt(java.lang.String aName, java.lang.Object aValue)
          This method call the addElement method to create the DataElement aName with the value aValue.
 java.lang.Object validate(java.lang.Object toValidate)
          Validates the object using its property descriptor.
 java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType)
          Validates an object using its property descriptor and returns the validated object.
 java.lang.Object validateObject(java.lang.Object toValidate)
          Validates an object using its validator directly without conversion.
 void writeToStream(java.io.ObjectOutput s)
          Provides concrete serialization handling for KeyedCollection.
 
Methods inherited from class com.ibm.btt.base.KeyedCollection
readExternal, stringValueOf, writeExternal
 
Methods inherited from class com.ibm.btt.base.DataCollection
nestedElements
 
Methods inherited from class com.ibm.btt.base.DataElement
externalizer, getCompositeKey, getErrorInfo, getExternalizer, getName, getTagName, isCached, isSerializable, readExternal, readObject, removeExternal, setCompositeKey, setExternalizer, setIsCached, setSerializable, toTags, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

refDataTag

LazyRefDataTag refDataTag

kCollInstance

KeyedCollection kCollInstance

tempKCollInstance

KeyedCollection tempKCollInstance
Constructor Detail

LazyKeyedCollection

public LazyKeyedCollection()
Method Detail

getRefDataTag

public LazyRefDataTag getRefDataTag()

setRefDataTag

public void setRefDataTag(LazyRefDataTag refDataTag)

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException
Description copied from class: KeyedCollection
Initialize a keyedCollection from its tag in XML.

Overrides:
initializeFrom in class KeyedCollection
Parameters:
aTag - Tag
Returns:
java.lang.Object
Throws:
java.io.IOException

instanceTemplateObject

protected void instanceTemplateObject()

getTempKCollInstance

public KeyedCollection getTempKCollInstance()

instanceLazyObject

protected void instanceLazyObject()

addElement

public void addElement(DataElement aDataElement)
Description copied from class: KeyedCollection
Add an entry to the hashtable of elements using as key the dataElement name.

Overrides:
addElement in class KeyedCollection
Parameters:
aDataElement - DataElement

addElement

public void addElement(java.lang.String aName,
                       java.lang.Object aValue,
                       java.lang.String aPath,
                       java.lang.String aType)
                throws DSEInvalidArgumentException,
                       java.lang.ClassNotFoundException,
                       java.lang.InstantiationException,
                       java.lang.IllegalAccessException
Description copied from class: KeyedCollection
Adds a data element (instance of aType) to the KeyedCollection when the dynamic behavior is active. This method adds the element to the position pointed to by the aPath parameter with its initial value set to aValue.

Overrides:
addElement in class KeyedCollection
Parameters:
aName - java.lang.String. - The Name of the DataElement
aValue - Object. - The Value of the DataElement
aPath - java.lang.String. - The Path to the DataElement
aType - java.lang.String - The Type of the DataElement
Throws:
DSEInvalidArgumentException
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException

calculeNestedElements

public Hashtable calculeNestedElements()
Description copied from class: KeyedCollection
Gets the nested elements property (java.util.Hashtable) value.

Overrides:
calculeNestedElements in class KeyedCollection
Returns:
- The nestedElements property value

calculeNestedQualifiedElements

public Hashtable calculeNestedQualifiedElements()
Description copied from class: KeyedCollection
Returns a Hashtable with the elements present at any level of this KeyedCollection. Each entry has as key the qualified name of the DataElement and as value the DataElement object.

Overrides:
calculeNestedQualifiedElements in class KeyedCollection
Returns:
Hashtable

clone

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

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

getDynamic

public java.lang.String getDynamic()
Description copied from class: KeyedCollection
Gets the dynamic property (String) value.

Overrides:
getDynamic in class KeyedCollection
Returns:
The dynamic property value as String
See Also:
KeyedCollection.setDynamic(java.lang.String)

getElementAt

public DataElement getElementAt(int index)
                         throws DSEObjectNotFoundException
Description copied from class: KeyedCollection
Returns the value of the element located at the index position.

Overrides:
getElementAt in class KeyedCollection
Parameters:
index - int
Returns:
com.ibm.btt.base.DataElement
Throws:
DSEObjectNotFoundException

getElementAtAnyLevel

public DataElement getElementAtAnyLevel(java.lang.String aName)
                                 throws DSEObjectNotFoundException
Description copied from class: KeyedCollection
Returns the first element that matches aName at any level of depth of the keyedCollection.

Overrides:
getElementAtAnyLevel in class KeyedCollection
Parameters:
aName - java.lang.String - The name of the data element to be retrieved
Returns:
com.ibm.btt.base.DataElement
Throws:
DSEObjectNotFoundException

getElementAtFirstLevel

protected DataElement getElementAtFirstLevel(java.lang.String aName)
                                      throws DSEObjectNotFoundException
Description copied from class: KeyedCollection
Returns the element that matches aName. This method only searches in this first level and not in other levels.

Overrides:
getElementAtFirstLevel in class KeyedCollection
Parameters:
aName - java.lang.String
Returns:
DataElement
Throws:
DSEObjectNotFoundException

getElements

public Hashtable getElements()
Description copied from class: KeyedCollection
Gets the elements property (java.util.Hashtable) value.

Overrides:
getElements in class KeyedCollection
Returns:
The elements property value
See Also:
KeyedCollection.setElements(com.ibm.btt.base.Hashtable)

getEnumeration

public java.util.Enumeration getEnumeration()
Description copied from class: KeyedCollection
Returns the elements of the keyedCollection as an Enumeration.

Overrides:
getEnumeration in class KeyedCollection
Returns:
java.util.Enumeration

getIndexOf

public int getIndexOf(int from,
                      java.lang.String aName)
Description copied from class: KeyedCollection
Returns the position of the element aName. The search begins at the position indicated by the from parameter.

Overrides:
getIndexOf in class KeyedCollection
Returns:
int param from int - The position from which to start the search for the data element param aName String - The name of the data element to be retrieved

getIndexOf

public int getIndexOf(java.lang.String aName)
Description copied from class: KeyedCollection
Returns the position of the element aName.

Overrides:
getIndexOf in class KeyedCollection
Returns:
int

getNestedElements

public Hashtable getNestedElements()
Description copied from class: KeyedCollection
Gets the nested elements property (java.util.Hashtable) value.

Overrides:
getNestedElements in class KeyedCollection
Returns:
java.util.Hashtable - The nestedElements property value

getOrder

public Hashtable getOrder()
Description copied from class: KeyedCollection
Gets the order property (java.util.Hashtable) value.

Overrides:
getOrder in class KeyedCollection
Returns:
java.util.Hashtable - The order property value
See Also:
KeyedCollection.setOrder(com.ibm.btt.base.Hashtable)

getOrderVector

public java.util.Vector getOrderVector()
Description copied from class: KeyedCollection
Gets the order property (java.util.Vector) value.

Overrides:
getOrderVector in class KeyedCollection
Returns:
java.util.Vector - The order property value
See Also:
KeyedCollection.setOrder(com.ibm.btt.base.Hashtable)

getValue

public java.lang.Object getValue()
Description copied from class: KeyedCollection
Returns the elements of the keyedCollections. This method is implemented to provide polymorphism.

Overrides:
getValue in class KeyedCollection
Returns:
java.lang.Object

isDynamic

public boolean isDynamic()
Description copied from class: KeyedCollection
Returns the boolean value of the dynamic property.

Overrides:
isDynamic in class KeyedCollection
Returns:
boolean

readFromStream

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

Overrides:
readFromStream in class KeyedCollection
Parameters:
s - java.io.ObjectInput
Throws:
java.io.IOException
java.lang.ClassNotFoundException

removeAll

public void removeAll()
Description copied from class: KeyedCollection
Removes all elements of the keyedCollection.

Overrides:
removeAll in class KeyedCollection

removeElementAt

public DataElement removeElementAt(int index)
                            throws DSEObjectNotFoundException
Description copied from class: KeyedCollection
Removes the element at the index indicated by the index parameter.

Overrides:
removeElementAt in class KeyedCollection
Parameters:
index - int
Returns:
com.ibm.btt.base.DataElement
Throws:
DSEObjectNotFoundException

removeElementAt

public DataElement removeElementAt(java.lang.String aName)
                            throws DSEObjectNotFoundException
Description copied from class: KeyedCollection
Removes the named data element. It is found by the path indicated in the aName parameter. The paths are set by identifier strings separated by a period (.). For security reasons the asterisk (*) is not allowed in the path aName.

Overrides:
removeElementAt in class KeyedCollection
Parameters:
aName - java.lang.String
Returns:
DataElement
Throws:
DSEObjectNotFoundException

removeElementAtFirstLevel

protected DataElement removeElementAtFirstLevel(java.lang.String aName)
                                         throws DSEObjectNotFoundException
Description copied from class: KeyedCollection
Removes the element identified by aName.

Overrides:
removeElementAtFirstLevel in class KeyedCollection
Parameters:
aName - java.lang.String
Returns:
DataElement
Throws:
DSEObjectNotFoundException

reorderElements

protected void reorderElements(int from)
Description copied from class: KeyedCollection
Reorders all the elements from the index indicated by the from parameter to the last element.

Overrides:
reorderElements in class KeyedCollection
Parameters:
from - int

setDynamic

public void setDynamic(java.lang.String aValue)
Description copied from class: KeyedCollection
Sets the dynamic property (java.lang.String) value.

Overrides:
setDynamic in class KeyedCollection

setDynamic

public void setDynamic(boolean aValue)
Description copied from class: KeyedCollection
Sets the dynamic property value.

Overrides:
setDynamic in class KeyedCollection

setElements

public void setElements(Hashtable anElements)
Description copied from class: KeyedCollection
Sets the elements property (java.util.Hashtable) value.

Overrides:
setElements in class KeyedCollection

setOrder

public void setOrder(Hashtable anOrder)
Description copied from class: KeyedCollection
Sets the order property (java.util.Vector) value from a Hashtable.

Overrides:
setOrder in class KeyedCollection

setOrder

public void setOrder(java.util.Vector anOrder)
Description copied from class: KeyedCollection
Sets the order property (java.util.Hashtable) value.

Overrides:
setOrder in class KeyedCollection
Parameters:
anOrder - - The new value for the property
See Also:
KeyedCollection.getOrder()

setValue

public void setValue(java.lang.Object aValue)
              throws DSEInvalidArgumentException
Description copied from class: KeyedCollection
Sets the value to the KeyedCollection from a Hashtable. This method first initializes the KeyedCollection and then, with the value of the parameter, gives a new value to the KeyedCollection. The nextItem, elements, netedElements and order attributes are modified.

Overrides:
setValue in class KeyedCollection
Parameters:
aValue - java.lang.Object - Must be a Hastable. The keys are Strings that represent the names of the dataelement and the values of this keys are the DataElements Objects.
Throws:
DSEInvalidArgumentException - - The parameter is not a Hashtable Object

setValueAt

public void setValueAt(java.lang.String aName,
                       java.lang.Object aValue)
                throws DSEInvalidArgumentException,
                       DSEObjectNotFoundException
Description copied from class: KeyedCollection
This method calls the addElement method to create the DataElement aName with the value aValue.

Overrides:
setValueAt in class KeyedCollection
Throws:
DSEInvalidArgumentException
DSEObjectNotFoundException

setValueAt

public void setValueAt(java.lang.String aName,
                       java.lang.Object aValue,
                       java.lang.String aType)
                throws DSEInvalidArgumentException,
                       DSEObjectNotFoundException
Description copied from class: KeyedCollection
Calls the addElement() method to create the aName DataElement (instance of aType) with its value set to aValue.

Overrides:
setValueAt in class KeyedCollection
Throws:
DSEInvalidArgumentException
DSEObjectNotFoundException

size

public int size()
Description copied from class: KeyedCollection
Returns the number of elements in the keyedCollection.

Overrides:
size in class KeyedCollection
Returns:
int

toStrings

public Vector toStrings()
Description copied from class: KeyedCollection
Returns a visual representation of the keyedCollection.

Overrides:
toStrings in class KeyedCollection
Returns:
Vector

toString

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

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

tryGetElementAt

public DataElement tryGetElementAt(java.lang.String aName)
Description copied from class: KeyedCollection
Returns the data element identified by its name. It is found by the path indicated in the aName parameter. The path is set by identifier strings separated by a period (.). An asterisk (*) specifies a search in any level of depth in this keyed collection.

Overrides:
tryGetElementAt in class KeyedCollection
Parameters:
aName - java.lang.String - The path and name of the data element to be retrieved
Returns:
DataElement

tryGetElementAtAnyLevel

public DataElement tryGetElementAtAnyLevel(java.lang.String aName)
Description copied from class: KeyedCollection
Returns the first element that matches aName at any level of depth of the keyedCollection.

Overrides:
tryGetElementAtAnyLevel in class KeyedCollection
Parameters:
aName - java.lang.String - The name of the data element to be retrieved
Returns:
com.ibm.btt.base.DataElement

tryGetElementAtFirstLevel

protected DataElement tryGetElementAtFirstLevel(java.lang.String aName)
Description copied from class: KeyedCollection
Returns the element that matches aName. This method only searches in this first level and not in other levels.

Overrides:
tryGetElementAtFirstLevel in class KeyedCollection
Parameters:
aName - java.lang.String
Returns:
DataElement

tryGetValueAt

public java.lang.Object tryGetValueAt(java.lang.String aCompositeKey)
Description copied from class: KeyedCollection
Returns the value of an element located in the path aCompositeKey. Returns null if the element is not found or if it is found but has a null value.

Overrides:
tryGetValueAt in class KeyedCollection
Parameters:
aCompositeKey - java.lang.String
Returns:
java.lang.Object

trySetValueAt

public int trySetValueAt(java.lang.String aName,
                         java.lang.Object aValue)
                  throws DSEInvalidArgumentException
Description copied from class: KeyedCollection
This method call the addElement method to create the DataElement aName with the value aValue.

Overrides:
trySetValueAt in class KeyedCollection
Returns:
int, 0:success; -1:DSEObjectNotFoundException
Throws:
DSEInvalidArgumentException

writeToStream

public void writeToStream(java.io.ObjectOutput s)
                   throws java.io.IOException
Description copied from class: KeyedCollection
Provides concrete serialization handling for KeyedCollection. This method serializes the current KeyedCollection.

Overrides:
writeToStream in class KeyedCollection
Parameters:
s - java.io.ObjectOutput
Throws:
java.io.IOException

isCompressable

public boolean isCompressable()
Overrides:
isCompressable in class KeyedCollection
Returns:
compress flag

setCompressable

public void setCompressable(boolean compress)
Description copied from class: KeyedCollection
set compress flag

Overrides:
setCompressable in class KeyedCollection

getValueAt

public java.lang.Object getValueAt(java.lang.String aCompositeKey)
                            throws DSEObjectNotFoundException
Description copied from class: DataCollection
Returns the value of an element located in the path aCompositeKey.

Overrides:
getValueAt in class DataCollection
Parameters:
aCompositeKey - java.lang.String
Returns:
java.lang.Object
Throws:
DSEObjectNotFoundException

nestedElements

public void nestedElements(java.util.Hashtable theTable)
Description copied from class: DataCollection
Parse all the DataElements included in this collection at any level.

Overrides:
nestedElements in class DataCollection

nestedFields

public Vector nestedFields()
Description copied from class: DataCollection
Returns all the DataFields at any level included in this collection.

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

nestedKeyedCollections

public Vector nestedKeyedCollections()
Description copied from class: DataCollection
This method parse the current collection, return all keycollections which are first level childs of current collection, and also return all DataElements of any level in the keycollections which are first level childs of current collection,

Overrides:
nestedKeyedCollections in class DataCollection
Returns:
com.ibm.btt.base.Vector

nestedQualifiedElements

public void nestedQualifiedElements(java.util.Hashtable theTable,
                                    java.lang.String Path)
Description copied from class: DataCollection
Adds, using their qualified names, all elements of this DataCollection to the Hashtable passed by parameter. Each entry has, as a key, the qualified name of the DataElement and, as a value, the DataElement object.

Overrides:
nestedQualifiedElements in class DataCollection
Parameters:
theTable - java.util.Hashtable
Path - String - The path where the DataCollection is

validate

public java.lang.Object validate(java.lang.Object toValidate,
                                 java.lang.String convType)
                          throws DSETypeException
Description copied from class: DataCollection
Validates an object using its property descriptor and returns the validated object. If the validation fails, this method throws an appropriate exception.

Overrides:
validate in class DataCollection
Parameters:
toValidate - Object
convType - String
Returns:
java.lang.Object
Throws:
DSETypeException - - Thrown if the validation is unsuccessful

getDescription

public java.lang.String getDescription()
Description copied from class: DataElement
Returns the description of the data.

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

getDescriptor

public PropertyDescription getDescriptor()
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

getDirection

public java.lang.String getDirection()
Description copied from class: DataElement
Returns the Direction property, initialize it if not defined

Overrides:
getDirection in class DataElement
Returns:

setDirection

public void setDirection(java.lang.String dir)
Description copied from class: DataElement
Set a new value for Direction property

Overrides:
setDirection in class DataElement

getElementAt

public DataElement getElementAt(java.lang.String aName)
                         throws DSEObjectNotFoundException
Description copied from class: KeyedCollection
Returns the data element identified by its name. It is found by the path indicated in the aName parameter. The path is set by identifier strings separated by a period (.). An asterisk (*) specifies a search in any level of depth in this keyed collection.

Overrides:
getElementAt in class KeyedCollection
Parameters:
aName - java.lang.String the path and name of the data element to be retrieved
Returns:
DataElement
Throws:
DSEObjectNotFoundException

getKey

public Key getKey()
           throws DSETypeException
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

getParameter

public java.lang.Object getParameter(java.lang.String parameterName)
Description copied from class: DataElement
Returns the value of the element in the hashtable of parameters.

Overrides:
getParameter in class DataElement
Parameters:
parameterName - String
Returns:
Object - The element value

getParameters

public Hashtable getParameters()
Description copied from class: DataElement
Returns the Hashtable of parameters for this business object.

Overrides:
getParameters in class DataElement
Returns:
com.ibm.btt.base.Hashtable

getState

public ElementState getState()
Description copied from class: DataElement
Gets the state property.

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

isAmended

public boolean isAmended()
Description copied from class: DataElement
Returns true if the amended flag is activated and false otherwise.

Overrides:
isAmended in class DataElement
Returns:
boolean

setAmended

public void setAmended(boolean aValue)
Description copied from class: DataElement
Sets the amended flag to aValue.

Overrides:
setAmended in class DataElement
Parameters:
aValue - boolean

setDescription

public void setDescription(java.lang.String aDescription)
Description copied from class: DataElement
Sets the value of description.

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

setDescriptor

public void setDescriptor(PropertyDescription descriptor)
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

public void setErrorInfo(ErrorInfo anErrorInfo)
Description copied from class: DataElement
Sets the errorInfo attribute.

Overrides:
setErrorInfo in class DataElement

setName

public void setName(java.lang.String aName)
Description copied from class: DataElement
Sets the name property (java.lang.String) value.

Specified by:
setName in interface TypedData
Overrides:
setName in class DataElement
Parameters:
aName - java.lang.String

setParameter

public void setParameter(java.lang.String parameterName,
                         java.lang.Object parameterValue)
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

public void setParameters(Hashtable theParameters)
Description copied from class: DataElement
Sets the Hashtable of paramaters for this business object.

Overrides:
setParameters in class DataElement

setState

public void setState(ElementState aState)
Description copied from class: DataElement
Sets the state property.

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

validate

public java.lang.Object validate(java.lang.Object toValidate)
                          throws DSETypeException
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

public java.lang.Object validateObject(java.lang.Object toValidate)
                                throws DSETypeException
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

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011