|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.base.FormatElement
This is the abstract parent class of the formats.
Field Summary | |
java.lang.String |
dataElementName
|
java.lang.String |
name
|
Constructor Summary | |
FormatElement()
|
Method Summary | |
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 |
format(Operation anOperation)
Formats the context of this operation. |
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. |
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. |
DataElement |
unformat(java.lang.String aString,
Context aContext)
Throws an Exception. |
abstract DataElement |
unformat(java.lang.String aString,
DataElement aDataElement)
Unformat abstract method. |
DataElement |
unformat(java.lang.String aString,
Operation anOperation)
Unformats the context of this operation. |
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
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
String
- aStringpublic java.lang.String format(Context aContext) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aContext
- com.ibm.dse.base.Contextpublic abstract java.lang.String format(DataElement aDataElement) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
aDataElement
- DataElementpublic java.lang.String format(Operation anOperation) throws DSEInvalidClassException, DSEInvalidRequestException, DSEInvalidArgumentException
anOperation
- com.ibm.dse.base.Operationpublic java.lang.String getDataElementName()
public static Externalizer getExternalizer()
public java.lang.String getName()
public java.lang.String getTagName()
public abstract java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException, DSEException
aTag
- com.ibm.dse.base.Tagpublic boolean isCacheable()
public java.lang.Boolean isConstant()
public void readExternal() throws java.io.IOException
public void readExternal(java.io.ObjectInput s) throws java.io.IOException, java.lang.ClassNotFoundException
s
- java.io.ObjectInputpublic static java.lang.Object readObject(java.lang.String name) throws java.io.IOException
name
- java.lang.Stringpublic void reinitialize()
public void removeExternal() throws 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.dse.base.Externalizerpublic void setName(java.lang.String aName)
aName
- java.lang.Stringpublic void setSize(int anInt)
anInt
- intpublic java.lang.String toString()
public Vector toStrings()
public Vector toTags() throws java.io.IOException
public DataElement unformat(java.lang.String aString, Context aContext) throws DSEInvalidRequestException, DSEInvalidArgumentException
aContext
- com.ibm.dse.base.Contextpublic abstract DataElement unformat(java.lang.String aString, DataElement aDataElement) throws DSEInvalidRequestException, DSEInvalidArgumentException
public DataElement unformat(java.lang.String aString, Operation anOperation) throws DSEInvalidRequestException, DSEInvalidArgumentException
aString
- java.lang.StringanOperation
- com.ibm.dse.base.Operationpublic void writeExternal() throws java.io.IOException
public void writeExternal(java.io.ObjectOutput s) throws java.io.IOException
s
- java.io.ObjectOutput
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |