IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base
Class DataPointer

java.lang.Object
  extended by com.ibm.btt.base.Pointer
      extended by com.ibm.btt.base.DataPointer
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable

@ATTR(value={"dataName#String#REQUIRED","context#String#REQUIRED"})
public class DataPointer
extends Pointer

The DataPointer class represents a Pointer to a DataElement. A DataPointer is a reference to a DataElement. You must specify the dataName and contextName of the pointed data.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.btt.base.Pointer
externalizer, propertyChange
 
Constructor Summary
DataPointer()
          This constructor creates the DataPointer object.
 
Method Summary
 java.lang.String getContextName()
          Gets the contextName property (java.lang.String) value.
 DataElement getDataElement(Context context)
          Returns the pointed DataElement.
 java.lang.String getDataName()
          Gets the dataName property (java.lang.String) value.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a DataPointer with the aTag attributes.
 void setContextName(java.lang.String aContextName)
          Sets the contextName property (java.lang.String) value.
 void setDataName(java.lang.String aString)
          Sets the dataName property (java.lang.String) value.
 java.lang.String toString()
          Returns a visual representation of the DataField.
 
Methods inherited from class com.ibm.btt.base.Pointer
externalizer, getExternalizer, getName, getTagName, readExternal, readExternal, readObject, removeExternal, setExternalizer, setName, toStrings, toTags, writeExternal, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataPointer

public DataPointer()
This constructor creates the DataPointer object.

Method Detail

getContextName

public java.lang.String getContextName()
Gets the contextName property (java.lang.String) value.

Returns:
String
See Also:
setContextName(java.lang.String)

getDataElement

public DataElement getDataElement(Context context)
                           throws DSEInvalidRequestException
Returns the pointed DataElement. If the DataElement doesn't exist, it throws a DSEInvalidRequestException.

Parameters:
context - com.ibm.btt.base.Context
Returns:
DataElement
Throws:
DSEInvalidRequestException

getDataName

public java.lang.String getDataName()
Gets the dataName property (java.lang.String) value.

Returns:
String
See Also:
setDataName(java.lang.String)

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException
Initializes a DataPointer with the aTag attributes.

Parameters:
aTag - Tag
Returns:
DataPointer
Throws:
java.io.IOException

setContextName

public void setContextName(java.lang.String aContextName)
Sets the contextName property (java.lang.String) value.

Parameters:
aContextName - - The new value for the property
See Also:
getContextName()

setDataName

public void setDataName(java.lang.String aString)
Sets the dataName property (java.lang.String) value.

Parameters:
aString - - The new value for the property
See Also:
getDataName()

toString

public java.lang.String toString()
Returns a visual representation of the DataField.

Overrides:
toString in class java.lang.Object
Returns:
java.lang.String

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009