IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.base.types
Interface TypeExternalizer

All Known Implementing Classes:
DSETypeExternalizer

public interface TypeExternalizer

This interface is implemented by DSETypeExternalizer, a singleton class which is responsible for maintaining a registry of all Type instances.


Method Summary
 Type addType(Type newType)
          Adds the Type passed as argument to the registry of Types known to the TypeExternalizer and if successful, the Type added is returned.
 void augment(java.net.URL typeDefinitionsAsXML)
          Augments the TypeExternalizer with the Type definitions contained in the URL passed as argument, throwing an appropriate exception if unsuccessful.
 Type getType(java.lang.String name)
          Returns the Type with the name passed as argument.
 java.util.Enumeration getTypes()
          Returns an Enumeration of all Types known to the TypeExternalizer.
 java.lang.Object readObject(java.lang.String name)
          Returns a business object for the Type with the name passed as argument.
 

Method Detail

addType

public Type addType(Type newType)
             throws DSETypeException
Adds the Type passed as argument to the registry of Types known to the TypeExternalizer and if successful, the Type added is returned.

Parameters:
newType - Type
Throws:
DSETypeException - - Name of the Type to add is either null or a duplicate

augment

public void augment(java.net.URL typeDefinitionsAsXML)
             throws DSETypeException
Augments the TypeExternalizer with the Type definitions contained in the URL passed as argument, throwing an appropriate exception if unsuccessful.

Parameters:
typeDefinitionsAsXML - URL
Throws:
DSETypeException - - Augmentation is unsuccessful

getType

public Type getType(java.lang.String name)
             throws DSETypeException
Returns the Type with the name passed as argument.

Parameters:
name - String
Returns:
Type
Throws:
DSETypeException - - Type requested is not found

getTypes

public java.util.Enumeration getTypes()
Returns an Enumeration of all Types known to the TypeExternalizer.

Returns:
Enumeration

readObject

public java.lang.Object readObject(java.lang.String name)
                            throws DSETypeException
Returns a business object for the Type with the name passed as argument.

This business object is populated with the default data for the Type requested. Collabrotes with Type. Compond Types return a KeyedCollection, Simple Types return a DataField with a business object as value.

Parameters:
name - String
Returns:
Object
Throws:
DSETypeException - - Type requested is not found

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005