com.ibm.dse.base
Class Identifier
java.lang.Object
|
+--com.ibm.dse.base.FormatElement
|
+--com.ibm.dse.base.FormatDecorator
|
+--com.ibm.dse.base.Identifier
- public class Identifier
- extends FormatDecorator
This decorator prepends a character to the string
that identifies the data in the receiver.
- See Also:
- Serialized Form
Field Summary |
char |
id
|
static java.lang.String |
idSet
|
Constructor Summary |
Identifier()
This is the default constructor used to create an Identifier object. |
Identifier(java.lang.String aName)
This is the constructor used by the Externalizer to create an Identifier object. |
Method Summary |
java.lang.String |
addDecoration(java.lang.String aString)
Prepends the ID character to the String. |
java.lang.String[] |
extract(java.lang.String aString)
Extracts the String up to the next occurrence of any identifier included in the idSet attribute. |
char |
getId()
Returns the value of id. |
static java.lang.String |
getIdSet()
Returns the value of the idSet attribute. |
java.lang.Object |
initializeFrom(Tag aTag)
Initializes an Identifier with the aTag attributes. |
java.lang.String |
removeDecoration(java.lang.String aString)
Removes the id character from the beginning of the string. |
void |
setId(char anId)
Sets the value of id. |
static void |
setIdSet(java.lang.String aString)
Sets the value of idSet. |
Vector |
toStrings()
Returns a visual representation of this decorator. |
Methods inherited from class com.ibm.dse.base.FormatDecorator |
format,
format,
getDataElementName,
getDecorated,
getName,
isConstant,
rootDecorated,
rootDecorator,
setDecorated,
toString,
unformat,
unformat |
Methods inherited from class com.ibm.dse.base.FormatElement |
exceptionInfo,
externalizer,
format,
getExternalizer,
getTagName,
isCacheable,
readExternal,
readExternal,
readObject,
reinitialize,
removeExternal,
setDataElementName,
setExternalizer,
setName,
setSize,
toTags,
unformat,
writeExternal,
writeExternal |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
id
public char id
idSet
public static java.lang.String idSet
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
addDecoration
public java.lang.String addDecoration(java.lang.String aString)
- Prepends the ID character to the String.
- Overrides:
- 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[]
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.
- Overrides:
- initializeFrom in class FormatElement
- Parameters:
aTag
- com.ibm.dse.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.
- Overrides:
- removeDecoration in class FormatDecorator
- Tags copied from class: FormatDecorator
- Parameters:
aString
- String- Returns:
- java.lang.String
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.
- Overrides:
- toStrings in class FormatDecorator
- Returns:
- Vector