com.ibm.dse.base
Class RecordFormat

java.lang.Object
  |
  +--com.ibm.dse.base.FormatElement
        |
        +--com.ibm.dse.base.KeyedCollectionFormat
              |
              +--com.ibm.dse.base.RecordFormat
Direct Known Subclasses:
DataMapperFormat, DynamicRecordFormat, FormsRecordFormat, JxfsFormat, XMLFormat

public class RecordFormat
extends KeyedCollectionFormat

This class is an implementation of the KeyedCollectionFormat.

See Also:
Serialized Form

Fields inherited from class com.ibm.dse.base.FormatElement
dataElementName, name
 
Constructor Summary
RecordFormat()
          RecordFormat default constructor.
RecordFormat(java.lang.String aName)
          Constructor used by the externalizer.
 
Method Summary
 java.lang.String[] extract(java.lang.String aString)
          Extract a String calling the extract methods of this elements and taking the substring in which they are interested.
 java.lang.String formatContext(Context aContext)
          This method performs the format seeking the elements to format around the context tree of the context passed as parameter.
 java.lang.String formatKeyedCollection(KeyedCollection aKeyedCollection)
          This method performs the format seeking the elements to format around the keyedCollection passed as parameter.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a RecordFormat with the Tag attributes.
protected  java.lang.Object obtainDataElement(FormatElement aFormatElement, Context aContext)
          Seek for the element which will format aFormatElement.
protected  DataElement obtainDataElement(FormatElement aFormatElement, KeyedCollection aKeyedCollection)
          Seek for the element which will format aFormatElement.
 java.lang.String toString()
          Returns a visual representation of this format element.
 Vector toStrings()
          Returns a visual representation of this format element.
 DataElement unformatContext(java.lang.String aString, Context aContext)
          This method performs the unformat seeking the elements to format around the context tree of the context passed as parameter.
 KeyedCollection unformatKeyedCollection(java.lang.String aString, KeyedCollection aKeyedCollection)
          This method performs the unformat seeking the elements to format around the keyedCollection passed as parameter.
 
Methods inherited from class com.ibm.dse.base.KeyedCollectionFormat
add, addElementAt, addFirst, at, format, format, getElements, getEnumeration, removeAll, removeAt, setElements, size, unformat, unformat
 
Methods inherited from class com.ibm.dse.base.FormatElement
exceptionInfo, externalizer, format, getDataElementName, getExternalizer, getName, getTagName, isCacheable, isConstant, readExternal, readExternal, readObject, reinitialize, removeExternal, rootDecorated, setDataElementName, setExternalizer, setName, setSize, toTags, unformat, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RecordFormat

public RecordFormat()
RecordFormat default constructor.

RecordFormat

public RecordFormat(java.lang.String aName)
             throws java.io.IOException
Constructor used by the externalizer.
Parameters:
aString - java.lang.String
Method Detail

extract

public java.lang.String[] extract(java.lang.String aString)
                           throws DSEInvalidArgumentException
Extract a String calling the extract methods of this elements and taking the substring in which they are interested.
Overrides:
extract in class FormatElement
Tags copied from class: FormatElement
Parameters:
String - aString
Returns:
String[]

formatContext

public java.lang.String formatContext(Context aContext)
                               throws DSEInvalidClassException,
                                      DSEInvalidRequestException,
                                      DSEInvalidArgumentException
This method performs the format seeking the elements to format around the context tree of the context passed as parameter.
Overrides:
formatContext in class KeyedCollectionFormat
Parameters:
aContext - com.ibm.dse.base.Context
Returns:
java.lang.String

formatKeyedCollection

public java.lang.String formatKeyedCollection(KeyedCollection aKeyedCollection)
                                       throws DSEInvalidClassException,
                                              DSEInvalidRequestException,
                                              DSEInvalidArgumentException
This method performs the format seeking the elements to format around the keyedCollection passed as parameter.
Overrides:
formatKeyedCollection in class KeyedCollectionFormat
Parameters:
aKeyedCollection - com.ibm.dse.base.KeyedCollection
Returns:
java.lang.String

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException
Initializes a RecordFormat with the Tag attributes.
Overrides:
initializeFrom in class FormatElement
Parameters:
aTag - com.ibm.dse.base.Tag
Returns:
java.lang.Object

obtainDataElement

protected java.lang.Object obtainDataElement(FormatElement aFormatElement,
                                             Context aContext)
                                      throws DSEInvalidRequestException
Seek for the element which will format aFormatElement. Particular cases are handled.
Parameters:
aFormatElement - com.ibm.dse.base.FormatElement
aContext - com.ibm.dse.base.Context
Returns:
java.lang.Object
Throws:
com.ibm.dse.base.DSEInvalidRequestException. -  

obtainDataElement

protected DataElement obtainDataElement(FormatElement aFormatElement,
                                        KeyedCollection aKeyedCollection)
                                 throws DSEInvalidRequestException
Seek for the element which will format aFormatElement. Particular cases are handled.
Parameters:
aFormatElement - com.ibm.dse.base.FormatElement
aKeyedCollection - com.ibm.dse.base.KeyedCollection
Returns:
com.ibm.dse.base.DataElement
Throws:
DSEInvalidRequestException -  

toString

public java.lang.String toString()
Description copied from class: FormatElement
Returns a visual representation of this format element.
Overrides:
toString in class FormatElement
Returns:
java.lang.String

toStrings

public Vector toStrings()
Description copied from class: FormatElement
Returns a visual representation of this format element.
Overrides:
toStrings in class FormatElement
Returns:
Tag[]

unformatContext

public DataElement unformatContext(java.lang.String aString,
                                   Context aContext)
                            throws DSEInvalidRequestException,
                                   DSEInvalidArgumentException
This method performs the unformat seeking the elements to format around the context tree of the context passed as parameter.
Overrides:
unformatContext in class KeyedCollectionFormat
Parameters:
aString - java.lang.String
aContext - com.ibm.dse.base.Context
Returns:
com.ibm.dse.base.DataElement

unformatKeyedCollection

public KeyedCollection unformatKeyedCollection(java.lang.String aString,
                                               KeyedCollection aKeyedCollection)
                                        throws DSEInvalidRequestException,
                                               DSEInvalidArgumentException
This method performs the unformat seeking the elements to format around the keyedCollection passed as parameter.
Overrides:
unformatKeyedCollection in class KeyedCollectionFormat
Parameters:
aString - java.lang.String
aKeyedCollection - com.ibm.dse.base.KeyedCollection
Returns:
com.ibm.dse.base.KeyedCollection