IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.services.jxfs.ptr
Class JxfsFieldLabel

java.lang.Object
  extended bycom.ibm.dse.base.FormatElement
      extended bycom.ibm.dse.base.FormatDecorator
          extended bycom.ibm.dse.services.jxfs.ptr.JxfsFieldLabel
All Implemented Interfaces:
Cacheable, Externalizable, java.io.Externalizable, java.io.Serializable

public class JxfsFieldLabel
extends FormatDecorator

This class implements a format decorator to manage naming of forms fields

See Also:
Serialized Form

Field Summary
(package private)  java.lang.String value
          The desired name value for the form field
 
Fields inherited from class com.ibm.dse.base.FormatDecorator
decorated
 
Fields inherited from class com.ibm.dse.base.FormatElement
dataElementName, name
 
Constructor Summary
JxfsFieldLabel()
          This constructor creates a JxfsFieldLabel object.
JxfsFieldLabel(java.lang.String aName)
          This constructor creates the JxfsFieldLabel object with the id aName.
 
Method Summary
 java.lang.String addDecoration(java.lang.String aString)
          Adds decoration
 java.lang.String getValue()
          Gets the value of the value attribute
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a JxfsFieldLabel with the Tag attributes.
 java.lang.String removeDecoration(java.lang.String aString)
          Removes decoration
 void setValue(java.lang.String aString)
          Sets the value of the value attribute
 Vector toStrings()
          Returns a vector of attributes as strings
 
Methods inherited from class com.ibm.dse.base.FormatDecorator
extract, format, format, getDataElementName, getDecorated, getName, isConstant, isItConstant, reinitialize, rootDecorated, rootDecorator, setDecorated, toString, unformat, unformat
 
Methods inherited from class com.ibm.dse.base.FormatElement
exceptionInfo, externalizer, format, getExternalizer, getTagName, isCacheable, readExternal, readExternal, readObject, 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
 

Field Detail

value

java.lang.String value
The desired name value for the form field

Constructor Detail

JxfsFieldLabel

public JxfsFieldLabel()
This constructor creates a JxfsFieldLabel object.


JxfsFieldLabel

public JxfsFieldLabel(java.lang.String aName)
               throws java.io.IOException
This constructor creates the JxfsFieldLabel object with the id aName.

Parameters:
aName - java.lang.String - Object name
Throws:
java.io.IOException - The object cannot be created.
Method Detail

addDecoration

public java.lang.String addDecoration(java.lang.String aString)
                               throws DSEInvalidArgumentException
Adds decoration

Specified by:
addDecoration in class FormatDecorator
Parameters:
aString - java.lang.String - the string to decorate
Returns:
java.lang.String - The decorated string
Throws:
DSEInvalidArgumentException - Invalid argument, decoration not added

getValue

public java.lang.String getValue()
Gets the value of the value attribute

Returns:
java.lang.String - The current value of value.

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
Initializes a JxfsFieldLabel with the Tag attributes.

Specified by:
initializeFrom in interface Externalizable
Specified by:
initializeFrom in class FormatElement
Parameters:
aTag - com.ibm.dse.base.Tag - Contains the name and attributes of the object to be created.
Returns:
java.lang.Object

removeDecoration

public java.lang.String removeDecoration(java.lang.String aString)
                                  throws DSEInvalidArgumentException
Removes decoration

Specified by:
removeDecoration in class FormatDecorator
Parameters:
aString - java.lang.String - the string to which remove decoration
Returns:
java.lang.String - The string without decorator
Throws:
DSEInvalidArgumentException - Invalid argument, decoration not removed

setValue

public void setValue(java.lang.String aString)
Sets the value of the value attribute

Parameters:
aString - java.lang.String, The new value for the attribute

toStrings

public Vector toStrings()
Returns a vector of attributes as strings

Specified by:
toStrings in interface Externalizable
Specified by:
toStrings in class FormatDecorator
Returns:
Vector - a vector of Strings

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005