IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base.types.ext
Class StringPropertyDescriptor

java.lang.Object
  extended by com.ibm.btt.base.types.AbstractPropertyDescriptor
      extended by com.ibm.btt.base.types.ext.StringPropertyDescriptor
All Implemented Interfaces:
PropertyDescription, TypeConstants, java.io.Externalizable, java.io.Serializable

public class StringPropertyDescriptor
extends AbstractPropertyDescriptor

PropertyDescriptor for business objects of the String type.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.btt.base.types.AbstractPropertyDescriptor
classNameForState, converters, keyValuePairs
 
Fields inherited from interface com.ibm.btt.base.types.TypeConstants
amended, CONV_TYPE_DEFAULT, CONV_TYPE_HOST, CONV_TYPE_OUTPUT, CONV_TYPE_SER, CONV_TYPE_XML, disabled, hidden, isAmended, isDisabled, isHidden, isMandatory, isOmitted, isReadOnly, mandatory, omitted, readOnly, TYPE_DEFAULT, TYPE_REGISTRY_INIT_SIZE
 
Constructor Summary
StringPropertyDescriptor()
          This constructor creates a StringPropertyDescriptor object.
StringPropertyDescriptor(java.lang.String name, java.util.Hashtable keyValuePairs)
          Creates a PropertyDescriptor for business objects of the String type.
StringPropertyDescriptor(java.lang.String name, java.util.Hashtable keyValuePairs, java.lang.String typeName)
          Creates a PropertyDescriptor for business objects of the String type.
 
Method Summary
 void applyDefaultDescriptorForType(PropertyDescription defaultDescriptor)
          Forces this PropertyDescriptor to inherit the business rules of the passed descriptor.
 java.lang.Object cloneDescriptee(java.lang.Object value)
          Returns an independent copy of the Object passed.
 java.lang.Class getImplClass()
          Returns the class of the business object described by this PropertyDescription.
 java.lang.Object unformatFromString(java.lang.String value, java.lang.String conversionType, java.util.Locale locale)
          Converts the String into an Object using the specified conversion type and the specified locale.
 java.lang.Object unformatFromString(java.lang.String value, java.lang.String conversionType, java.util.Locale locale, Hashtable parameters)
          Converts the String into an Object using the specified conversion type and the specified locale.
 
Methods inherited from class com.ibm.btt.base.types.AbstractPropertyDescriptor
applyDefaultDescriptor, convertFrom, convertFrom, convertFrom, convertFrom, convertFrom, convertTo, convertTo, convertTo, convertTo, convertTo, formatToString, formatToString, formatToString, formatToWriter, formatToWriter, formatToWriter, formatToWriter, getConversion, getConverterFromConversionType, getConverters, getDefaultConverter, getDescription, getInitialState, getInitialValue, getName, getParameters, getType, getValidator, initializeInstance, initializeState, readExternal, setConversion, setConversion, setInitialState, setInitialValue, setName, setValidator, unformatFromReader, unformatFromReader, unformatFromReader, unformatFromString, unformatFromString, validate, validate, validate, validate, validate, validate, validate, validateParams, validateParams, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringPropertyDescriptor

public StringPropertyDescriptor()
This constructor creates a StringPropertyDescriptor object.


StringPropertyDescriptor

public StringPropertyDescriptor(java.lang.String name,
                                java.util.Hashtable keyValuePairs)
                         throws DSETypeException
Creates a PropertyDescriptor for business objects of the String type.

Parameters:
name - String
Throws:
DSETypeException

StringPropertyDescriptor

public StringPropertyDescriptor(java.lang.String name,
                                java.util.Hashtable keyValuePairs,
                                java.lang.String typeName)
                         throws DSETypeException
Creates a PropertyDescriptor for business objects of the String type.

Throws:
DSETypeException
Method Detail

applyDefaultDescriptorForType

public void applyDefaultDescriptorForType(PropertyDescription defaultDescriptor)
Forces this PropertyDescriptor to inherit the business rules of the passed descriptor. Any defined specific business behavior is retained and overrides that of the descriptor passed.

Overrides:
applyDefaultDescriptorForType in class AbstractPropertyDescriptor

cloneDescriptee

public java.lang.Object cloneDescriptee(java.lang.Object value)
                                 throws DSETypeException
Returns an independent copy of the Object passed.

Specified by:
cloneDescriptee in interface PropertyDescription
Specified by:
cloneDescriptee in class AbstractPropertyDescriptor
Parameters:
value - Object
Returns:
Object
Throws:
DSETypeException - - Cloning is unsuccessful

getImplClass

public java.lang.Class getImplClass()
                             throws DSETypeException
Returns the class of the business object described by this PropertyDescription.

Specified by:
getImplClass in interface PropertyDescription
Overrides:
getImplClass in class AbstractPropertyDescriptor
Returns:
java.lang.Class
Throws:
DSETypeException

unformatFromString

public java.lang.Object unformatFromString(java.lang.String value,
                                           java.lang.String conversionType,
                                           java.util.Locale locale)
                                    throws DSETypeException
Converts the String into an Object using the specified conversion type and the specified locale.

Specified by:
unformatFromString in interface PropertyDescription
Overrides:
unformatFromString in class AbstractPropertyDescriptor
Parameters:
value - String
conversionType - String
locale - Locale
Returns:
Object
Throws:
DSETypeException - - If unformatting is unsuccessful

unformatFromString

public java.lang.Object unformatFromString(java.lang.String value,
                                           java.lang.String conversionType,
                                           java.util.Locale locale,
                                           Hashtable parameters)
                                    throws DSETypeException
Converts the String into an Object using the specified conversion type and the specified locale.

Overrides:
unformatFromString in class AbstractPropertyDescriptor
Parameters:
value - String
conversionType - String
locale - Locale
parameters - com.ibm.btt.base.Hashtable
Returns:
Object
Throws:
DSETypeException - - If unformatting is unsuccessful

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009