com.ibm.dse.base
Class DataCollection

java.lang.Object
  |
  +--com.ibm.dse.base.DataElement
        |
        +--com.ibm.dse.base.DataCollection
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

Fields inherited from class com.ibm.dse.base.DataElement
description, name, 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 as qualified name 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 path aCompositeKey.
 
Methods inherited from class com.ibm.dse.base.DataElement
clone, externalizer, getDescription, getDescriptor, getElementAt, getErrorInfo, getExternalizer, getKey, getName, getState, getTagName, getValue, readExternal, readExternal, readObject, removeElementAt, removeExternal, setDescription, setDescriptor, setErrorInfo, setExternalizer, setName, setState, toStrings, toTags, validate, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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

nestedElements

public Vector nestedElements()
Returns all the DataElements included in this collection at any level.
Overrides:
nestedElements in class DataElement
Returns:
com.ibm.dse.base.Vector

nestedElements

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

nestedFields

public Vector nestedFields()
Returns all the DataFields at any level included in this collection.
Overrides:
nestedFields in class DataElement
Returns:
com.ibm.dse.base.Vector

nestedKeyedCollections

public Vector nestedKeyedCollections()
Returns all the KeyedCollections at any level included in this collection.
Returns:
com.ibm.dse.base.Vector

nestedQualifiedElements

public void nestedQualifiedElements(java.util.Hashtable theTable,
                                    java.lang.String Path)
Adds as qualified name all elements of this DataCollection to the Hashtable passed by parameter. Each entry has as key the qualified name of the DataElement and as 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.
Overrides:
setValue in class DataElement
Tags copied from class: DataElement
Parameters:
aValue - java.lang.Object

setValueAt

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