IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.formatter.client
Interface CHAFormatterServiceProxy

All Known Implementing Classes:
CHAFormatterServiceLocalJavaProxy, CHAFormatterServicePureEJBProxy, CHAFormatterServiceWSIFEjbProxy, CHAFormatterServiceWSIFJavaProxy

public interface CHAFormatterServiceProxy

This class is the general interface of four different CHAFormatterService proxies.


Method Summary
 java.lang.String format(Context aContext, java.lang.String aFormatName)
          Formats a context by a given format
 java.lang.String format(DataElement aDataElement, java.lang.String aFormatName)
          Formats a data element by a given format.
 java.util.Map formatHashtable(Context aContext, java.lang.String aFormatName)
          Formats a context by a given hashtable format.
 java.util.Map formatHashtable(KeyedCollection aKeyedCollection, java.lang.String aFormatName)
          Formats a KeyedCollection by a given hashtable format.
 java.util.List mapContents(Context aInputContext, Context aOutputContext, java.lang.String aFormatName)
          Maps the contexts of a context into another context.
 java.util.List unformat(java.lang.String aAString, Context aContext, java.lang.String aFormatName)
          Unformats a context by a given format element.
 java.util.List unformat(java.lang.String aAString, DataElement aDataElement, java.lang.String aFormatName)
          Unformats a data element by a given format.
 java.util.List unformatHashtable(java.util.Map aHashtable, Context aContext, java.lang.String aFormatName)
          Unformats a context by a given hashtable format.
 java.util.List unformatHashtable(java.util.Map aHashtable, KeyedCollection aKeyedCollection, java.lang.String aFormatName)
          Unformats a KeyedCollection by a given hashtable format.
 java.util.List unformatIndexedCollection(java.util.List aVector, Context aContext, java.lang.String aFormatName)
          Unformats a context by a given hashtable IndexedCollection format.
 java.util.List unformatIndexedCollection(java.util.List aVector, IndexedCollection anIndexedCollection, java.lang.String aFormatName)
          Unformats an IndexedCollection by a given hashtable IndexedCollection format.
 

Method Detail

format

public java.lang.String format(Context aContext,
                               java.lang.String aFormatName)
                        throws java.lang.Exception
Formats a context by a given format

Parameters:
aContext - com.ibm.btt.base.Context
aFormatName - java.lang.String
Returns:
java.lang.String
Throws:
java.lang.Exceptioin
java.lang.Exception

format

public java.lang.String format(DataElement aDataElement,
                               java.lang.String aFormatName)
                        throws java.lang.Exception
Formats a data element by a given format.

Parameters:
aDataElement - com.ibm.btt.base.DataElement
aFormatName - java.lang.String
Returns:
java.lang.String
Throws:
java.lang.Exception

unformat

public java.util.List unformat(java.lang.String aAString,
                               Context aContext,
                               java.lang.String aFormatName)
                        throws java.lang.Exception
Unformats a context by a given format element.

Parameters:
aAString - java.lang.String
aContext - com.ibm.btt.base.Context
aFormatName - java.lang.String
Returns:
java.util.List
Throws:
java.lang.Exception

unformat

public java.util.List unformat(java.lang.String aAString,
                               DataElement aDataElement,
                               java.lang.String aFormatName)
                        throws java.lang.Exception
Unformats a data element by a given format.

Parameters:
aAString - java.lang.String
aDataElement - com.ibm.btt.base.Context
aFormatName - java.lang.String
Returns:
java.util.List
Throws:
java.lang.Exception

mapContents

public java.util.List mapContents(Context aInputContext,
                                  Context aOutputContext,
                                  java.lang.String aFormatName)
                           throws java.lang.Exception
Maps the contexts of a context into another context.

Parameters:
aInputContext - com.ibm.btt.base.Context
aOutputContext - java.lang.String
aFormatName - java.lang.String
Returns:
java.util.List
Throws:
java.lang.Exception

formatHashtable

public java.util.Map formatHashtable(Context aContext,
                                     java.lang.String aFormatName)
                              throws java.lang.Exception
Formats a context by a given hashtable format.

Parameters:
aContext - com.ibm.btt.base.aContext
aFormatName - java.lang.String
Returns:
java.util.Map
Throws:
java.lang.Exception

formatHashtable

public java.util.Map formatHashtable(KeyedCollection aKeyedCollection,
                                     java.lang.String aFormatName)
                              throws java.lang.Exception
Formats a KeyedCollection by a given hashtable format.

Parameters:
aKeyedCollection - com.ibm.btt.base.KeyedCollection
aFormatName - java.lang.String
Returns:
java.util.Map
Throws:
java.lang.Exception

unformatHashtable

public java.util.List unformatHashtable(java.util.Map aHashtable,
                                        Context aContext,
                                        java.lang.String aFormatName)
                                 throws java.lang.Exception
Unformats a context by a given hashtable format.

Parameters:
aContext - com.ibm.btt.base.Context
aHashtable - java.util.Map
aFormatName - java.lang.String
Returns:
java.util.List
Throws:
java.lang.Exception

unformatHashtable

public java.util.List unformatHashtable(java.util.Map aHashtable,
                                        KeyedCollection aKeyedCollection,
                                        java.lang.String aFormatName)
                                 throws java.lang.Exception
Unformats a KeyedCollection by a given hashtable format.

Parameters:
aKeyedCollection - com.ibm.btt.base.KeyedCollection
aHashtable - java.util.Map
aFormatName - java.lang.String
Returns:
java.util.List
Throws:
java.lang.Exception

unformatIndexedCollection

public java.util.List unformatIndexedCollection(java.util.List aVector,
                                                Context aContext,
                                                java.lang.String aFormatName)
                                         throws java.lang.Exception
Unformats a context by a given hashtable IndexedCollection format.

Parameters:
aContext - com.ibm.btt.base.Context
aVector - java.util.List
aFormatName - java.lang.String
Returns:
java.util.List
Throws:
java.lang.Exception

unformatIndexedCollection

public java.util.List unformatIndexedCollection(java.util.List aVector,
                                                IndexedCollection anIndexedCollection,
                                                java.lang.String aFormatName)
                                         throws java.lang.Exception
Unformats an IndexedCollection by a given hashtable IndexedCollection format.

Parameters:
anIndexedCollection - com.ibm.btt.base.IndexedCollection
aVector - java.util.List
aFormatName - java.lang.String
Returns:
java.util.List
Throws:
java.lang.Exception

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005