com.ibm.dse.services.jxfs.ptr
Class JxfsFormat

java.lang.Object
  |
  +--com.ibm.dse.base.FormatElement
        |
        +--com.ibm.dse.base.KeyedCollectionFormat
              |
              +--com.ibm.dse.base.RecordFormat
                    |
                    +--com.ibm.dse.services.jxfs.ptr.JxfsFormat

public class JxfsFormat
extends RecordFormat

This class implements a format to generate the special data stream required by the Jxfs printForm function

See Also:
Serialized Form

Fields inherited from class com.ibm.dse.base.FormatElement
dataElementName, name
 
Constructor Summary
JxfsFormat()
          This constructor creates a JxfsFormat object.
JxfsFormat(java.lang.String aName)
          This constructor creates a JxfsFormat object.
 
Method Summary
 java.lang.String formatContext(Context aContext, java.lang.String formName)
          This method performs the format seeking the elements to format around the context tree of the context passed as parameter.
 Vector getNamesVector()
          Returns the value of the namesVector property.
 Vector getVectorForm()
          Returns the value of the vectorForm property.
 
Methods inherited from class com.ibm.dse.base.RecordFormat
extract, formatContext, formatKeyedCollection, initializeFrom, obtainDataElement, obtainDataElement, toString, toStrings, unformatContext, unformatKeyedCollection
 
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

JxfsFormat

public JxfsFormat()
This constructor creates a JxfsFormat object.

JxfsFormat

public JxfsFormat(java.lang.String aName)
           throws java.io.IOException
This constructor creates a JxfsFormat object.
Parameters:
aName - java.lang.String Object name
Throws:
java.io.IOException - The object cannot be created
Method Detail

formatContext

public java.lang.String formatContext(Context aContext,
                                      java.lang.String formName)
                               throws DSEInvalidClassException,
                                      DSEInvalidRequestException,
                                      DSEInvalidArgumentException
This method performs the format seeking the elements to format around the context tree of the context passed as parameter.
Parameters:
aContext - com.ibm.dse.base.Context Context used for formatting
formName - java.lang.String Form name
Returns:
java.lang.String
Throws:
DSEInvalidClassException - Invalid class, format not done
DSEInvalidRequestException - Invalid request, format not done
DSEInvalidArgumentException - Invalid argument, format not done

getNamesVector

public Vector getNamesVector()
Returns the value of the namesVector property.
Returns:
java.util.Vector - The current value of namesVector

getVectorForm

public Vector getVectorForm()
Returns the value of the vectorForm property.
Returns:
Vector - The current value of vectorForm