|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.DataElement
@ATTR(value={"id#String#REQUIRED","description#String#IMPLIED"}) public abstract class DataElement
The DataElement class is the abstract base class to represent data.
Field Summary | |
---|---|
protected java.lang.String |
description
|
(package private) static Externalizer |
externalizer
|
protected java.lang.String |
name
|
protected Hashtable |
parameters
|
protected ElementState |
state
|
Constructor Summary | |
---|---|
DataElement()
|
Method Summary | |
---|---|
java.lang.Object |
clone()
This method must be implemented by the subclasses. |
Externalizer |
externalizer()
Returns the externalizer instance of this class. |
java.lang.String |
getCompositeKey()
Returns the compositeKey. |
java.lang.String |
getDescription()
Returns the description of the data. |
PropertyDescription |
getDescriptor()
Returns the PropertyDescriptor for this business object. |
DataElement |
getElementAt(java.lang.String aName)
Throws an exception. |
ErrorInfo |
getErrorInfo()
Returns the errorInfo property. |
static Externalizer |
getExternalizer()
Gets the externalizer. |
Key |
getKey()
Returns a Key object which can be used to identify this business object. |
java.lang.String |
getName()
Gets the name property (java.lang.String) value. |
java.lang.Object |
getParameter(java.lang.String parameterName)
Returns the value of the element in the hashtable of parameters. |
Hashtable |
getParameters()
Returns the Hashtable of parameters for this business object. |
ElementState |
getState()
Gets the state property. |
java.lang.String |
getTagName()
Gets a tag name. |
abstract java.lang.Object |
getValue()
Returns the value of the data element. |
boolean |
isAmended()
Returns true if the amended flag is activated and false otherwise. |
boolean |
isCached()
Returns the isCached. |
boolean |
isSerializable()
|
abstract Vector |
nestedElements()
Returns all the DataElements included in a collection at any level. |
abstract void |
nestedElements(java.util.Hashtable theTable)
Returns all the DataElements included in this collection at any level. |
abstract Vector |
nestedFields()
Returns all the DataFields at any level included in a collection. |
void |
readExternal()
Initializes a DataElement with its external value. |
void |
readExternal(java.io.ObjectInput s)
Invokes the object creation from an ObjectInput. |
static java.lang.Object |
readObject(java.lang.String name)
Instantiates a DataElement named name from the definition file. |
DataElement |
removeElementAt(java.lang.String aName)
Throws an exception. |
void |
removeExternal()
Removes the tags for this object from the definition file in which it is externalized. |
void |
setAmended(boolean aValue)
Sets the amended flag to aValue. |
void |
setCompositeKey(java.lang.String aCompositeKey)
Sets the compositeKey. |
void |
setDescription(java.lang.String aDescription)
Sets the value of description. |
void |
setDescriptor(PropertyDescription descriptor)
Sets the PropertyDescriptor for this business object to that passed. |
void |
setErrorInfo(ErrorInfo anErrorInfo)
Sets the errorInfo attribute. |
static void |
setExternalizer(Externalizer anExternalizer)
Sets the externalizer. |
void |
setIsCached(boolean cached)
Sets the isCached. |
void |
setName(java.lang.String aName)
Sets the name property (java.lang.String) value. |
void |
setParameter(java.lang.String parameterName,
java.lang.Object parameterValue)
Sets the value of the element in the Hashtable of paramaters. |
void |
setParameters(Hashtable theParameters)
Sets the Hashtable of paramaters for this business object. |
void |
setSerializable(boolean b)
|
void |
setState(ElementState aState)
Sets the state property. |
abstract void |
setValue(java.lang.Object aValue)
Throws an exception. |
Vector |
toStrings()
Returns a visual representation of this data element. |
Vector |
toTags()
Returns a Vector with the DataElement represented as a Tag. |
DataElement |
tryGetElementAt(java.lang.String aName)
Returns null. |
java.lang.Object |
validate(java.lang.Object toValidate)
Validates the object using its property descriptor. |
abstract java.lang.Object |
validate(java.lang.Object toValidate,
java.lang.String convType)
This method must be implemented by the subclasses. |
java.lang.Object |
validateObject(java.lang.Object toValidate)
Validates an object using its validator directly without conversion. |
void |
writeExternal()
Converts the instance into tags and writes the tags into a file. |
void |
writeExternal(java.io.ObjectOutput s)
Provides concrete serialization handling for DataElement. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.btt.base.Externalizable |
---|
initializeFrom |
Field Detail |
---|
protected java.lang.String name
protected java.lang.String description
static Externalizer externalizer
protected ElementState state
protected Hashtable parameters
Constructor Detail |
---|
public DataElement()
Method Detail |
---|
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in interface DSECloneable
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
- - if a problem occurs trying to clone the objectpublic Externalizer externalizer() throws java.io.IOException
java.io.IOException
public java.lang.String getDescription()
public PropertyDescription getDescriptor()
getDescriptor
in interface TypedData
public DataElement getElementAt(java.lang.String aName) throws DSEObjectNotFoundException
aName
- java.lang.String
DSEObjectNotFoundException
public ErrorInfo getErrorInfo()
public static Externalizer getExternalizer() throws java.io.IOException
java.io.IOException
public Key getKey() throws DSETypeException
getKey
in interface TypedData
DSETypeExceotion
- - If key can not be build from this business object
DSETypeException
- - If the key can not be built from this business objectpublic java.lang.String getName()
getName
in interface TypedData
setName(java.lang.String)
public java.lang.Object getParameter(java.lang.String parameterName)
parameterName
- String
public Hashtable getParameters()
public ElementState getState()
public java.lang.String getTagName()
public abstract java.lang.Object getValue()
public boolean isAmended()
public abstract Vector nestedElements()
public abstract void nestedElements(java.util.Hashtable theTable)
public abstract Vector nestedFields()
public void readExternal() throws java.io.IOException
java.io.IOException
public void readExternal(java.io.ObjectInput s) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
s
- java.io.ObjectInput
java.io.IOException
java.lang.ClassNotFoundException
public static java.lang.Object readObject(java.lang.String name) throws java.io.IOException
java.io.IOException
public DataElement removeElementAt(java.lang.String aName) throws DSEObjectNotFoundException
aName
- java.lang.String
DSEObjectNotFoundException
public void removeExternal() throws java.io.IOException
java.io.IOException
public void setAmended(boolean aValue)
aValue
- booleanpublic void setDescription(java.lang.String aDescription)
aDescription
- java.lang.Stringpublic void setDescriptor(PropertyDescription descriptor)
setDescriptor
in interface TypedData
descriptor
- PropertyDescriptionpublic void setErrorInfo(ErrorInfo anErrorInfo)
public static void setExternalizer(Externalizer anExternalizer)
anExternalizer
- com.ibm.btt.base.Externalizerpublic void setName(java.lang.String aName)
setName
in interface TypedData
aName
- java.lang.Stringpublic void setParameter(java.lang.String parameterName, java.lang.Object parameterValue)
parameterName
- StringparameterValue
- Objectpublic void setParameters(Hashtable theParameters)
public void setState(ElementState aState)
aState
- com.ibm.btt.base.types.ElementStatepublic abstract void setValue(java.lang.Object aValue) throws DSEInvalidArgumentException
aValue
- java.lang.Object
DSEInvalidArgumentException
public Vector toStrings()
public Vector toTags() throws java.io.IOException
java.io.IOException
public DataElement tryGetElementAt(java.lang.String aName)
aName
- java.lang.Stringpublic java.lang.Object validate(java.lang.Object toValidate) throws DSETypeException
DSETypeException
- - If the object has not been successfully validatedpublic abstract java.lang.Object validate(java.lang.Object toValidate, java.lang.String convType) throws DSETypeException
toValidate
- java.lang.StringconvType
- java.lang.String
DSETypeException
public java.lang.Object validateObject(java.lang.Object toValidate) throws DSETypeException
DSETypeException
- - If the object has not been successfully validatedpublic void writeExternal() throws java.io.IOException
java.io.IOException
public void writeExternal(java.io.ObjectOutput s) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
s
- java.io.ObjectOutput
java.io.IOException
public boolean isCached()
public void setIsCached(boolean cached)
public java.lang.String getCompositeKey()
public void setCompositeKey(java.lang.String aCompositeKey)
public boolean isSerializable()
public void setSerializable(boolean b)
b
-
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |