clone()
Methods inherited from class com.ibm.btt.base.KeyedCollection |
calculeNestedElements, calculeNestedQualifiedElements, getDynamic, isCompressable, isDynamic, readExternal, setCompressable, setDynamic, setDynamic, stringValueOf, tryGetValueAt, trySetValueAt, writeExternal |
Methods inherited from class com.ibm.btt.base.DataElement |
externalizer, getErrorInfo, getExternalizer, getName, getParameter, getTagName, readExternal, readObject, removeExternal, setErrorInfo, setExternalizer, setName, setParameter, setParameters, setSerializable, toTags, writeExternal |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
ATTR_BEAN
public static final java.lang.String ATTR_BEAN
- See Also:
- Constant Field Values
BeanCollection
public BeanCollection()
- This is the default constructor used to create a BeanCollection object.
BeanCollection
public BeanCollection(java.lang.Object bean)
- This constructor used to create a BeanCollection Object.
- Parameters:
bean -
BeanCollection
protected BeanCollection(java.lang.Object bean,
java.lang.Object parentBean)
getInstance
public static BeanCollection getInstance()
- Get the BeanColleciton instance
- Returns:
- BeanCollection instance
getBean
public java.lang.Object getBean()
- Return the bean value
- Returns:
- java.lang.Object
setBean
public void setBean(java.lang.Object bean)
- Set the bean value
- Parameters:
bean -
getParentBean
protected java.lang.Object getParentBean()
setParentBean
protected void setParentBean(java.lang.Object parentBean)
initializeFrom
public java.lang.Object initializeFrom(Tag aTag)
throws java.io.IOException
- Initialize a beanCollection from its tag in XML.
- Overrides:
initializeFrom in class KeyedCollection
- Parameters:
aTag - Tag
- Returns:
- java.lang.Object
- Throws:
java.io.IOException
getParameters
@Deprecated
public Hashtable getParameters()
- Deprecated.
- 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
setValueAt
public void setValueAt(java.lang.String name,
java.lang.Object value)
throws DSEInvalidArgumentException,
DSEObjectNotFoundException
- The method call tyrGetBeanElement method and set the bean property value
- Overrides:
setValueAt in class KeyedCollection
- Parameters:
String - nameObject - value
- Throws:
DSEInvalidArgumentException
DSEObjectNotFoundException
tryGetElementAt
public DataElement tryGetElementAt(java.lang.String aName)
- 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
getBeanElementAt
public DataElement getBeanElementAt(java.lang.String name)
- 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.
- Parameters:
aName - java.lang.String - The path and name of the data element to be retrieved
- Returns:
- DataElement
validate
@Deprecated
public java.lang.Object validate(java.lang.Object toValidate,
java.lang.String convType)
throws DSETypeException
- Deprecated.
- No need to validate bean attributes
- Overrides:
validate in class DataCollection
- Parameters:
toValidate - ObjectconvType - String
- Returns:
- toValidate Object
- Throws:
DSETypeException - - Thrown if the validation is unsuccessful
validate
@Deprecated
public java.lang.Object validate(java.lang.Object toValidate)
throws DSETypeException
- Deprecated.
- No need to validate bean attributes
- Overrides:
validate in class DataElement
- Parameters:
toValidate - Object
- Returns:
- toValidate Object
- Throws:
DSETypeException - - Thrown if the validation is unsuccessful
setValue
public void setValue(java.lang.Object value)
throws DSEInvalidArgumentException
- Set a bean instance
- Overrides:
setValue in class KeyedCollection
- Parameters:
Object - value
- Throws:
DSEInvalidArgumentException - - The parameter is not a Hashtable Object
validateObject
public java.lang.Object validateObject(java.lang.Object toValidate)
throws DSETypeException
- No need to validate bean attributes
- Overrides:
validateObject in class DataElement
- Parameters:
toValidate - Object
- Returns:
- toValidate Object
- Throws:
DSETypeException - - Thrown if the validation is unsuccessful
getValue
public java.lang.Object getValue()
- Get the bean value
- Overrides:
getValue in class KeyedCollection
- Returns:
- Object
addElement
@Deprecated
public void addElement(DataElement dataElement)
- Deprecated.
- 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:
dataElement - DataElement
addElement
@Deprecated
public void addElement(java.lang.String name,
java.lang.Object value,
java.lang.String path,
java.lang.String type)
throws DSEInvalidArgumentException,
java.lang.ClassNotFoundException,
java.lang.InstantiationException,
java.lang.IllegalAccessException
- Deprecated.
- 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:
name - java.lang.String. - The Name of the DataElementvalue - Object. - The Value of the DataElementpath - java.lang.String. - The Path to the DataElementtype - java.lang.String - The Type of the DataElement
- Throws:
DSEInvalidArgumentException
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
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
getElementAt
@Deprecated
public DataElement getElementAt(int index)
throws DSEObjectNotFoundException
- Deprecated.
- 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
setOrder
@Deprecated
public void setOrder(Vector anOrder)
- Deprecated.
setValueAt
public void setValueAt(java.lang.String name,
java.lang.Object value,
java.lang.String type)
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()
- Get the bean declaredFileds length
- Overrides:
size in class KeyedCollection
- Returns:
- int
toString
public java.lang.String toString()
- Returns a visual representation of the BeanCollection.
- Overrides:
toString in class KeyedCollection
- Returns:
- java.lang.String
toStrings
public Vector toStrings()
- Returns a visual representation of the BeanCollection.
- Overrides:
toStrings in class KeyedCollection
- Returns:
- java.lang.String
tryGetElementAtAnyLevel
@Deprecated
public DataElement tryGetElementAtAnyLevel(java.lang.String name)
- Deprecated.
- 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:
name - java.lang.String - The name of the data element to be retrieved
- Returns:
- com.ibm.btt.base.DataElement
tryGetElementAtFirstLevel
@Deprecated
protected DataElement tryGetElementAtFirstLevel(java.lang.String name)
- Deprecated.
- 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:
name - java.lang.String
- Returns:
- DataElement
getElementAt
public DataElement getElementAt(java.lang.String name)
throws DSEObjectNotFoundException
- 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
getElementAtAnyLevel
@Deprecated
public DataElement getElementAtAnyLevel(java.lang.String name)
throws DSEObjectNotFoundException
- Deprecated.
- 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:
name - java.lang.String - The name of the data element to be retrieved
- Returns:
- com.ibm.btt.base.DataElement
- Throws:
DSEObjectNotFoundException
getElementAtFirstLevel
@Deprecated
protected DataElement getElementAtFirstLevel(java.lang.String name)
throws DSEObjectNotFoundException
- Deprecated.
- 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:
name - java.lang.String
- Returns:
- DataElement
- Throws:
DSEObjectNotFoundException
getElements
@Deprecated
public Hashtable getElements()
- Deprecated.
- 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
@Deprecated
public java.util.Enumeration getEnumeration()
- Deprecated.
- Description copied from class:
KeyedCollection
- Returns the elements of the keyedCollection as an Enumeration.
- Overrides:
getEnumeration in class KeyedCollection
- Returns:
- java.util.Enumeration
getIndexOf
@Deprecated
public int getIndexOf(int from,
java.lang.String name)
- Deprecated.
- 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
@Deprecated
public int getIndexOf(java.lang.String name)
- Deprecated.
- Description copied from class:
KeyedCollection
- Returns the position of the element aName.
- Overrides:
getIndexOf in class KeyedCollection
- Returns:
- int
getNestedElements
@Deprecated
public Hashtable getNestedElements()
- Deprecated.
- 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
@Deprecated
public Hashtable getOrder()
- Deprecated.
- 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
@Deprecated
public java.util.Vector getOrderVector()
- Deprecated.
- 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)
removeAll
public void removeAll()
- remove all bean's declaredFields value
- Overrides:
removeAll in class KeyedCollection
removeElementAt
@Deprecated
public DataElement removeElementAt(int index)
throws DSEObjectNotFoundException
- Deprecated.
- 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 name)
throws DSEObjectNotFoundException
- Remove the bean's fields value identified by its name
- Overrides:
removeElementAt in class KeyedCollection
- Parameters:
name - String
- Returns:
- DataElement
- Throws:
DSEObjectNotFoundException
removeElementAtFirstLevel
protected DataElement removeElementAtFirstLevel(java.lang.String name)
throws DSEObjectNotFoundException
- Remove the bean's fields value identified by its name
- Overrides:
removeElementAtFirstLevel in class KeyedCollection
- Parameters:
name - String
- Returns:
- DataElement
- Throws:
DSEObjectNotFoundException
reorderElements
@Deprecated
protected void reorderElements(int from)
- Deprecated.
- 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
setElements
@Deprecated
public void setElements(Hashtable anElements)
- Deprecated.
- Description copied from class:
KeyedCollection
- Sets the elements property (java.util.Hashtable) value.
- Overrides:
setElements in class KeyedCollection
setOrder
@Deprecated
public void setOrder(Hashtable anOrder)
- Deprecated.
- Description copied from class:
KeyedCollection
- Sets the order property (java.util.Vector) value from a Hashtable.
- Overrides:
setOrder in class KeyedCollection
setOrder
@Deprecated
public void setOrder(java.util.Vector anOrder)
- Deprecated.
- 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()
nestedFields
@Deprecated
public Vector nestedFields()
- Deprecated.
- 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
@Deprecated
public Vector nestedKeyedCollections()
- Deprecated.
- Description copied from class:
DataCollection
- Returns all the KeyedCollections at any level included in this collection.
- Overrides:
nestedKeyedCollections in class DataCollection
- Returns:
- com.ibm.btt.base.Vector
nestedQualifiedElements
@Deprecated
public void nestedQualifiedElements(java.util.Hashtable theTable,
java.lang.String Path)
- Deprecated.
- 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.HashtablePath - String - The path where the DataCollection is
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
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
setAmended
@Deprecated
public void setAmended(boolean value)
- Deprecated.
- Description copied from class:
DataElement
- Sets the amended flag to aValue.
- 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
setIsCached
@Deprecated
public void setIsCached(boolean cached)
- Deprecated.
- Description copied from class:
DataElement
- Sets the isCached.
- Overrides:
setIsCached 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
isSerializable
public boolean isSerializable()
- verify if bean implements the Serializable interfaces
- Overrides:
isSerializable in class DataElement
- Returns:
- true if this data element is serializable.
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
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
(c) Copyright IBM Corporation 1998, 2009
|