com.tivoli.twg.engine
Class TWGDbMetaData

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGDbMetaData
All Implemented Interfaces:
java.io.Serializable

public class TWGDbMetaData
extends java.lang.Object
implements java.io.Serializable

A TWGDbMetaData instance is sent as output parameter 0 in the response to a database find table by classname command if the command is successful.

See Also:
Serialized Form

Constructor Summary
TWGDbMetaData(byte[] buf)
          This method is public as an implementation side effect.
TWGDbMetaData(java.lang.String product_name, java.lang.String product_version, java.lang.String driver, java.lang.String driver_version, int columns_in_select, int tables_in_select, int max_column_name_length, int max_table_name_length, int max_char_length, int max_primary_keys_length)
          This method is public as an implementation side effect.
 
Method Summary
 java.lang.String getDatabaseProductName()
          Get database product name.
 java.lang.String getDatabaseProductVersion()
          Get database product version.
 java.lang.String getDriverName()
          Get database driver name.
 java.lang.String getDriverVersion()
          Get database driver version.
protected  int getIntelByteBufferSize()
          This method is protected as an implementation side effect.
 int getMaxCharLength()
          Get the maximum char length
 int getMaxColumnNameLength()
          Get the maximum column name length
 int getMaxColumnsInSelect()
          Get the maximum number of columns allowed in select clause.
 int getMaxPrimaryKeysLength()
          Get the maximum length for all primary keys
 int getMaxTableNameLength()
          Get the maximum table name length
 int getMaxTablesInSelect()
          Get the maximum number of tables allowed in select clause.
 void setIntelByteBufferParms(Command cmd)
          This method is protected as an implementation side effect.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TWGDbMetaData

public TWGDbMetaData(java.lang.String product_name,
                     java.lang.String product_version,
                     java.lang.String driver,
                     java.lang.String driver_version,
                     int columns_in_select,
                     int tables_in_select,
                     int max_column_name_length,
                     int max_table_name_length,
                     int max_char_length,
                     int max_primary_keys_length)
This method is public as an implementation side effect. Do not call or change. Its interface may be changed in a later release.

Parameters:
product_name - - the name of the database product.
product_version - - the version for this database product.
driver - - the name of the driver for the database.
driver_version - - the version of the database driver.
columns_in_select - - the maximum number of columns allowed in select clause.
tables_in_select - - the maximum number of tables allowed in select clause.
max_column_name_length - - the maximum column name length.
max_table_name_length - - the maximum table name length
max_char_length - - the maximum char length
max_primary_keys_length - - maximum length of all primary keys

TWGDbMetaData

public TWGDbMetaData(byte[] buf)
              throws TWGDbException
This method is public as an implementation side effect. Do not call or change. Its interface may be changed in a later release.

Constructor for the building the object from an IntelByteBuffer format of the command

Parameters:
buf - - the reply in IntelByteBufferFormat
Throws:
- - TWGDbException thrown for parameter or version errors
TWGDbException
Method Detail

getDatabaseProductName

public java.lang.String getDatabaseProductName()
Get database product name.

Returns:
the product name

getDatabaseProductVersion

public java.lang.String getDatabaseProductVersion()
Get database product version.

Returns:
the product version

getDriverName

public java.lang.String getDriverName()
Get database driver name.

Returns:
the database driver name

getDriverVersion

public java.lang.String getDriverVersion()
Get database driver version.

Returns:
the database driver version.

getMaxColumnsInSelect

public int getMaxColumnsInSelect()
Get the maximum number of columns allowed in select clause.

Returns:
the maximum number of columns in select

getMaxTablesInSelect

public int getMaxTablesInSelect()
Get the maximum number of tables allowed in select clause.

Returns:
the maximum number of tables in select

getMaxColumnNameLength

public int getMaxColumnNameLength()
Get the maximum column name length

Returns:
the maximum column name length

getMaxTableNameLength

public int getMaxTableNameLength()
Get the maximum table name length

Returns:
the maximum column name length

getMaxCharLength

public int getMaxCharLength()
Get the maximum char length

Returns:
the maximum column name length

getMaxPrimaryKeysLength

public int getMaxPrimaryKeysLength()
Get the maximum length for all primary keys

Returns:
the maximum length for all primary keys

setIntelByteBufferParms

public void setIntelByteBufferParms(Command cmd)
This method is protected as an implementation side effect. Do not call or change. Its interface may be changed in a later release.

Build IntelByteBuffer parms version of this command and add them to the IPC command

Parameters:
cmd - - the IPC command whose input parameters will be set by this method
Throws:
- - TWGDbException thrown for parameter or version errors

getIntelByteBufferSize

protected int getIntelByteBufferSize()
This method is protected as an implementation side effect. Do not call or change. Its interface may be changed in a later release.

Get the IntelByteBuffer size

Returns:
- size of buffer needed