com.ibm.dse.base
Class HashtableIndexedCollectionFormat

java.lang.Object
  |
  +--com.ibm.dse.base.HashtableIndexedCollectionFormat

public class HashtableIndexedCollectionFormat
extends java.lang.Object
implements Externalizable

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
           
 HashtableFormat element
           
 java.lang.String name
           
 
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.
 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 removeExternal()
          Removes the object's tags from the SGML 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 SGML 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 SGML 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

element

public HashtableFormat element

name

public java.lang.String name
Constructor Detail

HashtableIndexedCollectionFormat

public HashtableIndexedCollectionFormat()
HashtableIndexedCollectionFormat constructor.
Method Detail

externalizer

public Externalizer externalizer()
                          throws java.io.IOException
externalizer method comment.
Specified by:
externalizer in interface Externalizable
Tags copied from interface: Externalizable
Returns:
com.ibm.dse.base.Externalizer

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.dse.base.HashtableFormat

getName

public java.lang.String getName()
Gets the value of the name attribute.
Specified by:
getName in interface Externalizable
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.
Specified by:
initializeFrom in interface Externalizable
Parameters:
aTag - com.ibm.dse.base.Tag

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
Specified by:
readExternal in interface Externalizable
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.
Parameters:
s - java.io.ObjectInput
Throws:
java.io.IOException -  
java.lang.ClassNotFoundException -  

removeExternal

public void removeExternal()
                    throws java.io.IOException
Removes the object's tags from the SGML file in which it is externalized.
Specified by:
removeExternal in interface Externalizable

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.dse.base.HashtableFormat

setName

public void setName(java.lang.String aString)
Sets the name attribute value to aString.
Specified by:
setName in interface Externalizable
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 SGML representation of the instance.
Specified by:
toStrings in interface Externalizable
Returns:
java.lang.String

toTags

public Vector toTags()
              throws java.io.IOException
Returns a Vector with the HashtableFormat instance represented as a Tag.
Specified by:
toTags in interface Externalizable
Tags copied from interface: Externalizable
Returns:
com.ibm.dse.base.Vector

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.dse.base.Vector
aContext - com.ibm.dse.base.Context

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.dse.base.Vector
anIndexedCollection - IndexedCollection
Returns:
IndexedCollection

writeExternal

public void writeExternal()
                   throws java.io.IOException
Writes the HashtableFormat instance converted to tags to its SGML file.
Specified by:
writeExternal in interface Externalizable

writeExternal

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