IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base.types.impl
Class BasePropertyDescriptor

java.lang.Object
  extended by com.ibm.btt.base.types.AbstractPropertyDescriptor
      extended by com.ibm.btt.base.types.impl.BasePropertyDescriptor
All Implemented Interfaces:
PropertyDescription, TypeConstants, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
SimplePropertyDescriptor

public abstract class BasePropertyDescriptor
extends AbstractPropertyDescriptor

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
BasePropertyDescriptor()
           
BasePropertyDescriptor(java.lang.String name, java.util.Hashtable<?,?> keyValuePairs)
           
BasePropertyDescriptor(java.lang.String name, java.util.Hashtable<?,?> keyValuePairs, java.lang.String typeName)
           
 
Method Summary
 void applyDefaultDescriptorForType(PropertyDescription defaultDescriptor)
          Deprecated. 
abstract  java.lang.Object cloneDescriptee(java.lang.Object arg0)
          Returns an independent copy of the Object passed and is to be implementaed by a Type-specific subclass.
 java.lang.Object convertFrom(java.lang.Object obj)
          Converts an input object into a proper object handled by the default converter.
 java.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType)
          Converts an input object into a proper object handled by the specified converter.
 java.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType, boolean byReference)
          Converts an input object into a proper object handled by the specified converter.
 java.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType, boolean byReference, java.util.Locale locale)
          Converts an input object into a proper object handled by the specified converter.
 java.lang.Object convertFrom(java.lang.Object obj, java.lang.String convType, boolean byReference, java.util.Locale locale, Hashtable parameters)
          Converts an input object into a proper object handled by the specified converter.
 java.lang.Object convertTo(java.lang.Object obj)
          Converts an input object, using the default converter, into a proper object handled by the invoker.
 java.lang.Object convertTo(java.lang.Object obj, java.lang.String convType)
          Converts an input object, using the specified converter, into a proper object handled by the invoker.
 java.lang.Object convertTo(java.lang.Object obj, java.lang.String convType, boolean byReference)
          Converts an input object, using the specified converter, into a proper object handled by the invoker.
 java.lang.Object convertTo(java.lang.Object obj, java.lang.String convType, boolean byReference, java.util.Locale locale)
          Converts an input object, using the specified converter, into a proper object handled by the invoker.
 java.lang.Object convertTo(java.lang.Object obj, java.lang.String convType, boolean byReference, java.util.Locale locale, Hashtable parameters)
          Converts an input object, using the specified converter, into a proper object handled by the invoker.
 java.lang.String formatToString(java.lang.Object value, java.lang.String conversionType)
          Returns the Object formatted as a String using the appropriate conversion type.
 java.lang.String formatToString(java.lang.Object value, java.lang.String conversionType, Hashtable parameters)
          Returns the Object formatted as a String using the appropriate conversion type.
 java.lang.String formatToString(java.lang.Object value, java.lang.String conversionType, java.util.Locale locale)
          Returns the Object formatted as a String using the specified conversion type and the specified locale.
 void formatToWriter(java.lang.Object value, java.lang.String conversionType, java.io.Writer writer)
          Formats the Object using the specified conversion type and writer passed as arguments.
 void formatToWriter(java.lang.Object value, java.lang.String conversionType, java.io.Writer writer, Hashtable parameters)
          Formats the Object using the specified conversion type, the writer, and the Hashtable passed as arguments.
 void formatToWriter(java.lang.Object arg0, java.lang.String arg1, java.io.Writer arg2, java.util.Locale arg3)
          Formats the Object using the conversion type and the locale specified by the writer passed as arguments.
 void formatToWriter(java.lang.Object arg0, java.lang.String arg1, java.io.Writer arg2, java.util.Locale arg3, Hashtable arg4)
          Formats the Object using the conversion type ,the locale, and the Hashtable specified by the writer passed as arguments.
 Conversion getConversion(java.lang.String conversionType)
          Returns the converter that handles the specified conversion type or null if the conversion type is not supported.
protected  Conversion getConverterFromConversionType(java.lang.String arg0)
          Deprecated. 
 java.util.Enumeration<?> getConverters()
          Returns an Enumeration of all converters associated with this PropertyDescriptor.
protected  Conversion getDefaultConverter()
          Returns the converter for the default conversion type.
 java.lang.String getDescription()
          Returns the description of business object that this PropertyDescriptor describes.
 java.lang.Class<?> getImplClass()
          Gets the class of the business object descripted by this PropertyDescription.
 ElementState getInitialState()
          Returns the initial business state of the business object described by this PropertyDescriptor.
 java.lang.Object getInitialValue()
          Returns the initial value of the business object described by this PropertyDescriptor.
 java.lang.String getName()
          Returns the name of this PropertyDescriptor.
 java.util.Hashtable<?,?> getParameters()
          Returns the keyValuePairs hashtable.
 Type getType()
          Returns the Type of business object that this PropertyDescriptor describes.
 Validation getValidator()
          Returns the validator responsible for handling validation of the business object described.
 TypedData initializeInstance(TypedData arg0)
          Initializes the businessObject attributes.
protected  void initializeState(ElementState arg0)
          Initializes the initialState property based on the attributes defined in the key-value pairs.
 void readExternal(java.io.ObjectInput arg0)
          Invokes the object creation from an ObjectInput.
 void setConversion(Conversion converter)
          Convenience method to set the converter to the default converter.
 void setConversion(java.lang.String arg0, Conversion arg1)
          Sets the converter that handles the specified conversion type.
protected  void setInitialState(ElementState iniState)
          Sets the initial business state for the PropertyDescriptor.
protected  void setInitialValue(java.lang.Object value)
          Sets the initial value for the PropertyDescriptor.
 void setName(java.lang.String aName)
          Sets the name attribute.
 void setValidator(Validation validator)
          Sets the validator to be employed by this PropertyDescriptor to that passed.
 java.lang.Object unformatFromReader(java.io.Reader reader, java.lang.String conversionType)
          Uses the passed reader to construct an Object of the correct Type using the appropriate conversion type.
 java.lang.Object unformatFromReader(java.io.Reader reader, java.lang.String conversionType, java.util.Locale locale)
          Uses the reader passed to construct an Object of the correct Type using the specified conversion type and the specified locale.
 java.lang.Object unformatFromReader(java.io.Reader reader, java.lang.String conversionType, java.util.Locale arg2, Hashtable params)
          Uses the reader passed to construct an Object of the correct Type using the specified conversion type and the specified locale.
 java.lang.Object unformatFromString(java.lang.String value, java.lang.String conversionType)
          Converts the String passed to an Object using the appropriate conversion Type.
 java.lang.Object unformatFromString(java.lang.String value, java.lang.String conversionType, Hashtable parameters)
          Converts the String passed to an Object using the appropriate conversion Type.
 java.lang.Object unformatFromString(java.lang.String value, java.lang.String conversionType, java.util.Locale locale)
          Converts the String passed to 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 passed to an Object using the specified conversion Type, the specified locale, and the specified Hashtable.
 java.lang.Object validate(java.lang.Object toValidate)
          Validates the Object by first unformatting and then applying business rules.
 java.lang.Object validate(java.lang.Object toValidate, boolean useState)
          Validates the Object passed by first unformatting and then applying business rules.
 java.lang.Object validate(java.lang.Object toValidate, Hashtable parameters)
          Validates the Object by first unformatting and then applying business rules.
 java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType)
          Validates the Object by first unformatting using the convType conversion and then applying business rules.
 java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType, boolean arg2)
          Validates the Object by first unformatting using the convType conversion and then applying business rules.
 java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType, boolean arg2, Hashtable parameters)
          Validates the Object by first unformatting using the convType conversion and then applying business rules.
 java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType, Hashtable parameters)
          Validates the Object by first unformatting using the convType conversion and then applying business rules.
 void validateParams()
          Validates the parameters externaly defined for this descriptor.
 void validateParams(Hashtable parameters)
          Validates the parameters passed as a Hashtable.
 void writeExternal(java.io.ObjectOutput arg0)
          Provides concrete serialization handling for AbstractPropertyDescriptor.
 
Methods inherited from class com.ibm.btt.base.types.AbstractPropertyDescriptor
applyDefaultDescriptor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasePropertyDescriptor

public BasePropertyDescriptor()

BasePropertyDescriptor

public BasePropertyDescriptor(java.lang.String name,
                              java.util.Hashtable<?,?> keyValuePairs)
                       throws DSETypeException
Throws:
DSETypeException

BasePropertyDescriptor

public BasePropertyDescriptor(java.lang.String name,
                              java.util.Hashtable<?,?> keyValuePairs,
                              java.lang.String typeName)
                       throws DSETypeException
Throws:
DSETypeException
Method Detail

applyDefaultDescriptorForType

@Deprecated
public void applyDefaultDescriptorForType(PropertyDescription defaultDescriptor)
Deprecated. 

Description copied from class: AbstractPropertyDescriptor
Can be overwritten by specific subclasses if an additional behaviour is required.

Overrides:
applyDefaultDescriptorForType in class AbstractPropertyDescriptor

cloneDescriptee

public abstract java.lang.Object cloneDescriptee(java.lang.Object arg0)
                                          throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Returns an independent copy of the Object passed and is to be implementaed by a Type-specific subclass.

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

convertFrom

public java.lang.Object convertFrom(java.lang.Object obj,
                                    java.lang.String convType,
                                    boolean byReference,
                                    java.util.Locale locale,
                                    Hashtable parameters)
                             throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object into a proper object handled by the specified converter. If byReference is set to true, the conversion, if accepted by the converter, is performed by reference.

Specified by:
convertFrom in interface PropertyDescription
Overrides:
convertFrom in class AbstractPropertyDescriptor
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

convertFrom

public java.lang.Object convertFrom(java.lang.Object obj,
                                    java.lang.String convType,
                                    boolean byReference,
                                    java.util.Locale locale)
                             throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object into a proper object handled by the specified converter. If byReference is set to true, the conversion, if accepted by the converter, is performed by reference.

Specified by:
convertFrom in interface PropertyDescription
Overrides:
convertFrom in class AbstractPropertyDescriptor
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

convertFrom

public java.lang.Object convertFrom(java.lang.Object obj,
                                    java.lang.String convType,
                                    boolean byReference)
                             throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object into a proper object handled by the specified converter. If byReference is set to true, the conversion, if accepted by the converter, is performed by reference.

Specified by:
convertFrom in interface PropertyDescription
Overrides:
convertFrom in class AbstractPropertyDescriptor
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

convertFrom

public java.lang.Object convertFrom(java.lang.Object obj,
                                    java.lang.String convType)
                             throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object into a proper object handled by the specified converter.

Specified by:
convertFrom in interface PropertyDescription
Overrides:
convertFrom in class AbstractPropertyDescriptor
Parameters:
obj - java.lang.Object
convType - java.lang.String
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

convertFrom

public java.lang.Object convertFrom(java.lang.Object obj)
                             throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object into a proper object handled by the default converter.

Specified by:
convertFrom in interface PropertyDescription
Overrides:
convertFrom in class AbstractPropertyDescriptor
Parameters:
obj - java.lang.Object
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

convertTo

public java.lang.Object convertTo(java.lang.Object obj,
                                  java.lang.String convType,
                                  boolean byReference,
                                  java.util.Locale locale,
                                  Hashtable parameters)
                           throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object, using the specified converter, into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type will be converter dependant. If byReference is set to true, the conversion, if accepted by the converter, is performed by reference.

Specified by:
convertTo in interface PropertyDescription
Overrides:
convertTo in class AbstractPropertyDescriptor
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

convertTo

public java.lang.Object convertTo(java.lang.Object obj,
                                  java.lang.String convType,
                                  boolean byReference,
                                  java.util.Locale locale)
                           throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object, using the specified converter, into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type will be converter dependant. If byReference is set to true, the conversion, if accepted by the converter, is performed by reference.

Specified by:
convertTo in interface PropertyDescription
Overrides:
convertTo in class AbstractPropertyDescriptor
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

convertTo

public java.lang.Object convertTo(java.lang.Object obj,
                                  java.lang.String convType,
                                  boolean byReference)
                           throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object, using the specified converter, into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type will be converter dependant. If byReference is set to true, the conversion, if accepted by the converter, is performed by reference.

Specified by:
convertTo in interface PropertyDescription
Overrides:
convertTo in class AbstractPropertyDescriptor
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

convertTo

public java.lang.Object convertTo(java.lang.Object obj,
                                  java.lang.String convType)
                           throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object, using the specified converter, into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type will be converter dependant.

Specified by:
convertTo in interface PropertyDescription
Overrides:
convertTo in class AbstractPropertyDescriptor
Parameters:
obj - java.lang.Object
convType - java.lang.String
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

convertTo

public java.lang.Object convertTo(java.lang.Object obj)
                           throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts an input object, using the default converter, into a proper object handled by the invoker. The output object can be used by the invoker for different purposes and its type will be converter dependant.

Specified by:
convertTo in interface PropertyDescription
Overrides:
convertTo in class AbstractPropertyDescriptor
Parameters:
obj - java.lang.Object
Returns:
java.lang.Object
Throws:
DSETypeException - if the conversion type is not supported

formatToString

public java.lang.String formatToString(java.lang.Object value,
                                       java.lang.String conversionType,
                                       Hashtable parameters)
                                throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Returns the Object formatted as a String using the appropriate conversion type.

Specified by:
formatToString in interface PropertyDescription
Overrides:
formatToString in class AbstractPropertyDescriptor
Parameters:
value - Object
conversionType - String
parameters - com.ibm.btt.base.Hashtable
Returns:
String
Throws:
DSETypeException - Formatting is unsuccessful.

formatToString

public java.lang.String formatToString(java.lang.Object value,
                                       java.lang.String conversionType,
                                       java.util.Locale locale)
                                throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Returns the Object formatted as a String using the specified conversion type and the specified locale.

Specified by:
formatToString in interface PropertyDescription
Overrides:
formatToString in class AbstractPropertyDescriptor
Parameters:
value - Object
conversionType - String
locale - Locale
Returns:
String
Throws:
DSETypeException - Formatting is unsuccessful.

formatToString

public java.lang.String formatToString(java.lang.Object value,
                                       java.lang.String conversionType)
                                throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Returns the Object formatted as a String using the appropriate conversion type.

Specified by:
formatToString in interface PropertyDescription
Overrides:
formatToString in class AbstractPropertyDescriptor
Parameters:
value - Object
conversionType - String
Returns:
String
Throws:
DSETypeException - Formatting is unsuccessful.

formatToWriter

public void formatToWriter(java.lang.Object value,
                           java.lang.String conversionType,
                           java.io.Writer writer,
                           Hashtable parameters)
                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Formats the Object using the specified conversion type, the writer, and the Hashtable passed as arguments. If the conversion type is not supported, the default convertion type is used.

Overrides:
formatToWriter in class AbstractPropertyDescriptor
Parameters:
value - Object
conversionType - String
writer - Writer
parameters - com.ibm.btt.base.Hashtable
Throws:
DSETypeException

formatToWriter

public void formatToWriter(java.lang.Object arg0,
                           java.lang.String arg1,
                           java.io.Writer arg2,
                           java.util.Locale arg3,
                           Hashtable arg4)
                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Formats the Object using the conversion type ,the locale, and the Hashtable specified by the writer passed as arguments. If the conversion type is not supported, the default convertion type is used.

Overrides:
formatToWriter in class AbstractPropertyDescriptor
Parameters:
arg0 - Object
arg1 - String
arg2 - Writer
arg3 - Locale
arg4 - com.ibm.btt.base.Hashtable
Throws:
DSETypeException - Formatting is unsuccessful.

formatToWriter

public void formatToWriter(java.lang.Object arg0,
                           java.lang.String arg1,
                           java.io.Writer arg2,
                           java.util.Locale arg3)
                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Formats the Object using the conversion type and the locale specified by the writer passed as arguments. If the conversion type is not supported, the default convertion type is used.

Specified by:
formatToWriter in interface PropertyDescription
Overrides:
formatToWriter in class AbstractPropertyDescriptor
Parameters:
arg0 - Object
arg1 - String
arg2 - Writer
arg3 - Locale
Throws:
DSETypeException - Formatting is unsuccessful.

formatToWriter

public void formatToWriter(java.lang.Object value,
                           java.lang.String conversionType,
                           java.io.Writer writer)
                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Formats the Object using the specified conversion type and writer passed as arguments. If the conversion type is not supported, the default convertion type is used.

Specified by:
formatToWriter in interface PropertyDescription
Overrides:
formatToWriter in class AbstractPropertyDescriptor
Parameters:
value - Object
conversionType - String
writer - Writer
Throws:
DSETypeException - - Formatting is unsuccessful

getConversion

public Conversion getConversion(java.lang.String conversionType)
Description copied from class: AbstractPropertyDescriptor
Returns the converter that handles the specified conversion type or null if the conversion type is not supported.

Specified by:
getConversion in interface PropertyDescription
Overrides:
getConversion in class AbstractPropertyDescriptor
Parameters:
conversionType - String
Returns:
Conversion

getConverterFromConversionType

@Deprecated
protected Conversion getConverterFromConversionType(java.lang.String arg0)
                                             throws DSETypeException
Deprecated. 

Description copied from class: AbstractPropertyDescriptor
Returns the converter for the conversion type passed.

Overrides:
getConverterFromConversionType in class AbstractPropertyDescriptor
Returns:
Conversion
Throws:
DSETypeException - if the requested conversionType is not supported

getConverters

public java.util.Enumeration<?> getConverters()
Description copied from class: AbstractPropertyDescriptor
Returns an Enumeration of all converters associated with this PropertyDescriptor.

Specified by:
getConverters in interface PropertyDescription
Overrides:
getConverters in class AbstractPropertyDescriptor
Returns:
Enumeration

getDefaultConverter

protected Conversion getDefaultConverter()
                                  throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Returns the converter for the default conversion type.

Overrides:
getDefaultConverter in class AbstractPropertyDescriptor
Returns:
Conversion
Throws:
DSETypeException - if the requested conversionType is not supported

getDescription

public java.lang.String getDescription()
Description copied from class: AbstractPropertyDescriptor
Returns the description of business object that this PropertyDescriptor describes.

Specified by:
getDescription in interface PropertyDescription
Overrides:
getDescription in class AbstractPropertyDescriptor
Returns:
String

getImplClass

public java.lang.Class<?> getImplClass()
                                throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Gets the class of the business object descripted by this PropertyDescription. To be overwritten by specific descriptors.

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

getInitialState

public ElementState getInitialState()
Description copied from class: AbstractPropertyDescriptor
Returns the initial business state of the business object described by this PropertyDescriptor.

Specified by:
getInitialState in interface PropertyDescription
Overrides:
getInitialState in class AbstractPropertyDescriptor
Returns:
int

getInitialValue

public java.lang.Object getInitialValue()
Description copied from class: AbstractPropertyDescriptor
Returns the initial value of the business object described by this PropertyDescriptor.

Specified by:
getInitialValue in interface PropertyDescription
Overrides:
getInitialValue in class AbstractPropertyDescriptor
Returns:
Object

getName

public java.lang.String getName()
Description copied from class: AbstractPropertyDescriptor
Returns the name of this PropertyDescriptor.

Specified by:
getName in interface PropertyDescription
Overrides:
getName in class AbstractPropertyDescriptor
Returns:
String

getParameters

public java.util.Hashtable<?,?> getParameters()
Description copied from class: AbstractPropertyDescriptor
Returns the keyValuePairs hashtable.

Specified by:
getParameters in interface PropertyDescription
Overrides:
getParameters in class AbstractPropertyDescriptor
Returns:
java.util.Hashtable

getType

public Type getType()
Description copied from class: AbstractPropertyDescriptor
Returns the Type of business object that this PropertyDescriptor describes.

Specified by:
getType in interface PropertyDescription
Overrides:
getType in class AbstractPropertyDescriptor
Returns:
Type

getValidator

public Validation getValidator()
Description copied from class: AbstractPropertyDescriptor
Returns the validator responsible for handling validation of the business object described.

Specified by:
getValidator in interface PropertyDescription
Overrides:
getValidator in class AbstractPropertyDescriptor
Returns:
Validation

initializeInstance

public TypedData initializeInstance(TypedData arg0)
                             throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Initializes the businessObject attributes.

Specified by:
initializeInstance in interface PropertyDescription
Overrides:
initializeInstance in class AbstractPropertyDescriptor
Parameters:
arg0 - com.ibm.btt.base.TypedData
Returns:
com.ibm.btt.base.TypedData
Throws:
DSETypeException

initializeState

protected void initializeState(ElementState arg0)
Description copied from class: AbstractPropertyDescriptor
Initializes the initialState property based on the attributes defined in the key-value pairs.

Overrides:
initializeState in class AbstractPropertyDescriptor

readExternal

public void readExternal(java.io.ObjectInput arg0)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Description copied from class: AbstractPropertyDescriptor
Invokes the object creation from an ObjectInput.

Specified by:
readExternal in interface java.io.Externalizable
Overrides:
readExternal in class AbstractPropertyDescriptor
Parameters:
arg0 - java.io.ObjectInput
Throws:
java.io.IOException
java.lang.ClassNotFoundException

setConversion

public void setConversion(Conversion converter)
                   throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Convenience method to set the converter to the default converter.

Specified by:
setConversion in interface PropertyDescription
Overrides:
setConversion in class AbstractPropertyDescriptor
Parameters:
converter - Conversion
Throws:
DSETypeException - Conversion type is already supported.

setConversion

public void setConversion(java.lang.String arg0,
                          Conversion arg1)
                   throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Sets the converter that handles the specified conversion type.

Specified by:
setConversion in interface PropertyDescription
Overrides:
setConversion in class AbstractPropertyDescriptor
Parameters:
arg0 - String
arg1 - Conversion
Throws:
DSETypeException - Conversion type is already supported.

setInitialState

protected void setInitialState(ElementState iniState)
Description copied from class: AbstractPropertyDescriptor
Sets the initial business state for the PropertyDescriptor.

Overrides:
setInitialState in class AbstractPropertyDescriptor

setInitialValue

protected void setInitialValue(java.lang.Object value)
Description copied from class: AbstractPropertyDescriptor
Sets the initial value for the PropertyDescriptor.

Overrides:
setInitialValue in class AbstractPropertyDescriptor
Parameters:
value - Object

setName

public void setName(java.lang.String aName)
Description copied from class: AbstractPropertyDescriptor
Sets the name attribute.

Overrides:
setName in class AbstractPropertyDescriptor
Parameters:
aName - java.lang.String

setValidator

public void setValidator(Validation validator)
                  throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Sets the validator to be employed by this PropertyDescriptor to that passed.

Specified by:
setValidator in interface PropertyDescription
Overrides:
setValidator in class AbstractPropertyDescriptor
Parameters:
validator - Validation
Throws:
DSETypeException - Validator cannot validate the business object described.

unformatFromReader

public java.lang.Object unformatFromReader(java.io.Reader reader,
                                           java.lang.String conversionType,
                                           java.util.Locale arg2,
                                           Hashtable params)
                                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Uses the reader passed to construct an Object of the correct Type using the specified conversion type and the specified locale. If conversion type is not supported, the default conversion type is used.

Overrides:
unformatFromReader in class AbstractPropertyDescriptor
Parameters:
reader - Reader
conversionType - String
arg2 - Locale
params - com.ibm.btt.base.Hashtable
Returns:
Object
Throws:
DSETypeException - Unformatting is unsuccessful.

unformatFromReader

public java.lang.Object unformatFromReader(java.io.Reader reader,
                                           java.lang.String conversionType,
                                           java.util.Locale locale)
                                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Uses the reader passed to construct an Object of the correct Type using the specified conversion type and the specified locale. If conversion type is not supported, the default conversion type is used.

Specified by:
unformatFromReader in interface PropertyDescription
Overrides:
unformatFromReader in class AbstractPropertyDescriptor
Parameters:
reader - Reader
conversionType - String
locale - Locale
Returns:
Object
Throws:
DSETypeException - Unformatting is unsuccessful.

unformatFromReader

public java.lang.Object unformatFromReader(java.io.Reader reader,
                                           java.lang.String conversionType)
                                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Uses the passed reader to construct an Object of the correct Type using the appropriate conversion type. If conversion type is not supported, the default conversion type is used. Parameters required by the specific type converter may be taken from the owner descriptor by using the descriptor passed as an argument.

Specified by:
unformatFromReader in interface PropertyDescription
Overrides:
unformatFromReader in class AbstractPropertyDescriptor
Parameters:
reader - Reader
conversionType - String
Returns:
Object
Throws:
DSETypeException - Unformatting is unsuccessful.

unformatFromString

public java.lang.Object unformatFromString(java.lang.String value,
                                           java.lang.String conversionType,
                                           Hashtable parameters)
                                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts the String passed to an Object using the appropriate conversion Type.

Specified by:
unformatFromString in interface PropertyDescription
Overrides:
unformatFromString in class AbstractPropertyDescriptor
Parameters:
value - String
conversionType - String
parameters - com.ibm.btt.base.Hashtable
Returns:
Object
Throws:
DSETypeException - 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
Description copied from class: AbstractPropertyDescriptor
Converts the String passed to an Object using the specified conversion Type, the specified locale, and the specified Hashtable.

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

unformatFromString

public java.lang.Object unformatFromString(java.lang.String value,
                                           java.lang.String conversionType,
                                           java.util.Locale locale)
                                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts the String passed to 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 - Unformatting is unsuccessful.

unformatFromString

public java.lang.Object unformatFromString(java.lang.String value,
                                           java.lang.String conversionType)
                                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Converts the String passed to an Object using the appropriate conversion Type.

Specified by:
unformatFromString in interface PropertyDescription
Overrides:
unformatFromString in class AbstractPropertyDescriptor
Parameters:
value - String
conversionType - String
Returns:
Object
Throws:
DSETypeException - Unformatting is unsuccessful.

validate

public java.lang.Object validate(java.lang.Object toValidate,
                                 boolean useState)
                          throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Validates the Object passed by first unformatting and then applying business rules. If the state boolean is true, the method performs the validation based on the initial state attribute. If successful, this method returns the Object. Otherwise, this method throws the appropriate exception.

Specified by:
validate in interface PropertyDescription
Overrides:
validate in class AbstractPropertyDescriptor
Parameters:
toValidate - Object
useState - boolean
Returns:
Object
Throws:
DSETypeException - Validation is unsuccessful.

validate

public java.lang.Object validate(java.lang.Object toValidate,
                                 Hashtable parameters)
                          throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Validates the Object by first unformatting and then applying business rules. If successful, this method returns the Object. Otherwise, this method throws the appropriate exception.

Specified by:
validate in interface PropertyDescription
Overrides:
validate in class AbstractPropertyDescriptor
Parameters:
toValidate - Object
parameters - com.ibm.btt.base.Hashtable
Returns:
Object
Throws:
DSETypeException - Validation is unsuccessful.

validate

public java.lang.Object validate(java.lang.Object toValidate,
                                 java.lang.String convType,
                                 boolean arg2,
                                 Hashtable parameters)
                          throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Validates the Object by first unformatting using the convType conversion and then applying business rules. If the convType is not supported, the default conversion type is used.If the state boolean is true, the method performs the validation based on the initial state attribute. If successful, this method returns the Object. Otherwise, this method throws the appropriate exception.

Specified by:
validate in interface PropertyDescription
Overrides:
validate in class AbstractPropertyDescriptor
Parameters:
toValidate - Object
convType - String
arg2 - boolean
parameters - com.ibm.btt.base.Hashtable
Returns:
Object
Throws:
DSETypeException - Validation is unsuccessful.

validate

public java.lang.Object validate(java.lang.Object toValidate,
                                 java.lang.String convType,
                                 boolean arg2)
                          throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Validates the Object by first unformatting using the convType conversion and then applying business rules. If the convType is not supported, the default conversion type is used. If the state boolean is true, the method performs the validation based on the initial state attribute. If successful, this method returns the Object. Otherwise, this method throws the appropriate exception.

Specified by:
validate in interface PropertyDescription
Overrides:
validate in class AbstractPropertyDescriptor
Parameters:
toValidate - Object
convType - String
arg2 - boolean
Returns:
Object
Throws:
DSETypeException - Validation is unsuccessful.

validate

public java.lang.Object validate(java.lang.Object toValidate,
                                 java.lang.String convType,
                                 Hashtable parameters)
                          throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Validates the Object by first unformatting using the convType conversion and then applying business rules. If the convType is not supported, the default convType is used. If successful, this method returns the Object. Otherwise, this method throws the appropriate exception.

Specified by:
validate in interface PropertyDescription
Overrides:
validate in class AbstractPropertyDescriptor
Parameters:
toValidate - Object
convType - String
parameters - com.ibm.btt.base.Hashtable
Returns:
Object
Throws:
DSETypeException - Validation is unsuccessful.

validate

public java.lang.Object validate(java.lang.Object toValidate,
                                 java.lang.String convType)
                          throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Validates the Object by first unformatting using the convType conversion and then applying business rules. If the convType is not supported, the default convType is used. If successful, this method returns the Object. Otherwise, this method throws the appropriate exception.

Specified by:
validate in interface PropertyDescription
Overrides:
validate in class AbstractPropertyDescriptor
Parameters:
toValidate - Object
convType - String
Returns:
Object
Throws:
DSETypeException - Validation is unsuccessful.

validate

public java.lang.Object validate(java.lang.Object toValidate)
                          throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Validates the Object by first unformatting and then applying business rules. If successful, this method returns the Object. Otherwise, this method throws the appropriate exception.

Specified by:
validate in interface PropertyDescription
Overrides:
validate in class AbstractPropertyDescriptor
Parameters:
toValidate - Object
Returns:
Object
Throws:
DSETypeException - Validation is unsuccessful.

validateParams

public void validateParams()
                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Validates the parameters externaly defined for this descriptor.

Specified by:
validateParams in interface PropertyDescription
Overrides:
validateParams in class AbstractPropertyDescriptor
Throws:
DSETypeException - Thrown if the parameter validation fails

validateParams

public void validateParams(Hashtable parameters)
                    throws DSETypeException
Description copied from class: AbstractPropertyDescriptor
Validates the parameters passed as a Hashtable.

Specified by:
validateParams in interface PropertyDescription
Overrides:
validateParams in class AbstractPropertyDescriptor
Parameters:
parameters - com.ibm.btt.base.Hashtable
Throws:
DSETypeException - - Thrown if the parameter validation fails

writeExternal

public void writeExternal(java.io.ObjectOutput arg0)
                   throws java.io.IOException
Description copied from class: AbstractPropertyDescriptor
Provides concrete serialization handling for AbstractPropertyDescriptor.

Specified by:
writeExternal in interface java.io.Externalizable
Overrides:
writeExternal in class AbstractPropertyDescriptor
Parameters:
arg0 - java.io.ObjectOutput
Throws:
java.io.IOException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011