IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.base
Interface Externalizable

All Superinterfaces:
java.io.Externalizable, java.io.Serializable
All Known Implementing Classes:
Context, DataElement, FormatElement, HashtableFormat, HashtableIndexedCollectionFormat, ObjectFormat, Pointer, Service

public interface Externalizable
extends java.io.Externalizable

All the Framework elements that are to be externalized in XML format must implement this interface.


Method Summary
 Externalizer externalizer()
          Returns the Externalizer.
 java.lang.String getName()
          Returns the name.
 java.lang.Object initializeFrom(Tag aTag)
          Returns the Object implemented by the Tag aTag.
 void readExternal()
          Finds the tag that corresponds to the name of THIS entity.
 void removeExternal()
          Removes the Externalizer.
 void setName(java.lang.String aName)
          Sets the name.
 Vector toStrings()
          Returns a Vector with the String representation of the object.
 Vector toTags()
          Returns a Vector with the object represented as a Tag.
 void writeExternal()
          Writes this instance converted in tags in a file.
 
Methods inherited from interface java.io.Externalizable
readExternal, writeExternal
 

Method Detail

externalizer

public Externalizer externalizer()
                          throws java.io.IOException
Returns the Externalizer.

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

getName

public java.lang.String getName()
Returns the name.

Returns:
java.lang.String

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException,
                                       DSEException
Returns the Object implemented by the Tag aTag.

Parameters:
aTag - Tag
Returns:
data.DataElement
Throws:
java.io.IOException
DSEException

readExternal

public void readExternal()
                  throws java.io.IOException
Finds the tag that corresponds to the name of THIS entity. The method then initializes THIS entity with the contents of the tag.

Throws:
java.io.IOException

removeExternal

public void removeExternal()
                    throws java.io.IOException
Removes the Externalizer.

Throws:
java.io.IOException

setName

public void setName(java.lang.String aName)
Sets the name.

Parameters:
aName - java.lang.String

toStrings

public Vector toStrings()
Returns a Vector with the String representation of the object.

Returns:
com.ibm.btt.base.Vector

toTags

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

Returns:
com.ibm.btt.base.Vector
Throws:
java.io.IOException

writeExternal

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

Throws:
java.io.IOException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005