IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.bean
Class ArrayCollection

java.lang.Object
  extended by com.ibm.btt.base.DataElement
      extended by com.ibm.btt.base.DataCollection
          extended by com.ibm.btt.base.IndexedCollection
              extended by com.ibm.btt.bean.AbstractBeanIndexCollection
                  extended by com.ibm.btt.bean.ArrayCollection
All Implemented Interfaces:
DSECloneable, TypedData, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class ArrayCollection
extends AbstractBeanIndexCollection

Instances of this class contain a Object[] object and his parent bean This class provides a protocol for accessing the bean's attribute which type is Array by position, and for changing and removing array position's value

See Also:
Serialized Form

Nested Class Summary
(package private)  class ArrayCollection.MyEnumeration
           
 
Field Summary
 
Fields inherited from class com.ibm.btt.bean.AbstractBeanIndexCollection
subTag
 
Fields inherited from class com.ibm.btt.base.IndexedCollection
defaultName, elements
 
Fields inherited from class com.ibm.btt.base.DataElement
description, name, parameters, state
 
Constructor Summary
  ArrayCollection()
          This is the default constructor used to create an ArrayCollection object.
protected ArrayCollection(java.lang.Object[] obj, int key, java.lang.Object parent)
           
protected ArrayCollection(java.lang.Object[] obj, java.lang.Object parentBean)
           
 
Method Summary
 void addElement(DataElement dataElement)
          Deprecated. 
protected  DataElement createDataElement(java.lang.Object obj, java.lang.String name)
          Deprecated. 
 DataElement createElement(boolean shareDescriptor)
          Deprecated. 
 DataElement getDataElement()
          Gets the dataElement defined if the ArrayCollection size is zero.
 java.util.Enumeration getEnumeration()
          Returns the ArrayCollection's elements as an Enumeration.
 java.lang.Object getValue()
          Returns the Indexed Collection's elements.
 void nestedQualifiedElements(java.util.Hashtable theTable, java.lang.String Path)
          Deprecated. 
 void readExternal(java.io.ObjectInput s)
          Invokes the object creation from an ObjectInput.
 void setValue(java.lang.Object value)
          Validates the value to be set and if it succeeds then sets the value to the IndexedCollection from a Vector of DataElements.
 int size()
          Returns the length of array.
 DataElement tryGetElementAt(int anIdentifier)
          Returns the element located at the index anIdentifier.
 void writeExternal(java.io.ObjectOutput s)
          Provides concrete serialization handling for ArrayCollection.
 
Methods inherited from class com.ibm.btt.bean.AbstractBeanIndexCollection
addElement, createDataElement, createElementSharingDescriptors, generateDataElementName, getElementAt, initializeFrom, setDataElement, setElements
 
Methods inherited from class com.ibm.btt.base.IndexedCollection
clone, getElementAt, getElements, getElementSubTag, removeAll, removeElementAt, removeElementAt, setElementSubTag, toString, toStrings, toTags, tryGetElementAt, tryGetValueAt, trySetValueAt, validate
 
Methods inherited from class com.ibm.btt.base.DataCollection
getValueAt, nestedElements, nestedElements, nestedFields, nestedKeyedCollections, setValueAt, validate
 
Methods inherited from class com.ibm.btt.base.DataElement
externalizer, getCompositeKey, getDescription, getDescriptor, getErrorInfo, getExternalizer, getKey, getName, getParameter, getParameters, getState, getTagName, isAmended, isCached, isSerializable, readExternal, readObject, removeExternal, setAmended, setCompositeKey, setDescription, setDescriptor, setErrorInfo, setExternalizer, setIsCached, setName, setParameter, setParameters, setSerializable, setState, validateObject, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ArrayCollection

public ArrayCollection()
This is the default constructor used to create an ArrayCollection object.


ArrayCollection

protected ArrayCollection(java.lang.Object[] obj,
                          java.lang.Object parentBean)

ArrayCollection

protected ArrayCollection(java.lang.Object[] obj,
                          int key,
                          java.lang.Object parent)
Method Detail

size

public int size()
Returns the length of array.

Overrides:
size in class IndexedCollection
Returns:
int

addElement

@Deprecated
public void addElement(DataElement dataElement)
Deprecated. 

Description copied from class: IndexedCollection
Adds an element at the end of the collection.

Overrides:
addElement in class IndexedCollection
Parameters:
dataElement - - The element to be added

getDataElement

public DataElement getDataElement()
Gets the dataElement defined if the ArrayCollection size is zero.

Overrides:
getDataElement in class IndexedCollection
Returns:
com.ibm.btt.base.DataElement

createDataElement

@Deprecated
protected DataElement createDataElement(java.lang.Object obj,
                                                   java.lang.String name)
Deprecated. 

Specified by:
createDataElement in class AbstractBeanIndexCollection

createElement

@Deprecated
public DataElement createElement(boolean shareDescriptor)
                          throws DSEInvalidRequestException
Deprecated. 

Description copied from class: AbstractBeanIndexCollection
Returns a new DataElement .

Specified by:
createElement in class AbstractBeanIndexCollection
Parameters:
shareDescriptor - - True if the descriptors can be shared
Returns:
com.ibm.btt.base.DataElement - The new DataElement
Throws:
DSEInvalidRequestException

nestedQualifiedElements

@Deprecated
public void nestedQualifiedElements(java.util.Hashtable theTable,
                                               java.lang.String Path)
Deprecated. 

Description copied from class: IndexedCollection
Adds as qualified name all elements of this IndexedCollection to the Hashtable passed by parameter. Each entry has as a key the qualified name of the DataElement and as value the DataElement object.

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

getEnumeration

public java.util.Enumeration getEnumeration()
Returns the ArrayCollection's elements as an Enumeration.

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

tryGetElementAt

public DataElement tryGetElementAt(int anIdentifier)
Returns the element located at the index anIdentifier.

Overrides:
tryGetElementAt in class IndexedCollection

setValue

public void setValue(java.lang.Object value)
              throws DSEInvalidArgumentException
Description copied from class: IndexedCollection
Validates the value to be set and if it succeeds then sets the value to the IndexedCollection from a Vector of DataElements. The elements attribute will contain a cloned Vector from the Vector passed by parameter. The subTag attribute will contain a Tag Object constructed from "toString()" representation of first vector's element. The DataElement attribute will contain a new DataElement build from the subTag attribute.

Overrides:
setValue in class IndexedCollection
Parameters:
value - java.lang.Object - Must be a Vector of DataElements
Throws:
DSEInvalidArgumentException - - The parameter is not a Vector

getValue

public java.lang.Object getValue()
Description copied from class: IndexedCollection
Returns the Indexed Collection's elements. This method is implemented to provide polymorphism.

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

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 IndexedCollection
Parameters:
s - java.io.ObjectInput
Throws:
java.io.IOException.
java.lang.ClassNotFoundException.
java.io.IOException
java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput s)
                   throws java.io.IOException
Provides concrete serialization handling for ArrayCollection.

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

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009