|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.FormatElement
com.ibm.btt.base.IndexedCollectionFormat
@ATTR(value={"times#String#IMPLIED","append#String#IMPLIED"}) public class IndexedCollectionFormat
This class formats the elements of a IndexedCollection using the same format for each one.
Field Summary | |
---|---|
protected int |
append
The append attribute |
FormatElement |
element
The formatter element for the child data elements of the indexed collection. |
Fields inherited from class com.ibm.btt.base.FormatElement |
---|
dataElementName, externalizer, name |
Constructor Summary | |
---|---|
IndexedCollectionFormat()
This is the default constructor used to create an IndexedCollectionFormat object. |
|
IndexedCollectionFormat(java.lang.String aName)
This is the constructor used by the externalizer to create an IndexedCollectionFormat object. |
Method Summary | |
---|---|
java.lang.String[] |
extract(java.lang.String aString)
Extracts an element a number of times equal to the timesRepeat attribute. |
java.lang.String |
format(DataElement aDataElement)
Verifies that the passed DataElement is an IndexedCollection and then calls formatIndexedCollection(). |
java.lang.String |
formatIndexedCollection(IndexedCollection anIndexedCollection)
Formats the IndexedCollection elements according to the FormatElement in the element attribute. |
java.lang.String |
getAppend()
Returns the value of the append property. |
FormatElement |
getElement()
Returns the value of element. |
int |
getTimesRepeat()
Returns the value of timesRepeat. |
protected boolean |
goOn(int ndxFrom,
int ndxTo,
int counter,
java.lang.String str)
return boolean |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes an IndexedCollectionFormat with the Tag attributes. |
void |
reinitialize()
This method will call element reinitialize. |
void |
setAppend(java.lang.String aString)
Sets the value of the append property. |
void |
setElement(FormatElement aFormatElement)
Sets the value of element. |
void |
setTimesRepeat(int aNumber)
Sets the value of timesRepeat. |
Vector |
toStrings()
Returns an XML representation of the instance. |
int |
unformat(int ndxFrom,
int ndxTo,
java.lang.String str,
DataElement de)
Verifies that the passed DataElement is an IndexedCollection and calls unformatIndexedCollection(). |
DataElement |
unformat(java.lang.String aString,
DataElement aDataElement)
Verifies that the passed DataElement is an IndexedCollection and calls unformatIndexedCollection(). |
protected int |
unformatIndexedCollection(int ndxFrom,
int ndxTo,
java.lang.String str,
IndexedCollection ic)
Update the IndexedCollection elements by interpreting the formatted string. |
IndexedCollection |
unformatIndexedCollection(java.lang.String aString,
IndexedCollection anIndexedCollection)
Update the IndexedCollection elements by interpreting the formatted string. |
Methods inherited from class com.ibm.btt.base.FormatElement |
---|
checkIndexes, exceptionInfo, externalizer, format, getDataElementName, getExternalizer, getName, getTagName, isCacheable, isConstant, isItConstant, isNull, readExternal, readExternal, readObject, removeExternal, rootDecorated, setDataElementName, setExternalizer, setName, setSize, toString, toTags, unformat, unformat, writeExternal, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public FormatElement element
protected int append
Constructor Detail |
---|
public IndexedCollectionFormat()
public IndexedCollectionFormat(java.lang.String aName) throws java.io.IOException
aName
- java.lang.String
java.io.IOException
Method Detail |
---|
public java.lang.String[] extract(java.lang.String aString) throws DSEInvalidArgumentException
extract
in class FormatElement
aString
- java.lang.String
DSEInvalidArgumentException
public java.lang.String format(DataElement aDataElement) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
format
in class FormatElement
aDataElement
- com.ibm.btt.base.DataElement
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public java.lang.String formatIndexedCollection(IndexedCollection anIndexedCollection) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
anIndexedCollection
- com.ibm.btt.base.IndexedCollection
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public java.lang.String getAppend()
public FormatElement getElement()
public int getTimesRepeat()
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException
initializeFrom
in class FormatElement
aTag
- com.ibm.btt.base.Tag
java.io.IOException
public void reinitialize()
reinitialize
in interface Cacheable
reinitialize
in class FormatElement
public void setAppend(java.lang.String aString)
aString
- java.lang.String - The new value of the propertypublic void setElement(FormatElement aFormatElement)
aFormatElement
- com.ibm.btt.base.FormatElementpublic void setTimesRepeat(int aNumber)
aNumber
- intpublic Vector toStrings()
toStrings
in class FormatElement
public DataElement unformat(java.lang.String aString, DataElement aDataElement) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformat
in class FormatElement
aString
- java.lang.StringaDataElement
- com.ibm.btt.base.DataElement
DSEInvalidRequestException
DSEInvalidArgumentException
public IndexedCollection unformatIndexedCollection(java.lang.String aString, IndexedCollection anIndexedCollection) throws DSEInvalidRequestException, DSEInvalidArgumentException
aString
- java.lang.StringanIndexedCollection
- com.ibm.btt.base.IndexedCollection
DSEInvalidRequestException
DSEInvalidArgumentException
public int unformat(int ndxFrom, int ndxTo, java.lang.String str, DataElement de) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformat
in class FormatElement
ndxFrom
- -
the initial indexndxTo
- -
the final indexstr
- Stringde
- DataElement
DSEInvalidRequestException
DSEInvalidArgumentException
protected int unformatIndexedCollection(int ndxFrom, int ndxTo, java.lang.String str, IndexedCollection ic) throws DSEInvalidRequestException, DSEInvalidArgumentException
ndxFrom
- -
the initial indexndxTo
- -
the final indexstr
- Stringic
- IndexedCollection
DSEInvalidRequestException
DSEInvalidArgumentException
protected boolean goOn(int ndxFrom, int ndxTo, int counter, java.lang.String str)
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |