com.ibm.websphere.rsadapter
Class DataStoreHelperMetaData

java.lang.Object
  |
  +--com.ibm.websphere.rsadapter.DataStoreHelperMetaData
All Implemented Interfaces:
java.io.Serializable

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

MetaData object for DataStoreHelpers. This MetaData object may be used to retrieve static information about the database. Setter methods are provided ONLY for the DataStoreHelper class to initialize the MetaData. The setters should never be used by the application.

See Also:
Serialized Form

Constructor Summary
DataStoreHelperMetaData()
          Create a new DataStoreHelperMetaData instance with all the default values.
 
Method Summary
 int getDatabaseDefaultIsolationLevel()
           
 int getHelperType()
          This method returns the helper type the list of helper types is defined in the DataStoreHelper as follows:
CUSTOM_HELPER = -1,
CLOUDSCAPE_HELPER = 0,
DB2_HELPER = 1,
DB2_400_HELPER = 2,
DB2_390_HELPER = 3,
DB2_UNIVERSAL_HELPER = 4,
GENERIC_HELPER = 5,
DATADIRECT_HELPER = 6,
CONNECTJDBC_HELPER = 7,
WSCONNECTJDBC_HELPER = 8,
SEQUELINK_HELPER = 9,
MSSQL_HELPER = 10,
SYBASE_HELPER = 11,
SYBASE11_HELPER = 12,
ORACLE_HELPER = 13,
INFORMIX_HELPER = 14;
 void setDatabaseDefaultIsolationLevel(int level)
          Set the default isolation level for the database.
 void setExtendedForUpdateSupport(boolean flag)
          This method sets the extendedForUpdate support.
 void setGetCatalogSupport(boolean flag)
          Sets a flag indicating the database driver supports 'getCatalog' method.
 void setGetTypeMapSupport(boolean flag)
          Sets a flag indicating the database driver supports 'getTypeMap'.
 void setHelperType(int hType)
          This method sets the helper type, the helper type is a int constant which will be used in place of instanceof operations for performance reasons
 void setKerberosSupport(boolean flag)
          Sets whether the database supports kerberos.
 void setMultiplePartitionDBSupport(boolean flag)
          d146350 This method sets the mulitple partition databases support.
 void setReadOnlySupport(boolean flag)
          Sets a flag indicating the database support for ReadOnly.
 void setSelectForUpdateSupport(boolean flag)
          Sets a flag indicating the database support of 'select for update'.
 boolean supportsExtendedForUpdate()
          Indicate whether the database supports extended-for-update
 boolean supportsGetCatalog()
          Sets a flag indicating the database support of 'getCatalog'.
 boolean supportsGetTypeMap()
          returns whether the database driver supports 'getTypeMap' method.
 boolean supportsIsReadOnly()
          indicates whether the database driver supports 'readOnly'.
 boolean supportsKerberos()
          Indicate whether the database supports kerberos.
 boolean supportsMultiplePartitionDB()
          d146350 add indicates whether the database driver supports multiple partition databases.
 boolean supportsSelectForUpdate()
          Sets a flag indicating the database support of 'select for update'.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataStoreHelperMetaData

public DataStoreHelperMetaData()

Create a new DataStoreHelperMetaData instance with all the default values. The default values are:

defaultTransactionIsolation = java.sql.Connection.TRANSACTION_READ_COMMITTED;
isAutoCommitMorphingSupported = false;
supportsExtendedForUpdate = false;
supportsKerberos = false;
supportsSelectForUpdate = true;
supportsGetCatalog = true;
supportsGetTypeMap = true;
supportsIsReadOnly = true;
Method Detail

getHelperType

public final int getHelperType()
This method returns the helper type the list of helper types is defined in the DataStoreHelper as follows:
CUSTOM_HELPER = -1,
CLOUDSCAPE_HELPER = 0,
DB2_HELPER = 1,
DB2_400_HELPER = 2,
DB2_390_HELPER = 3,
DB2_UNIVERSAL_HELPER = 4,
GENERIC_HELPER = 5,
DATADIRECT_HELPER = 6,
CONNECTJDBC_HELPER = 7,
WSCONNECTJDBC_HELPER = 8,
SEQUELINK_HELPER = 9,
MSSQL_HELPER = 10,
SYBASE_HELPER = 11,
SYBASE11_HELPER = 12,
ORACLE_HELPER = 13,
INFORMIX_HELPER = 14;
Returns:
helperType represented as an int

setHelperType

public final void setHelperType(int hType)
This method sets the helper type, the helper type is a int constant which will be used in place of instanceof operations for performance reasons
Parameters:
hType - HType should be on of the following which are defined in DataStoreHelper:
CUSTOM_HELPER = -1,
CLOUDSCAPE_HELPER = 0,
DB2_HELPER = 1,
DB2_400_HELPER = 2,
DB2_390_HELPER = 3,
DB2_UNIVERSAL_HELPER = 4,
GENERIC_HELPER = 5,
DATADIRECT_HELPER = 6,
CONNECTJDBC_HELPER = 7,
WSCONNECTJDBC_HELPER = 8,
SEQUELINK_HELPER = 9,
MSSQL_HELPER = 10,
SYBASE_HELPER = 11,
SYBASE11_HELPER = 12,
ORACLE_HELPER = 13,
INFORMIX_HELPER = 14;

getDatabaseDefaultIsolationLevel

public final int getDatabaseDefaultIsolationLevel()
Returns:
the database default isolation level for this database.

setDatabaseDefaultIsolationLevel

public final void setDatabaseDefaultIsolationLevel(int level)
Set the default isolation level for the database. This method should only be used by the DataStoreHelper class to initially configure the MetaData.
Parameters:
level - the isolation level.

setExtendedForUpdateSupport

public final void setExtendedForUpdateSupport(boolean flag)
This method sets the extendedForUpdate support. This method should only be used by the DataStoreHelper class to initially configure the MetaData.
Parameters:
flag - indicates whether the database supports extended-for-update.

supportsExtendedForUpdate

public final boolean supportsExtendedForUpdate()
Indicate whether the database supports extended-for-update

setKerberosSupport

public final void setKerberosSupport(boolean flag)
Sets whether the database supports kerberos. This method should only be used by the DataStoreHelper class to initially configure the MetaData.
Parameters:
flag - indicates whether the database supports kerberos.

supportsKerberos

public final boolean supportsKerberos()
Indicate whether the database supports kerberos.

setSelectForUpdateSupport

public final void setSelectForUpdateSupport(boolean flag)
Sets a flag indicating the database support of 'select for update'. This method should only be used by the DataStoreHelper class to initially configure the MetaData.
Parameters:
flag - indicates whether the database supports 'select for update'.

supportsSelectForUpdate

public final boolean supportsSelectForUpdate()
Sets a flag indicating the database support of 'select for update'.
Parameters:
flag - indicates whether the database supports 'select for update'.

setGetCatalogSupport

public final void setGetCatalogSupport(boolean flag)
Sets a flag indicating the database driver supports 'getCatalog' method. This method should only be used by the DataStoreHelper class to initially configure the MetaData.
Parameters:
flag - indicates whether the database supports 'select for update'.

supportsGetCatalog

public final boolean supportsGetCatalog()
Sets a flag indicating the database support of 'getCatalog'.
Parameters:
flag - indicates whether the database supports 'select for update'.

setGetTypeMapSupport

public final void setGetTypeMapSupport(boolean flag)
Sets a flag indicating the database driver supports 'getTypeMap'. This method should only be used by the DataStoreHelper class to initially configure the MetaData.
Parameters:
flag - indicates whether the database supports 'getTypeMap'.

supportsGetTypeMap

public final boolean supportsGetTypeMap()
returns whether the database driver supports 'getTypeMap' method.

setReadOnlySupport

public final void setReadOnlySupport(boolean flag)
Sets a flag indicating the database support for ReadOnly. This method should only be used by the DataStoreHelper class to initially configure the MetaData.
Parameters:
flag - indicates whether the database supports ReadOnly access.

supportsIsReadOnly

public final boolean supportsIsReadOnly()
indicates whether the database driver supports 'readOnly'.

setMultiplePartitionDBSupport

public final void setMultiplePartitionDBSupport(boolean flag)
d146350 This method sets the mulitple partition databases support. This method should only be used by the DataStoreHelper class to initially configure the MetaData.
Parameters:
flag - indicates whether the database supports multiple partitionDB.

supportsMultiplePartitionDB

public final boolean supportsMultiplePartitionDB()
d146350 add indicates whether the database driver supports multiple partition databases.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object