java.lang.String |
addDecoration(java.lang.String aString)
Methods inherited from class com.ibm.btt.base.FormatDecorator |
format, format, getDataElementName, getDecorated, getName, isConstant, isItConstant, reinitialize, rootDecorated, rootDecorator, setDecorated, toString, unformat, unformat |
Methods inherited from class com.ibm.btt.base.FormatElement |
checkIndexes, exceptionInfo, externalizer, getExternalizer, getTagName, isCacheable, isNull, 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 |
id
public char id
- The character used as the identifier.
idSet
public static java.lang.String idSet
- The string contains characters used as the identifier.
Identifier
public Identifier()
- This is the default constructor used to create an Identifier object.
Identifier
public Identifier(java.lang.String aName)
throws java.io.IOException
- This is the constructor used by the Externalizer to create an Identifier
object.
- Parameters:
aName - java.lang.String
- Throws:
java.io.IOException
addDecoration
public java.lang.String addDecoration(java.lang.String aString)
- Prepends the ID character to the String.
- Specified by:
addDecoration in class FormatDecorator
extract
public java.lang.String[] extract(java.lang.String aString)
throws DSEInvalidArgumentException
- Extracts the String up to the next occurrence of any identifier included
in the idSet attribute.
- Overrides:
extract in class FormatDecorator
- Parameters:
aString - String
- Returns:
- String[]
- Throws:
DSEInvalidArgumentException
getId
public char getId()
- Returns the value of id.
- Returns:
- char
getIdSet
public static java.lang.String getIdSet()
- Returns the value of the idSet attribute.
- Returns:
- java.lang.String
initializeFrom
public java.lang.Object initializeFrom(Tag aTag)
- Initializes an Identifier with the aTag attributes.
- Specified by:
initializeFrom in class FormatElement
- Parameters:
aTag - com.ibm.btt.base.Tag
- Returns:
- java.lang.Object
removeDecoration
public java.lang.String removeDecoration(java.lang.String aString)
throws DSEInvalidArgumentException
- Removes the id character from the beginning of the string.
- Specified by:
removeDecoration in class FormatDecorator
- Parameters:
aString - String
- Returns:
- java.lang.String
- Throws:
DSEInvalidArgumentException
setId
public void setId(char anId)
- Sets the value of id.
- Parameters:
anId - char
setIdSet
public static void setIdSet(java.lang.String aString)
- Sets the value of idSet.
- Parameters:
aString - java.lang.String
toStrings
public Vector toStrings()
- Returns a visual representation of this decorator.
- Specified by:
toStrings in class FormatDecorator
- Returns:
- Vector
unformat
public int unformat(int ndxFrom,
int ndxTo,
java.lang.String str,
Context ctx)
throws DSEInvalidRequestException,
DSEInvalidArgumentException
- Unformat strings that between ndxFrom and ndxTo into the Context.
- Overrides:
unformat in class FormatElement
- Parameters:
str - java.lang.StringndxFrom - intndxTo - intctx - com.ibm.btt.base.Context;
- Returns:
- int
- Throws:
DSEInvalidRequestException
DSEInvalidArgumentException
unformat
public int unformat(int ndxFrom,
int ndxTo,
java.lang.String str,
DataElement de)
throws DSEInvalidRequestException,
DSEInvalidArgumentException
- Unformat strings that between ndxFrom and ndxTo into the DataElement.
- Overrides:
unformat in class FormatElement
- Parameters:
str - java.lang.StringndxFrom - intndxTo - intde - com.ibm.btt.base.DataElement;
- Returns:
- int
- Throws:
DSEInvalidRequestException
DSEInvalidArgumentException
(c) Copyright IBM Corporation 1998, 2009
|