IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.base
Class Pointer

java.lang.Object
  extended bycom.ibm.dse.base.Pointer
All Implemented Interfaces:
Externalizable, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
DataPointer

public abstract class Pointer
extends java.lang.Object
implements Externalizable

This is the abstract parent class of all pointers. A Pointer is a reference to a DataElement.

See Also:
Serialized Form

Field Summary
(package private) static Externalizer externalizer
           
protected  java.beans.PropertyChangeSupport propertyChange
           
 
Constructor Summary
Pointer()
          This is the default constructor used to create a Pointer object.
 
Method Summary
 Externalizer externalizer()
          Returns the externalizer instance of this class.
static Externalizer getExternalizer()
          Gets the Externalizer.
 java.lang.String getName()
          Gets the dataName property (a java.lang.String) value.
 java.lang.String getTagName()
          Gets a tag name.
 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 Pointer with a specified name from the definitions file.
 void removeExternal()
          Removes the tags for this object from the definitions file where the object is externalized.
static void setExternalizer(Externalizer anExternalizer)
          Sets the Externalizer.
 void setName(java.lang.String aString)
          Sets the dataName property (a java.lang.String) value.
 Vector toStrings()
          Returns a visual representation of this data element.
 Vector toTags()
          Returns a Vector with the DataElement represented as a Tag
 void writeExternal()
          Writes this instance converted in tags in a file.
 void writeExternal(java.io.ObjectOutput s)
          Provides concrete serialization handling for Pointer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.dse.base.Externalizable
initializeFrom
 

Field Detail

propertyChange

protected transient java.beans.PropertyChangeSupport propertyChange

externalizer

static Externalizer externalizer
Constructor Detail

Pointer

public Pointer()
This is the default constructor used to create a Pointer object.

Method Detail

externalizer

public Externalizer externalizer()
                          throws java.io.IOException
Returns the externalizer instance of this class.

Specified by:
externalizer in interface Externalizable
Returns:
com.ibm.dse.base.Externalizer
Throws:
java.io.IOException

getExternalizer

public static Externalizer getExternalizer()
                                    throws java.io.IOException
Gets the Externalizer.

Returns:
com.ibm.dse.base.Externalizer
Throws:
java.io.IOException

getName

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

Specified by:
getName in interface Externalizable
Returns:
The dataName property value.
See Also:
setName(java.lang.String)

getTagName

public java.lang.String getTagName()
Gets a tag name.

Returns:
java.lang.String

readExternal

public void readExternal()
                  throws java.io.IOException
Initializes a dataElement with its external value. To work properly, it is assumed that the pointer has an ID (a name) and that the externalizer and its tagInputStream are initialized.

Specified by:
readExternal in interface Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput s)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Invokes the object creation from an ObjectInput.

Specified by:
readExternal in interface java.io.Externalizable
Parameters:
s - java.io.ObjectInput
Throws:
java.io.IOException
java.lang.ClassNotFoundException

readObject

public static java.lang.Object readObject(java.lang.String name)
                                   throws java.io.IOException
Instantiates a Pointer with a specified name from the definitions file.

Parameters:
name - String)
Returns:
java.lang.Object
Throws:
java.io.IOException

removeExternal

public void removeExternal()
                    throws java.io.IOException
Removes the tags for this object from the definitions file where the object is externalized.

Specified by:
removeExternal in interface Externalizable
Throws:
java.io.IOException

setExternalizer

public static void setExternalizer(Externalizer anExternalizer)
Sets the Externalizer.

Parameters:
anExternalizer - com.ibm.dse.base.Externalizer

setName

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

Specified by:
setName in interface Externalizable
Parameters:
aString - The new value for the property.
See Also:
getName()

toStrings

public Vector toStrings()
Returns a visual representation of this data element.

Specified by:
toStrings in interface Externalizable
Returns:
Vector

toTags

public Vector toTags()
              throws java.io.IOException
Returns a Vector with the DataElement represented as a Tag

Specified by:
toTags in interface Externalizable
Returns:
com.ibm.dse.base.Vector
Throws:
java.io.IOException

writeExternal

public void writeExternal()
                   throws java.io.IOException
Writes this instance converted in tags in a file.

Specified by:
writeExternal in interface Externalizable
Throws:
java.io.IOException

writeExternal

public void writeExternal(java.io.ObjectOutput s)
                   throws java.io.IOException
Provides concrete serialization handling for Pointer.

Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
s - java.io.ObjectOutput
Throws:
java.io.IOException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005