com.tivoli.twg.engine
Class TWGDbTableParms

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGDbTableParms

public class TWGDbTableParms
extends java.lang.Object

The TWGDbTableParms class contains the optional fields for defining a Director table. This class should be used only in the create method of a TWGDatabaseTable subclass when defining initially defining the table.


Constructor Summary
TWGDbTableParms()
          Default constructor
 
Method Summary
 void addIndex(java.lang.String name, java.lang.String columns)
          Add an index for the table.
 java.lang.String getGraphicName()
          Get the icon graphic name
 HashTbl getIndices()
          Get all the additional indices for a table
 java.util.Vector getKey()
          Get the table key (as a vector)
 boolean isKeyUnique()
          Is the key unique
 void setGraphicName(java.lang.String graphic)
          Set the name of the icon graphic for the table
 void setKey(java.lang.String key)
          Set the table key columns
 void setKeyUnique(boolean unique)
          This method is obsolete and should not be used.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TWGDbTableParms

public TWGDbTableParms()
Default constructor

Method Detail

setKey

public void setKey(java.lang.String key)
Set the table key columns

Parameters:
key - - a comma-delimited list of column token names that make up the key. The order of the colum token names defines the key order.

getKey

public java.util.Vector getKey()
Get the table key (as a vector)

Returns:
A vector whose elements are each a table token column name.

setKeyUnique

public void setKeyUnique(boolean unique)
This method is obsolete and should not be used. Set key unique option

Parameters:
unique - - specify true if the key identifies a unique record, otherwise false

isKeyUnique

public boolean isKeyUnique()
Is the key unique

Returns:
- true if the key identifies a unique row, otherwise false

addIndex

public void addIndex(java.lang.String name,
                     java.lang.String columns)
Add an index for the table. If duplicate index names are added the last one added will be the one used.

Parameters:
name - - a name for the index. This name will be prefixed with the table token name.
columns - - a comma-delimited list of column token names that make up the index. The order of the column token names defines the index order.

getIndices

public HashTbl getIndices()
Get all the additional indices for a table

Returns:
- a HashTbl whose keys are the index names and whose data is the comma delimited list of column token names for the each index
See Also:
com.tivoli.twg.libs.Hashtbl;

getGraphicName

public java.lang.String getGraphicName()
Get the icon graphic name

Returns:
The icon graphic name

setGraphicName

public void setGraphicName(java.lang.String graphic)
Set the name of the icon graphic for the table

Parameters:
graphic - - The icon graphic name