IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class DataCollection

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

public abstract class DataCollection
extends DataElement

The DataCollection class is the abstract parent class for all types of collections.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.btt.base.DataElement
description, externalizer, name, parameters, state
 
Constructor Summary
DataCollection()
           
 
Method Summary
abstract  java.util.Enumeration getEnumeration()
          Returns the elements of the class as an Enumeration.
 java.lang.Object getValueAt(java.lang.String aCompositeKey)
          Returns the value of an element located in the path aCompositeKey.
 Vector nestedElements()
          Returns all the DataElements included in this collection at any level.
 void nestedElements(java.util.Hashtable theTable)
          Returns 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()
          Returns all the KeyedCollections at any level included in this 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 setValue(java.lang.Object aValue)
          Throws an exception.
 void setValueAt(java.lang.String aName, java.lang.Object aValue)
          Sets the value of an element located in the aCompositeKey path.
 java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType)
          Validates an object using its property descriptor and returns the validated object.
 
Methods inherited from class com.ibm.btt.base.DataElement
clone, externalizer, getCompositeKey, getDescription, getDescriptor, getElementAt, getErrorInfo, getExternalizer, getKey, getName, getParameter, getParameters, getState, getTagName, getValue, isAmended, isCached, isSerializable, readExternal, readExternal, readObject, removeElementAt, removeExternal, setAmended, setCompositeKey, setDescription, setDescriptor, setErrorInfo, setExternalizer, setIsCached, setName, setParameter, setParameters, setSerializable, setState, toStrings, toTags, tryGetElementAt, validate, validateObject, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.btt.base.Externalizable
initializeFrom
 

Constructor Detail

DataCollection

public DataCollection()
Method Detail

getEnumeration

public abstract java.util.Enumeration getEnumeration()
Returns the elements of the class as an Enumeration.

Returns:
java.util.Enumeration

getValueAt

public java.lang.Object getValueAt(java.lang.String aCompositeKey)
                            throws DSEObjectNotFoundException
Returns the value of an element located in the path aCompositeKey.

Parameters:
aCompositeKey - java.lang.String
Returns:
java.lang.Object
Throws:
DSEObjectNotFoundException

nestedElements

public Vector nestedElements()
Returns all the DataElements included in this collection at any level.

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 all the DataFields at any level included in this collection.

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

nestedKeyedCollections

public Vector nestedKeyedCollections()
Returns all the KeyedCollections at any level included in this collection.

Returns:
com.ibm.btt.base.Vector

nestedQualifiedElements

public 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. Each entry has, as a key, the qualified name of the DataElement and, as a value, the DataElement object.

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

setValue

public void setValue(java.lang.Object aValue)
              throws DSEInvalidArgumentException
Throws an exception. This method is implemented in order to maintain polymorphism.

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

setValueAt

public void setValueAt(java.lang.String aName,
                       java.lang.Object aValue)
                throws DSEInvalidArgumentException,
                       DSEObjectNotFoundException
Sets the value of an element located in the aCompositeKey path.

Throws:
DSEInvalidArgumentException
DSEObjectNotFoundException

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. If the validation fails, this method throws an appropriate exception.

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

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010