|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.dse.base.FormatElement
com.ibm.dse.base.KeyedCollectionFormat
This abstract class contains a collection of format elements used to format the elements of a KeyedCollection. This class provides a protocol to add, remove, and change these elements.
Field Summary | |
---|---|
(package private) boolean |
dataElementEmpty
|
(package private) Vector |
elements
|
Fields inherited from class com.ibm.dse.base.FormatElement |
---|
dataElementName, externalizer, name |
Constructor Summary | |
---|---|
KeyedCollectionFormat()
|
Method Summary | |
---|---|
KeyedCollectionFormat |
add(FormatElement aFormatElement)
Adds an element to the last position of the KeyedCollection. |
KeyedCollectionFormat |
addElementAt(FormatElement aFormatElement,
int pos)
Adds an element to the position determined by the pos parameter. |
KeyedCollectionFormat |
addFirst(FormatElement aFormatElement)
Adds an element to the first position of the KeyedCollection. |
FormatElement |
at(int anIndex)
Returns the element at the position marked by anIndex. |
java.lang.String |
format(Context aContext)
Formats data elements, getting them from the context. |
java.lang.String |
format(DataElement aDataElement)
Formats KeyedCollection passed as parameter. |
abstract java.lang.String |
formatContext(Context aContext)
Abstract method. |
abstract java.lang.String |
formatKeyedCollection(KeyedCollection aKeyedCollection)
Abstract method. |
boolean |
getDataElementEmpty()
Returns if dataElement is empty. |
Vector |
getElements()
Gets the elements property (Vector) value. |
java.util.Enumeration |
getEnumeration()
Returns the elements of this format as an Enumeration. |
void |
reinitialize()
This method will call elements reinitialize . |
void |
removeAll()
Remove the elements of this format. |
FormatElement |
removeAt(int anIndex)
Remove the element of this format marked by anIndex. |
void |
setElements(Vector v)
Sets the elements property (Vector) value. |
int |
size()
Returns the number of elements of this format. |
DataElement |
unformat(java.lang.String aString,
Context aContext)
Returns a data element by unformatting the KeyedCollection using the context passed as a parameter. |
DataElement |
unformat(java.lang.String aString,
DataElement aDataElement)
Returns a data element by unformatting the KeyedCollection using the data element passed as a parameter. |
abstract DataElement |
unformatContext(java.lang.String aString,
Context aContext)
Abstract method. |
abstract KeyedCollection |
unformatKeyedCollection(java.lang.String aString,
KeyedCollection aKeyedCollection)
Abstract method. |
Methods inherited from class com.ibm.dse.base.FormatElement |
---|
exceptionInfo, externalizer, extract, format, getDataElementName, getExternalizer, getName, getTagName, initializeFrom, isCacheable, isConstant, isItConstant, readExternal, readExternal, readObject, removeExternal, rootDecorated, setDataElementName, setExternalizer, setName, setSize, toString, toStrings, toTags, unformat, writeExternal, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
Vector elements
boolean dataElementEmpty
Constructor Detail |
public KeyedCollectionFormat()
Method Detail |
public KeyedCollectionFormat add(FormatElement aFormatElement)
public KeyedCollectionFormat addElementAt(FormatElement aFormatElement, int pos)
aFormatElement
- FormatElementpos
- intpublic KeyedCollectionFormat addFirst(FormatElement aFormatElement)
aFormatElement
- FormatElementpublic FormatElement at(int anIndex)
anIndex
- intpublic java.lang.String format(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
format
in class FormatElement
aContext
- com.ibm.dse.base.Context
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public java.lang.String format(DataElement aDataElement) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
format
in class FormatElement
aDataElement
- DataElement
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public abstract java.lang.String formatContext(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aContext
- com.ibm.dse.base.Context
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public abstract java.lang.String formatKeyedCollection(KeyedCollection aKeyedCollection) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public boolean getDataElementEmpty()
public Vector getElements()
setElements(com.ibm.dse.base.Vector)
public java.util.Enumeration getEnumeration()
public void reinitialize()
reinitialize
in interface Cacheable
reinitialize
in class FormatElement
public void removeAll()
public FormatElement removeAt(int anIndex)
public void setElements(Vector v)
getElements()
public int size()
public DataElement unformat(java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformat
in class FormatElement
aString
- java.lang.StringaContext
- com.ibm.dse.base.Context
DSEInvalidRequestException
DSEInvalidArgumentException
public DataElement unformat(java.lang.String aString, DataElement aDataElement) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformat
in class FormatElement
aString
- StringaDataElement
- DataElement
DSEInvalidRequestException
DSEInvalidArgumentException
public abstract DataElement unformatContext(java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
aString
- java.lang.StringaContext
- com.ibm.dse.base.Context
DSEInvalidRequestException
DSEInvalidArgumentException
public abstract KeyedCollection unformatKeyedCollection(java.lang.String aString, KeyedCollection aKeyedCollection) throws DSEInvalidRequestException, DSEInvalidArgumentException
aString
- StringaKeyedCollection
- KeyedCollection
DSEInvalidRequestException
DSEInvalidArgumentException
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |