|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.DataElement
com.ibm.btt.base.DataCollection
com.ibm.btt.base.KeyedCollection
com.ibm.btt.base.LazyKeyedCollection
public class LazyKeyedCollection
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 |
---|
LazyRefDataTag refDataTag
KeyedCollection kCollInstance
KeyedCollection tempKCollInstance
Constructor Detail |
---|
public LazyKeyedCollection()
Method Detail |
---|
public LazyRefDataTag getRefDataTag()
public void setRefDataTag(LazyRefDataTag refDataTag)
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException
KeyedCollection
initializeFrom
in class KeyedCollection
aTag
- Tag
java.io.IOException
protected void instanceTemplateObject()
public KeyedCollection getTempKCollInstance()
protected void instanceLazyObject()
public void addElement(DataElement aDataElement)
KeyedCollection
addElement
in class KeyedCollection
aDataElement
- DataElementpublic 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
KeyedCollection
addElement
in class KeyedCollection
aName
- java.lang.String. - The Name of the DataElementaValue
- Object. - The Value of the DataElementaPath
- java.lang.String. - The Path to the DataElementaType
- java.lang.String - The Type of the DataElement
DSEInvalidArgumentException
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
public Hashtable calculeNestedElements()
KeyedCollection
calculeNestedElements
in class KeyedCollection
public Hashtable calculeNestedQualifiedElements()
KeyedCollection
calculeNestedQualifiedElements
in class KeyedCollection
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
KeyedCollection
clone
in interface DSECloneable
clone
in class KeyedCollection
java.lang.CloneNotSupportedException
- - if a problem occurs trying to clone the objectpublic java.lang.String getDynamic()
KeyedCollection
getDynamic
in class KeyedCollection
KeyedCollection.setDynamic(java.lang.String)
public DataElement getElementAt(int index) throws DSEObjectNotFoundException
KeyedCollection
getElementAt
in class KeyedCollection
index
- int
DSEObjectNotFoundException
public DataElement getElementAtAnyLevel(java.lang.String aName) throws DSEObjectNotFoundException
KeyedCollection
getElementAtAnyLevel
in class KeyedCollection
aName
- java.lang.String - The name of the data element to be retrieved
DSEObjectNotFoundException
protected DataElement getElementAtFirstLevel(java.lang.String aName) throws DSEObjectNotFoundException
KeyedCollection
getElementAtFirstLevel
in class KeyedCollection
aName
- java.lang.String
DSEObjectNotFoundException
public Hashtable getElements()
KeyedCollection
getElements
in class KeyedCollection
KeyedCollection.setElements(com.ibm.btt.base.Hashtable)
public java.util.Enumeration getEnumeration()
KeyedCollection
getEnumeration
in class KeyedCollection
public int getIndexOf(int from, java.lang.String aName)
KeyedCollection
getIndexOf
in class KeyedCollection
public int getIndexOf(java.lang.String aName)
KeyedCollection
getIndexOf
in class KeyedCollection
public Hashtable getNestedElements()
KeyedCollection
getNestedElements
in class KeyedCollection
public Hashtable getOrder()
KeyedCollection
getOrder
in class KeyedCollection
KeyedCollection.setOrder(com.ibm.btt.base.Hashtable)
public java.util.Vector getOrderVector()
KeyedCollection
getOrderVector
in class KeyedCollection
KeyedCollection.setOrder(com.ibm.btt.base.Hashtable)
public java.lang.Object getValue()
KeyedCollection
getValue
in class KeyedCollection
public boolean isDynamic()
KeyedCollection
isDynamic
in class KeyedCollection
public void readFromStream(java.io.ObjectInput s) throws java.io.IOException, java.lang.ClassNotFoundException
KeyedCollection
readFromStream
in class KeyedCollection
s
- java.io.ObjectInput
java.io.IOException
java.lang.ClassNotFoundException
public void removeAll()
KeyedCollection
removeAll
in class KeyedCollection
public DataElement removeElementAt(int index) throws DSEObjectNotFoundException
KeyedCollection
removeElementAt
in class KeyedCollection
index
- int
DSEObjectNotFoundException
public DataElement removeElementAt(java.lang.String aName) throws DSEObjectNotFoundException
KeyedCollection
removeElementAt
in class KeyedCollection
aName
- java.lang.String
DSEObjectNotFoundException
protected DataElement removeElementAtFirstLevel(java.lang.String aName) throws DSEObjectNotFoundException
KeyedCollection
removeElementAtFirstLevel
in class KeyedCollection
aName
- java.lang.String
DSEObjectNotFoundException
protected void reorderElements(int from)
KeyedCollection
reorderElements
in class KeyedCollection
from
- intpublic void setDynamic(java.lang.String aValue)
KeyedCollection
setDynamic
in class KeyedCollection
public void setDynamic(boolean aValue)
KeyedCollection
setDynamic
in class KeyedCollection
public void setElements(Hashtable anElements)
KeyedCollection
setElements
in class KeyedCollection
public void setOrder(Hashtable anOrder)
KeyedCollection
setOrder
in class KeyedCollection
public void setOrder(java.util.Vector anOrder)
KeyedCollection
setOrder
in class KeyedCollection
anOrder
- - The new value for the propertyKeyedCollection.getOrder()
public void setValue(java.lang.Object aValue) throws DSEInvalidArgumentException
KeyedCollection
setValue
in class KeyedCollection
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.
DSEInvalidArgumentException
- - The parameter is not a Hashtable Objectpublic void setValueAt(java.lang.String aName, java.lang.Object aValue) throws DSEInvalidArgumentException, DSEObjectNotFoundException
KeyedCollection
setValueAt
in class KeyedCollection
DSEInvalidArgumentException
DSEObjectNotFoundException
public void setValueAt(java.lang.String aName, java.lang.Object aValue, java.lang.String aType) throws DSEInvalidArgumentException, DSEObjectNotFoundException
KeyedCollection
setValueAt
in class KeyedCollection
DSEInvalidArgumentException
DSEObjectNotFoundException
public int size()
KeyedCollection
size
in class KeyedCollection
public Vector toStrings()
KeyedCollection
toStrings
in class KeyedCollection
public java.lang.String toString()
KeyedCollection
toString
in class KeyedCollection
public DataElement tryGetElementAt(java.lang.String aName)
KeyedCollection
tryGetElementAt
in class KeyedCollection
aName
- java.lang.String - The path and name of the data element to be retrieved
public DataElement tryGetElementAtAnyLevel(java.lang.String aName)
KeyedCollection
tryGetElementAtAnyLevel
in class KeyedCollection
aName
- java.lang.String - The name of the data element to be retrieved
protected DataElement tryGetElementAtFirstLevel(java.lang.String aName)
KeyedCollection
tryGetElementAtFirstLevel
in class KeyedCollection
aName
- java.lang.String
public java.lang.Object tryGetValueAt(java.lang.String aCompositeKey)
KeyedCollection
tryGetValueAt
in class KeyedCollection
aCompositeKey
- java.lang.String
public int trySetValueAt(java.lang.String aName, java.lang.Object aValue) throws DSEInvalidArgumentException
KeyedCollection
trySetValueAt
in class KeyedCollection
DSEInvalidArgumentException
public void writeToStream(java.io.ObjectOutput s) throws java.io.IOException
KeyedCollection
writeToStream
in class KeyedCollection
s
- java.io.ObjectOutput
java.io.IOException
public boolean isCompressable()
isCompressable
in class KeyedCollection
public void setCompressable(boolean compress)
KeyedCollection
setCompressable
in class KeyedCollection
public java.lang.Object getValueAt(java.lang.String aCompositeKey) throws DSEObjectNotFoundException
DataCollection
getValueAt
in class DataCollection
aCompositeKey
- java.lang.String
DSEObjectNotFoundException
public void nestedElements(java.util.Hashtable theTable)
DataCollection
nestedElements
in class DataCollection
public Vector nestedFields()
DataCollection
nestedFields
in class DataCollection
public Vector nestedKeyedCollections()
DataCollection
nestedKeyedCollections
in class DataCollection
public void nestedQualifiedElements(java.util.Hashtable theTable, java.lang.String Path)
DataCollection
nestedQualifiedElements
in class DataCollection
theTable
- java.util.HashtablePath
- String - The path where the DataCollection ispublic java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType) throws DSETypeException
DataCollection
validate
in class DataCollection
toValidate
- ObjectconvType
- String
DSETypeException
- - Thrown if the validation is unsuccessfulpublic java.lang.String getDescription()
DataElement
getDescription
in class DataElement
public PropertyDescription getDescriptor()
DataElement
getDescriptor
in interface TypedData
getDescriptor
in class DataElement
public java.lang.String getDirection()
DataElement
getDirection
in class DataElement
public void setDirection(java.lang.String dir)
DataElement
setDirection
in class DataElement
public DataElement getElementAt(java.lang.String aName) throws DSEObjectNotFoundException
KeyedCollection
getElementAt
in class KeyedCollection
aName
- java.lang.String the path and name of the data element to be retrieved
DSEObjectNotFoundException
public Key getKey() throws DSETypeException
DataElement
getKey
in interface TypedData
getKey
in class DataElement
DSETypeException
- - If the key can not be built from this business objectpublic java.lang.Object getParameter(java.lang.String parameterName)
DataElement
getParameter
in class DataElement
parameterName
- String
public Hashtable getParameters()
DataElement
getParameters
in class DataElement
public ElementState getState()
DataElement
getState
in class DataElement
public boolean isAmended()
DataElement
isAmended
in class DataElement
public void setAmended(boolean aValue)
DataElement
setAmended
in class DataElement
aValue
- booleanpublic void setDescription(java.lang.String aDescription)
DataElement
setDescription
in class DataElement
aDescription
- java.lang.Stringpublic void setDescriptor(PropertyDescription descriptor)
DataElement
setDescriptor
in interface TypedData
setDescriptor
in class DataElement
descriptor
- PropertyDescriptionpublic void setErrorInfo(ErrorInfo anErrorInfo)
DataElement
setErrorInfo
in class DataElement
public void setName(java.lang.String aName)
DataElement
setName
in interface TypedData
setName
in class DataElement
aName
- java.lang.Stringpublic void setParameter(java.lang.String parameterName, java.lang.Object parameterValue)
DataElement
setParameter
in class DataElement
parameterName
- StringparameterValue
- Objectpublic void setParameters(Hashtable theParameters)
DataElement
setParameters
in class DataElement
public void setState(ElementState aState)
DataElement
setState
in class DataElement
aState
- com.ibm.btt.base.types.ElementStatepublic java.lang.Object validate(java.lang.Object toValidate) throws DSETypeException
DataElement
validate
in class DataElement
DSETypeException
- - If the object has not been successfully validatedpublic java.lang.Object validateObject(java.lang.Object toValidate) throws DSETypeException
DataElement
validateObject
in class DataElement
DSETypeException
- - If the object has not been successfully validated
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |