|
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
@ATTR(value="dataName#String#REQUIRED") public abstract class FormatElement
This is the abstract parent class of the formats.
Field Summary | |
---|---|
java.lang.String |
dataElementName
The name of the formatted data element. |
(package private) static Externalizer |
externalizer
|
java.lang.String |
name
The identifier of the FormatElement instance. |
Constructor Summary | |
---|---|
FormatElement()
|
Method Summary | |
---|---|
protected void |
checkIndexes(int ndxFrom,
int ndxTo,
java.lang.String str)
Check whether the ndxFrom and the ndxTo are valid |
java.lang.String |
exceptionInfo()
Gets the class name. |
Externalizer |
externalizer()
Returns the instance of the externalizer for this class. |
java.lang.String[] |
extract(java.lang.String aString)
Extracts (strips) the substring corresponding to the format element from the input String and returns it and the remaining String as the elements of an array. |
java.lang.String |
format(Context aContext)
Throws an Exception. |
abstract java.lang.String |
format(DataElement aDataElement)
Format abstract class. |
java.lang.String |
getDataElementName()
Returns the value of dataElementName. |
static Externalizer |
getExternalizer()
Gets the Externalizer. |
java.lang.String |
getName()
Returns the value of name. |
java.lang.String |
getTagName()
Gets a tag name. |
abstract java.lang.Object |
initializeFrom(Tag aTag)
Initializes a FormatElement with the Tag attributes. |
boolean |
isCacheable()
This method finds out if THIS particular object can be cached. |
java.lang.Boolean |
isConstant()
Returns false. |
boolean |
isItConstant()
Returns false. |
protected boolean |
isNull(int ndxFrom,
int ndxTo)
Check whether the ndxFrom is equals to the ndxTo |
void |
readExternal()
Initializes a data element with its external value. |
void |
readExternal(java.io.ObjectInput s)
Invokes the object creation from an ObjectInput. |
static java.lang.Object |
readObject(java.lang.String name)
Instantiates a Format called "name" from the definitions file. |
void |
reinitialize()
This method will reinitialize THIS object. |
void |
removeExternal()
Removes the tags for this object from the definitions file. |
FormatElement |
rootDecorated()
Returns this element. |
void |
setDataElementName(java.lang.String aDataElementName)
Sets the value of dataElementName. |
static void |
setExternalizer(Externalizer anExternalizer)
Sets the Externalizer. |
void |
setName(java.lang.String aName)
Returns the value of name. |
void |
setSize(int anInt)
Does nothing. |
java.lang.String |
toString()
Returns a visual representation of this format element. |
Vector |
toStrings()
Returns a visual representation of this format element. |
Vector |
toTags()
Returns a Vector with the FormatElement represented as a Tag. |
int |
unformat(int ndxFrom,
int ndxTo,
java.lang.String str,
Context ctx)
The new unformat methods added to the FormatElement to minimize the instances created during the unfomat process that later will be collected by the garbage collector (GC). |
int |
unformat(int ndxFrom,
int ndxTo,
java.lang.String str,
DataElement de)
The new unformat methods added to the FormatElement to minimize the instances created during the unfomat process that later will be collected by the garbage collector (GC). |
DataElement |
unformat(java.lang.String aString,
Context aContext)
Throws an Exception. |
abstract DataElement |
unformat(java.lang.String aString,
DataElement aDataElement)
Unformat abstract method. |
void |
writeExternal()
Writes this instance converted in tags in a file. |
void |
writeExternal(java.io.ObjectOutput s)
Provides concrete serialization handling for FormatElement. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public java.lang.String dataElementName
public java.lang.String name
static Externalizer externalizer
Constructor Detail |
---|
public FormatElement()
Method Detail |
---|
public java.lang.String exceptionInfo()
public Externalizer externalizer()
public java.lang.String[] extract(java.lang.String aString) throws DSEInvalidArgumentException
aString
- String
DSEInvalidArgumentException
public java.lang.String format(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aContext
- com.ibm.btt.base.Context
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public abstract java.lang.String format(DataElement aDataElement) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aDataElement
- DataElement
DSEInvalidClassException
DSEInvalidRequestException
DSEInvalidArgumentException
public java.lang.String getDataElementName()
public static Externalizer getExternalizer()
public java.lang.String getName()
getName
in interface Cacheable
public java.lang.String getTagName()
public abstract java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException
aTag
- com.ibm.btt.base.Tag
java.io.IOException
DSEException
public boolean isCacheable()
isCacheable
in interface Cacheable
public java.lang.Boolean isConstant()
public boolean isItConstant()
public void readExternal() throws java.io.IOException
java.io.IOException
public void readExternal(java.io.ObjectInput s) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
s
- java.io.ObjectInput
java.io.IOException
java.lang.ClassNotFoundException
public static java.lang.Object readObject(java.lang.String name) throws java.io.IOException
name
- java.lang.String
java.io.IOException
public void reinitialize()
reinitialize
in interface Cacheable
public void removeExternal() throws java.io.IOException
java.io.IOException
public FormatElement rootDecorated()
public void setDataElementName(java.lang.String aDataElementName)
aDataElementName
- java.lang.Stringpublic static void setExternalizer(Externalizer anExternalizer)
anExternalizer
- com.ibm.btt.base.Externalizerpublic void setName(java.lang.String aName)
aName
- java.lang.Stringpublic void setSize(int anInt)
anInt
- intpublic java.lang.String toString()
toString
in class java.lang.Object
public Vector toStrings()
public Vector toTags() throws java.io.IOException
java.io.IOException
public DataElement unformat(java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
aContext
- com.ibm.btt.base.Context
DSEInvalidRequestException
DSEInvalidArgumentException
public abstract DataElement unformat(java.lang.String aString, DataElement aDataElement) throws DSEInvalidRequestException, DSEInvalidArgumentException
DSEInvalidRequestException
DSEInvalidArgumentException
public void writeExternal() throws java.io.IOException
java.io.IOException
public void writeExternal(java.io.ObjectOutput s) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
s
- java.io.ObjectOutput
java.io.IOException
public int unformat(int ndxFrom, int ndxTo, java.lang.String str, DataElement de) throws DSEInvalidRequestException, DSEInvalidArgumentException
ndxFrom
- is the initial indexndxTo
- one is the final index
DSEInvalidRequestException
DSEInvalidArgumentException
public int unformat(int ndxFrom, int ndxTo, java.lang.String str, Context ctx) throws DSEInvalidRequestException, DSEInvalidArgumentException
ndxFrom
- is the initial indexndxTo
- one is the final index
DSEInvalidRequestException
DSEInvalidArgumentException
protected boolean isNull(int ndxFrom, int ndxTo)
ndxFrom
- is the initial indexndxTo
- one is the final indexprotected void checkIndexes(int ndxFrom, int ndxTo, java.lang.String str) throws DSEInvalidArgumentException
ndxFrom
- is the initial indexndxTo
- one is the final index
DSEInvalidArgumentException
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |