com.interfaceware.chameleon
Class Message

java.lang.Object
  extended by com.interfaceware.chameleon.Table
      extended by com.interfaceware.chameleon.Message

public class Message
extends Table

This class handles Message objects.


Field Summary
 
Fields inherited from class com.interfaceware.chameleon.Table
m_TableHandle
 
Constructor Summary
Message(Engine AEngine, int MessageIndex)
          Construct a Message object with the specified Engine and message index.
Message(Engine AEngine, int MessageIndex, long TableHandle)
          Construct a Message object with the specified Engine, message index, and table handle.
 
Method Summary
 void addRow()
          Prevents adding a row to the Message object.
protected  void finalize()
          Free the Message object handle.
 java.lang.String generateMessage()
          Get a Message object in text string format by calling the Engine.generate method.
 
Methods inherited from class com.interfaceware.chameleon.Table
CHMtableAddRef, CHMtableAddRow, CHMtableColumnIndex, CHMtableColumnName, CHMtableColumnType, CHMtableCountOfColumn, CHMtableCountOfRow, CHMtableCountOfSubTable, CHMtableCreate, CHMtableDump, CHMtableGetDateTime, CHMtableGetDouble, CHMtableGetInteger, CHMtableGetString, CHMtableIsNull, CHMtableName, CHMtableRelease, CHMtableSetDateTime, CHMtableSetDouble, CHMtableSetInteger, CHMtableSetString, CHMtableState, CHMtableSubTable, columnIndex, columnName, columnType, countOfColumn, countOfRow, countOfSubTable, getDate, getdouble, getDouble, getInteger, getState, getString, handle, isNull, release, setDate, setdouble, setDouble, setInteger, setInteger, setString, subTable, tableName, toString
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Message

public Message(Engine AEngine,
               int MessageIndex)
        throws ChameleonException
Construct a Message object with the specified Engine and message index.

Throws:
ChameleonException

Message

public Message(Engine AEngine,
               int MessageIndex,
               long TableHandle)
        throws ChameleonException
Construct a Message object with the specified Engine, message index, and table handle. This is used in the internal implementation of Chameleon and should not be called directly.

Throws:
ChameleonException
Method Detail

finalize

protected void finalize()
                 throws ChameleonException
Free the Message object handle.

Overrides:
finalize in class Table
Throws:
ChameleonException

generateMessage

public java.lang.String generateMessage()
                                 throws ChameleonException
Get a Message object in text string format by calling the Engine.generate method. This method will free the underlying table.

Throws:
ChameleonException

addRow

public void addRow()
            throws ChameleonException
Prevents adding a row to the Message object. Throws an exception when trying to add a row to the Message object because rows are not supposed to be added to the Message.

Overrides:
addRow in class Table
Throws:
ChameleonException