IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class HashtableIndexedCollectionFormat

java.lang.Object
  extended by com.ibm.btt.base.HashtableIndexedCollectionFormat
All Implemented Interfaces:
Cacheable, java.io.Externalizable, java.io.Serializable

public class HashtableIndexedCollectionFormat
extends java.lang.Object
implements Externalizable, Cacheable

This class unformats a vector of hashtables in a IndexedCollection of KeyedCollections using the HashtableFormat.

See Also:
Serialized Form

Field Summary
 java.lang.String dataElementName
          The name of the IndexedCollection the format is managing
 HashtableFormat element
          The instance of HashtableFormat the format is using
 java.lang.String name
          Identifier of this instance
 
Constructor Summary
HashtableIndexedCollectionFormat()
          HashtableIndexedCollectionFormat constructor.
 
Method Summary
 Externalizer externalizer()
          externalizer method comment.
 java.lang.String getDataElementName()
          Returns the value of the dataElementName attribute.
 HashtableFormat getElement()
          Returns the instance of HashtableFormat being managed.
 java.lang.String getName()
          Gets the value of the name attribute.
 java.lang.String getTagName()
          Returns the tag associated with the name of the class.
 int getTimesRepeat()
          Returns the value of timesRepeat.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a HashtableIndexedCollectionFormat with the Tag attributes.
 boolean isCacheable()
          This method finds out if THIS particular object can be cached.
 void readExternal()
          This method will find the tag that corresponds to the name of THIS entity.
 void readExternal(java.io.ObjectInput s)
          Invokes the object creation from an ObjectInput.
 void reinitialize()
          This method will reinitialize THIS object.
 void removeExternal()
          Removes the object's tags from the XML file in which it is externalized.
 void setDataElementName(java.lang.String aString)
          Sets the dataElementName attribute value to aString.
 void setElement(HashtableFormat aHashtableFormat)
          Sets the value of element.
 void setName(java.lang.String aString)
          Sets the name attribute value to aString.
 void setTimesRepeat(int aNumber)
          Sets the value of timesRepeat.
 Vector toStrings()
          Returns an XML representation of the instance.
 Vector toTags()
          Returns a Vector with the HashtableFormat instance represented as a Tag.
 void unformat(Vector aVectorOfHashtables, Context aContext)
          Unformats the vector of hashtables into the context.
 IndexedCollection unformatIndexedCollection(Vector aVector, IndexedCollection anIndexedCollection)
          Updates the IndexedCollection elements by unformatting the vector elements.
 void writeExternal()
          Writes the HashtableFormat instance converted to tags to its XML file.
 void writeExternal(java.io.ObjectOutput s)
          Provides concrete serialization handling for HashtableIndexedCollectionFormat.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

dataElementName

public java.lang.String dataElementName
The name of the IndexedCollection the format is managing


element

public HashtableFormat element
The instance of HashtableFormat the format is using


name

public java.lang.String name
Identifier of this instance

Constructor Detail

HashtableIndexedCollectionFormat

public HashtableIndexedCollectionFormat()
HashtableIndexedCollectionFormat constructor.

Method Detail

externalizer

public Externalizer externalizer()
                          throws java.io.IOException
externalizer method comment.

Returns:
com.ibm.btt.base.Externalizer
Throws:
java.io.IOException

getDataElementName

public java.lang.String getDataElementName()
Returns the value of the dataElementName attribute.

Returns:
java.lang.String

getElement

public HashtableFormat getElement()
Returns the instance of HashtableFormat being managed.

Returns:
com.ibm.btt.base.HashtableFormat

getName

public java.lang.String getName()
Gets the value of the name attribute.

Specified by:
getName in interface Cacheable
Returns:
java.lang.String

getTagName

public java.lang.String getTagName()
Returns the tag associated with the name of the class.

Returns:
java.lang.String

getTimesRepeat

public int getTimesRepeat()
Returns the value of timesRepeat.

Returns:
int

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException
Initializes a HashtableIndexedCollectionFormat with the Tag attributes.

Parameters:
aTag - com.ibm.btt.base.Tag
Returns:
data.DataElement
Throws:
java.io.IOException

isCacheable

public boolean isCacheable()
This method finds out if THIS particular object can be cached.

Specified by:
isCacheable in interface Cacheable
Returns:
boolean

readExternal

public void readExternal()
                  throws java.io.IOException
This method will find the tag that corresponds to the name of THIS entity. Then it will initialize THIS entity with the contents of the tag.

Throws:
java.io.IOException

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

reinitialize

public void reinitialize()
This method will reinitialize THIS object. It should be called immediately after being extracted from the cache.

Specified by:
reinitialize in interface Cacheable

removeExternal

public void removeExternal()
                    throws java.io.IOException
Removes the object's tags from the XML file in which it is externalized.

Throws:
java.io.IOException

setDataElementName

public void setDataElementName(java.lang.String aString)
Sets the dataElementName attribute value to aString.

Parameters:
aString - java.lang.String

setElement

public void setElement(HashtableFormat aHashtableFormat)
Sets the value of element.

Parameters:
aHashtableFormat - com.ibm.btt.base.HashtableFormat

setName

public void setName(java.lang.String aString)
Sets the name attribute value to aString.

Parameters:
aString - java.lang.String

setTimesRepeat

public void setTimesRepeat(int aNumber)
Sets the value of timesRepeat.

Parameters:
aNumber - int

toStrings

public Vector toStrings()
Returns an XML representation of the instance.

Returns:
java.lang.String

toTags

public Vector toTags()
              throws java.io.IOException
Returns a Vector with the HashtableFormat instance represented as a Tag.

Returns:
com.ibm.btt.base.Vector
Throws:
java.io.IOException

unformat

public void unformat(Vector aVectorOfHashtables,
                     Context aContext)
              throws java.io.IOException,
                     DSEInvalidRequestException,
                     DSEInvalidArgumentException,
                     DSEObjectNotFoundException
Unformats the vector of hashtables into the context.

Parameters:
aVectorOfHashtables - com.ibm.btt.base.Vector
aContext - com.ibm.btt.base.Context
Throws:
java.io.IOException
DSEInvalidRequestException
DSEInvalidArgumentException
DSEObjectNotFoundException

unformatIndexedCollection

public IndexedCollection unformatIndexedCollection(Vector aVector,
                                                   IndexedCollection anIndexedCollection)
                                            throws DSEInvalidRequestException,
                                                   DSEInvalidArgumentException,
                                                   DSEObjectNotFoundException,
                                                   java.io.IOException
Updates the IndexedCollection elements by unformatting the vector elements.

Parameters:
aVector - com.ibm.btt.base.Vector
anIndexedCollection - IndexedCollection
Returns:
IndexedCollection
Throws:
DSEInvalidRequestException
DSEInvalidArgumentException
DSEObjectNotFoundException
java.io.IOException

writeExternal

public void writeExternal()
                   throws java.io.IOException
Writes the HashtableFormat instance converted to tags to its XML file.

Throws:
java.io.IOException

writeExternal

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

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

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010