|
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.btt.base.FormatElement
com.ibm.btt.base.FormatDecorator
This is the parent abstact class of the decorators. Decorators represent an additional process to be applied to a formatted String, independent of which concrete format element has created it.
Field Summary | |
---|---|
FormatElement |
decorated
|
Fields inherited from class com.ibm.btt.base.FormatElement |
---|
dataElementName, externalizer, name |
Constructor Summary | |
---|---|
FormatDecorator()
|
Method Summary | |
---|---|
abstract java.lang.String |
addDecoration(java.lang.String aString)
AddDecoration abstract method. |
java.lang.String[] |
extract(java.lang.String aString)
Overrides the extract() method of FormatElement to redirect the extract() method to the decorated String. |
java.lang.String |
format(Context aContext)
Calls the addDecoration() method and passing to it the String requiring the decoration operation. |
java.lang.String |
format(DataElement aDataElement)
Calls the addDecoration() method and passing to it the String requiring the decoration operation. |
java.lang.String |
getDataElementName()
Returns the dataElementName of the decorated String. |
FormatElement |
getDecorated()
Returns the decorated FormatElement. |
java.lang.String |
getName()
Returns the value of name. |
java.lang.Boolean |
isConstant()
Returns true if the String is a constant formatted String. |
boolean |
isItConstant()
Returns true if the String is a constant formatted String. |
void |
reinitialize()
This method will call reinitialize of the decorated element. |
abstract java.lang.String |
removeDecoration(java.lang.String aString)
RemoveDecoration abstract method. |
FormatElement |
rootDecorated()
Returns the FormatElement decorated using this decorator even if other decorators exist. |
FormatDecorator |
rootDecorator()
Returns the decorator that is currently formatting the FormatElement. |
void |
setDecorated(FormatElement aFormatElement)
Sets the value of decorated. |
java.lang.String |
toString()
Returns a visual representation of this decorator. |
abstract Vector |
toStrings()
Returns a Vector containing a visual representation of the format. |
DataElement |
unformat(java.lang.String aString,
Context aContext)
Calls the removeDecoration() method and then unformats the String. |
DataElement |
unformat(java.lang.String aString,
DataElement aDataElement)
Calls the removeDecoration() method and then unformats the String. |
Methods inherited from class com.ibm.btt.base.FormatElement |
---|
exceptionInfo, externalizer, getExternalizer, getTagName, initializeFrom, isCacheable, readExternal, readExternal, readObject, removeExternal, setDataElementName, setExternalizer, setName, setSize, toTags, writeExternal, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public FormatElement decorated
Constructor Detail |
public FormatDecorator()
Method Detail |
public abstract java.lang.String addDecoration(java.lang.String aString) throws DSEInvalidArgumentException
DSEInvalidArgumentException
public java.lang.String[] extract(java.lang.String aString) throws DSEInvalidArgumentException
extract
in class FormatElement
aString
- String
DSEInvalidArgumentException
public java.lang.String format(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
format
in class FormatElement
aContext
- com.ibm.btt.base.Context
DSEInvalidClassException
DSEInvalidRequestException
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 getDataElementName()
getDataElementName
in class FormatElement
public FormatElement getDecorated()
public java.lang.String getName()
getName
in interface Externalizable
getName
in class FormatElement
public java.lang.Boolean isConstant()
isConstant
in class FormatElement
public boolean isItConstant()
isItConstant
in class FormatElement
public void reinitialize()
reinitialize
in interface Cacheable
reinitialize
in class FormatElement
public abstract java.lang.String removeDecoration(java.lang.String aString) throws DSEInvalidArgumentException
aString
- String
DSEInvalidArgumentException
public FormatElement rootDecorated()
rootDecorated
in class FormatElement
public FormatDecorator rootDecorator()
public void setDecorated(FormatElement aFormatElement)
aFormatElement
- FormatElementpublic java.lang.String toString()
toString
in class FormatElement
public abstract Vector toStrings()
toStrings
in interface Externalizable
toStrings
in class FormatElement
public DataElement unformat(java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
unformat
in class FormatElement
aString
- java.lang.StringaContext
- com.ibm.btt.base.Context
DSEInvalidRequestException
DSEInvalidArgumentException
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
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |