|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.btt.base.DSENotifier
com.ibm.btt.base.Service
com.ibm.btt.services.jdbc.JDBCService
com.ibm.btt.services.jdbc.Store
com.ibm.btt.services.jdbc.JDBCStore
@ATTR(value={"statementPoolSize#String#IMPLIED","poolName#String#IMPLIED","dataSourceName#String#IMPLIED","schema#String#IMPLIED","autoCommit#String#IMPLIED","waitRetry#String#REQUIRED","JDBCDriver#String#IMPLIED","catalog#String#IMPLIED","singleTable#String#IMPLIED","createSchema#String#IMPLIED","sharedConnection#String#IMPLIED","table#String#IMPLIED"}) public class JDBCStore
Field Summary | |
---|---|
protected java.lang.String |
catalog
The name of database catalog where the store table is created. |
protected java.lang.String |
JDBCDriver
Keeps the name of the JDBC driver to be used to access the database. |
protected java.lang.String |
schema
The name of database schema where the store table is created. |
Fields inherited from class com.ibm.btt.services.jdbc.Store |
---|
COMPID, state, tableName |
Fields inherited from class com.ibm.btt.services.jdbc.JDBCService |
---|
addPstmt, addString, autoCommit, connectionProperties, databaseConnection, databaseURL, dataSourceName, metaData, password, poolName, sharedConnection, STMT_POOL_SIZE_DEFAULT, stmtPool, stmtPoolSize, updateString, user, waitRetry |
Fields inherited from class com.ibm.btt.base.Service |
---|
externalizer, name |
Fields inherited from class com.ibm.btt.base.DSENotifier |
---|
handlersList |
Constructor Summary | |
---|---|
|
JDBCStore()
This constructor creates a JDBCStore object. |
|
JDBCStore(java.lang.String aTableName)
This constructor creates a JDBCStore object. |
|
JDBCStore(java.lang.String aSchemaName,
java.lang.String aTableName)
This constructor creates a JDBCStore object. |
protected |
JDBCStore(java.lang.String aCatalogName,
java.lang.String aSchemaName,
java.lang.String aTableName)
This constructor creates a JDBCStore object. |
Method Summary | |
---|---|
int |
addRecord(Context aContext,
HashtableFormat aHashtableFormat)
Builds a data Hashtable by calling the format method of the aHashtableFormat with the aContext as an argument. |
int |
addRecord(Context aContext,
java.lang.String aFormatName)
Instantiates the store formatter with the name aFormatName and calls its format method by passing aContext as an argument. |
int |
addRecord(Hashtable aDataHashtable)
Inserts the data from aDataHashtable as a new row into the current Store table. |
protected void |
buildAddString()
Builds an instance variable that will be used when adding a record. |
protected void |
buildConnectionProperties()
Build the Hashtable containing all details needed to request the database connection. |
protected void |
buildUpdateString()
Builds an instance variable that will be used when updating all columns of a record. |
void |
commit()
Commits all changes to the database. |
int |
deleteAllRetrievedForForwarding()
Deletes all records marked as retrievedForForwarding from the store table. |
int |
deleteRecord(int aRecordId)
Deletes the record identified with aRecordId from the store table. |
int |
deleteRecords(java.lang.String aSelectionCriteria)
Deletes all the records within the store table that match the selection criteria. |
java.lang.String |
getCatalogName()
Returns the catalog attribute value. |
Hashtable |
getColumnsTable()
Returns the columnsTable attribute value. |
java.lang.String |
getFullTableName()
Gets the full table name (schemaName + tableName). |
java.lang.String |
getJDBCDriver()
Returns the JDBCDriver attribute value. |
int |
getLastRecordNumber()
Gets the lastRecordNumber attribute value of this Db2Store instance. |
java.lang.String |
getSchemaName()
Returns the schema attribute value. |
java.lang.Object |
initializeColumnFrom(Tag aTag)
Called from the initializeFrom(Tag aTag) method to set the columnsTable attribute of the JDBCStore instance being created. |
java.lang.Object |
initializeFrom(Tag aTag)
Called by the externalizer to set JDBCStore instance attributes to the values set in the services XML file. |
boolean |
isConnected()
Returns true if there is a connection to the database or false if there is not. |
void |
loadDriver()
Loads the JDBC Driver as set in the external definition of the service or the default database JDBC Driver as set in the StoreConstants specific attribute. |
void |
loadDriver(java.lang.String aDriverName)
Loads the specified database JDBC Driver. |
void |
markRecordRetrievedForForwarding(int aRecordId)
Marks the store table record that has an identifier that equals aRecordId as the retrievedForForwarding. |
static JDBCStore |
newFor(java.lang.String aTableName)
Returns a new JDBCStore instance with its tableName attribute set to aTableName. |
static JDBCStore |
newFor(java.lang.String aSchemaName,
java.lang.String aTableName)
Returns a new JDBCStore instance with its tableName attribute set to aTableName. |
protected static JDBCStore |
newFor(java.lang.String aCatalogName,
java.lang.String aSchemaName,
java.lang.String aTableName)
Returns a new JDBCStore instance with its tableName attribute set to aTableName. |
Hashtable |
retrieveFirstRecord()
Returns the first record in the store table or null if the table is empty. |
int |
retrieveFirstRecord(Context aContext,
HashtableFormat aHashtableFormat)
Retrieves the first record in the store table and returns its recordId. |
int |
retrieveFirstRecord(Context aContext,
java.lang.String aFormatName)
Retrieves the first record in the store table and returns its recordId. |
Hashtable |
retrieveFirstRecordForForwarding()
Returns the first record in the store table or null if the table is empty. |
void |
retrieveFirstRecordForForwarding(Context aContext,
HashtableFormat aHashtableFormat)
Retrieves, using the retrieveFirstRecord(Context,HashtableFormat) method, the first record in the store table or null if the table is empty. |
void |
retrieveFirstRecordForForwarding(Context aContext,
java.lang.String aFormatName)
Retrieves, using the retrieveFirstRecord(Context,HashtableFormat) method, the first record in the store table or null if the table is empty. |
int |
retrieveLastRecordNumber()
Returns the last record number. |
Hashtable |
retrieveNextRecord()
Retrieves the next record from the current cursor in the store table. |
int |
retrieveNextRecord(Context aContext,
HashtableFormat aHashtableFormat)
Retrieves the next record from the current cursor in the store table and returns its recordId. |
int |
retrieveNextRecord(Context aContext,
java.lang.String aFormatName)
Retrieves the next record from the current cursor in the store table and returns its recordId. |
Hashtable |
retrieveNextRecordForForwarding()
Retrieves the next record from the current cursor in the store table and marks it as retrievedForForwarding. |
void |
retrieveNextRecordForForwarding(Context aContext,
HashtableFormat aHashtableFormat)
Retrieves the next record from the current cursor in the store table by using the retrieveNextRecord(Context,HashtableFormat) method. |
void |
retrieveNextRecordForForwarding(Context aContext,
java.lang.String aFormatName)
Retrieves the next record from the current cursor in the store table, using the retrieveFirstRecord(Context,FormatName) method and marks it as retrievedForForwarding. |
Hashtable |
retrieveRecord(int aRecordId)
Retrieves a record of the store table with an specific recordId. |
void |
retrieveRecord(int aRecordId,
Context aContext,
HashtableFormat aHashtableFormat)
Retrieves a record of the store table with an specific recordId. |
void |
retrieveRecord(int aRecordId,
Context aContext,
java.lang.String aFormatName)
Retrieves a record of the store table with an specific recordId. |
Hashtable |
retrieveRecord(java.lang.String aSelectionCriteria)
Retrieves the first record of the store table that matches the selection criteria. |
int |
retrieveRecord(java.lang.String aSelectionCriteria,
Context aContext,
HashtableFormat aHashtableFormat)
Retrieves the first record of the store table that matches the selection criteria and returns its recordId. |
int |
retrieveRecord(java.lang.String aSelectionCriteria,
Context aContext,
HashtableFormat aHashtableFormat,
Vector aColumnsVector)
Retrieves the columns in aColumnsVector of the first record of the store table that matches the selection criteria and returns its recordId. |
int |
retrieveRecord(java.lang.String aSelectionCriteria,
Context aContext,
java.lang.String aFormatName)
Retrieves the first record of the store table that matches the selection criteria and returns its recordId. |
int |
retrieveRecord(java.lang.String aSelectionCriteria,
Context aContext,
java.lang.String aFormatName,
Vector aColumnsVector)
Retrieves the columns in aColumnsVector of the first record of the store table that matches the selection criteria and returns its recordId. |
Hashtable |
retrieveRecord(java.lang.String aSelectionCriteria,
Vector aColumnsVector)
Retrieves the columns in aColumnsVector of the first record of the store table that matches the selection criteria. |
Hashtable |
retrieveRecordForForwarding(int aRecordId)
Retrieves a record of the store table with an specific recordId and marks it as retrievedForForwarding. |
void |
retrieveRecordForForwarding(int aRecordId,
Context aContext,
HashtableFormat aHashtableFormat)
Retrieves a record of the store table with an specific recordId and marks it as retrievedForForwarding. |
void |
retrieveRecordForForwarding(int aRecordId,
Context aContext,
java.lang.String aFormatName)
Retrieves a record of the store table with an specific recordId and marks it as retrievedForForwarding. |
Hashtable |
retrieveRecordForForwarding(java.lang.String aSelectionCriteria)
Retrieves the first record of the store table that matches the selection criteria and marks it as retrievedForForwarding. |
int |
retrieveRecordForForwarding(java.lang.String aSelectionCriteria,
Context aContext,
HashtableFormat aHashtableFormat)
Retrieves the first record of the store table that matches the selection criteria and marks it as retrievedForForwarding. |
int |
retrieveRecordForForwarding(java.lang.String aSelectionCriteria,
Context aContext,
java.lang.String aFormatName)
Retrieves the first record of the store table that matches the selection criteria and marks it as retrievedForForwarding. |
Vector |
retrieveRecordsForForwarding(java.lang.String aSearchCondition)
Retrieves all the records from the store table that match aSearchCondition. |
void |
retrieveRecordsForForwarding(java.lang.String aSearchCondition,
Context aContext,
HashtableIndexedCollectionFormat anOutputFormat)
Retrieves all the records from the store table that match aSearchCondition. |
void |
retrieveRecordsForForwarding(java.lang.String aSearchCondition,
Context aContext,
java.lang.String anOutputFormatName)
Retrieves all the records from the store table that match aSearchCondition. |
void |
rollback()
Rolls back all Database changes. |
void |
setCatalogName(java.lang.String newCatalogName)
Sets the catalog attribute to the string provided as an argument. |
protected void |
setColumnsTable(Hashtable aColumnsHashtable)
Sets the columnsHashtable attribute value of this Db2Store instance to aColumnsHashtable. |
void |
setJDBCDriver(java.lang.String newJDBCDriver)
Sets the JDBCDriver attribute value to newJDBCDriver. |
protected void |
setLastRecordNumber(int aRecordNumber)
Sets the lastRecordNumber attribute value of this Db2Store instance to aRecordNumber. |
void |
setSchemaName(java.lang.String s)
Sets the schema attribute to the string provided as an argument. |
Vector |
toStrings()
Used by the externalizer when a new store service instance is requested by the application. |
int |
updateRecord(int aRecordId,
Context aContext,
HashtableFormat aHashtableFormat)
Updates the store table record that has the aRecordId identifier with the data obtained by formatting the aContext with the aHashtableFormat. |
int |
updateRecord(int aRecordId,
Context aContext,
HashtableFormat aHashtableFormat,
Vector aColumnsVector)
Updates the columns in aColumnsVector for the store table record that has the aRecordId identifier with the data obtained by formatting the aContext using the aHashtableFormat. |
int |
updateRecord(int aRecordId,
Context aContext,
java.lang.String aFormatName)
Updates the store table record that has the aRecordId identifier with the data obtained by formatting the aContext with the formatter identified by aFormatName. |
int |
updateRecord(int aRecordId,
Context aContext,
java.lang.String aFormatName,
Vector aColumnsVector)
Updates the columns in aColumnsVector for the store table record that has the aRecordId identifier with the data obtained by formatting the aContext using the formatter identified by aFormatName. |
int |
updateRecord(int aRecordId,
Hashtable aDataHashtable)
Updates the store table record that has the aRecordId identifier with the data in aDataHashtable. |
int |
updateRecord(int aRecordId,
Hashtable aDataHashtable,
Vector aColumnsVector)
Updates the columns in aColumnVector for the store table record that has the aRecordId identifier with the data in aDataHashtable. |
Methods inherited from class com.ibm.btt.services.jdbc.Store |
---|
close, getInUse, getTableName, initialize, isActive, open, reset, setInUse, setTableName, terminate |
Methods inherited from class com.ibm.btt.base.Service |
---|
externalizer, getExternalizer, getTagName, readExternal, readExternal, readObject, removeExternal, setExternalizer, toString, toTags, writeExternal, writeExternal |
Methods inherited from class com.ibm.btt.base.DSENotifier |
---|
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, signalEvent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.btt.services.jdbc.StoreService |
---|
getAutoCommit, setAutoCommit |
Methods inherited from interface com.ibm.btt.services.jdbc.DatabaseConnect |
---|
connect, connect, connect, connect, connect, connect, disconnect, getDatabaseURL, getDataSourceName, getPoolName, getSharedConnection, isWaitRetry, setDatabaseURL, setDataSourceName, setPoolName, setSharedConnection, setWaitRetry |
Methods inherited from interface com.ibm.btt.base.Externalizable |
---|
getName, setName |
Field Detail |
---|
protected java.lang.String schema
protected java.lang.String catalog
protected java.lang.String JDBCDriver
Constructor Detail |
---|
public JDBCStore()
public JDBCStore(java.lang.String aTableName)
aTableName
- java.lang.Stringpublic JDBCStore(java.lang.String aSchemaName, java.lang.String aTableName)
aSchemaName
- java.lang.StringaTableName
- java.lang.Stringprotected JDBCStore(java.lang.String aCatalogName, java.lang.String aSchemaName, java.lang.String aTableName)
aCatalogName
- java.lang.StringaSchemaName
- java.lang.StringaTableName
- java.lang.StringMethod Detail |
---|
public int addRecord(Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidArgumentException, DSEInvalidRequestException, DSEInternalErrorException, DSESQLException, DSEInvalidClassException
addRecord
in interface StoreService
addRecord
in class Store
aContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInvalidRequestException
- if the request is not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
DSEInvalidClassException
- if there is an error in the formatting processpublic int addRecord(Context aContext, java.lang.String aFormatName) throws DSEInvalidArgumentException, DSEInvalidRequestException, DSEInternalErrorException, DSESQLException, DSEInvalidClassException, java.io.IOException
addRecord
in interface StoreService
addRecord
in class Store
aContext
- com.ibm.dse.base.Context - the context that keeps the dataaFormatName
- java.lang.String - the store formatter name
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInvalidRequestException
- if the request is not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
DSEInvalidClassException
- if there is an error in the formatting process
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic int addRecord(Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
addRecord
in interface StoreService
addRecord
in class Store
aDataHashtable
- Hashtable - the Hashtable with the data
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInvalidRequestException
- if the request is not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtprotected void buildAddString() throws DSESQLException, DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSEException
buildAddString
in class JDBCService
DSEInvalidRequestException
- if the request is not valid
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSESQLException
- if an SQLException is caught
DSEObjectNotFoundException
- if the JDBCServicesConnectionManager cannot be found
DSEException
- if an exception is thrown when calling the pool of
connections managerprotected void buildConnectionProperties()
buildConnectionProperties
in class JDBCService
protected void buildUpdateString() throws DSESQLException, DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSEException
buildUpdateString
in class JDBCService
DSEInvalidRequestException
- if the request is not valid
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSESQLException
- if an SQLException is caught
DSEObjectNotFoundException
- if the JDBCServicesConnectionManager cannot be found
DSEException
- if an exception is thrown when calling the pool of
connections managerpublic void commit() throws DSESQLException
commit
in interface StoreService
commit
in class Store
DSESQLException
- if commit failspublic int deleteAllRetrievedForForwarding() throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
deleteAllRetrievedForForwarding
in interface StoreService
deleteAllRetrievedForForwarding
in class Store
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSESQLException
- if an SQLException is caughtpublic int deleteRecord(int aRecordId) throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
deleteRecord
in interface StoreService
deleteRecord
in class Store
aRecordId
- int
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSESQLException
- if an SQLException is caughtpublic int deleteRecords(java.lang.String aSelectionCriteria) throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
deleteRecords
in interface StoreService
deleteRecords
in class Store
aSelectionCriteria
- java.lang.String - the selection criteria in SQL format
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSESQLException
- if an SQLException is caughtpublic java.lang.String getCatalogName()
public Hashtable getColumnsTable()
public java.lang.String getFullTableName()
public java.lang.String getJDBCDriver()
public int getLastRecordNumber()
aRecordNumber
- int - the store table last record numberpublic java.lang.String getSchemaName()
public java.lang.Object initializeColumnFrom(Tag aTag)
aTag
- com.ibm.dse.base.Tag
public java.lang.Object initializeFrom(Tag aTag) throws java.io.IOException
initializeFrom
in class Service
aTag
- com.ibm.dse.base.Tag
java.io.IOException
- if an I/O Exception has occurredpublic boolean isConnected() throws DSEInvalidRequestException, DSEInternalErrorException, DSESQLException, DSEException
isConnected
in interface DatabaseConnect
isConnected
in class JDBCService
DSEInvalidRequestException
- if the request is not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
DSEException
- if an exception is thrown when calling the pool of
connections managerpublic void loadDriver() throws DSEInternalErrorException
DSEInternalErrorException
- if an internal program error occurspublic void loadDriver(java.lang.String aDriverName) throws DSEInternalErrorException
aDriverName
- java.lang.String, the driver name (full path)
DSEInternalErrorException
- if an internal program error occurspublic void markRecordRetrievedForForwarding(int aRecordId) throws DSEInternalErrorException, DSESQLException
markRecordRetrievedForForwarding
in class Store
aRecordId
- int - the record identifier
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic static JDBCStore newFor(java.lang.String aTableName) throws java.io.IOException
aTableName
- java.lang.String - the name of the store table
java.io.IOException
- if an I/O exception has occurred.public static JDBCStore newFor(java.lang.String aSchemaName, java.lang.String aTableName) throws java.io.IOException
aSchemaName
- java.lang.String - the name of the schema in which the store
table is created (if it applies to the DBMS being used)aTableName
- java.lang.String - the name of the store table
java.io.IOException
- if an I/O exception has occurred.protected static JDBCStore newFor(java.lang.String aCatalogName, java.lang.String aSchemaName, java.lang.String aTableName) throws java.io.IOException
aCatalogName
- java.lang.String - the name of the catalog in which the store
table is created (if it applies to the DBMS being used)aSchemaName
- java.lang.String - the name of the schema in which the store
table is created (if it applies to the DBMS being used)aTableName
- java.lang.String - the name of the store table
java.io.IOException
- if an I/O exception has occurred.public Hashtable retrieveFirstRecord() throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveFirstRecord
in interface StoreService
retrieveFirstRecord
in class Store
DSEInvalidArgumentException
- if an argument is not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int retrieveFirstRecord(Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveFirstRecord
in interface StoreService
retrieveFirstRecord
in class Store
aContext
- com.ibm.dse.base.Context the context where to put the
retrieved record dataaHashtableFormat
- com.ibm.dse.base.HashtableFormat the formatter to be used to
update the context
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int retrieveFirstRecord(Context aContext, java.lang.String aFormatName) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException, java.io.IOException
retrieveFirstRecord
in interface StoreService
retrieveFirstRecord
in class Store
aContext
- com.ibm.dse.base.Context - the context where to put the
retrieved record dataaFormatName
- java.lang.String - the name of the formatter to be used to
update the context
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if an argument is not valid
DSESQLException
- if an SQL Exception is caught
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic Hashtable retrieveFirstRecordForForwarding() throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveFirstRecordForForwarding
in interface StoreService
retrieveFirstRecordForForwarding
in class Store
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic void retrieveFirstRecordForForwarding(Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveFirstRecordForForwarding
in interface StoreService
retrieveFirstRecordForForwarding
in class Store
aContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic void retrieveFirstRecordForForwarding(Context aContext, java.lang.String aFormatName) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException, java.io.IOException
retrieveFirstRecordForForwarding
in interface StoreService
retrieveFirstRecordForForwarding
in class Store
aContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if an argument is not valid
DSESQLException
- if an SQL Exception is caught
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic int retrieveLastRecordNumber() throws DSESQLException, DSEInternalErrorException
SELECT * FROM getTableName() WHERE DSERECID=(SELECT MAX(DSERECID) FROM getTableName())
This will return the last record inserted in the table. Then, from the ResultSet, the value in the DSERECID may be obtained and returned.
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic Hashtable retrieveNextRecord() throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
retrieveNextRecord
in interface StoreService
retrieveNextRecord
in class Store
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInvalidRequestException
- if the request is not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int retrieveNextRecord(Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveNextRecord
in interface StoreService
retrieveNextRecord
in class Store
aContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int retrieveNextRecord(Context aContext, java.lang.String aFormatName) throws DSEInternalErrorException, DSEInvalidArgumentException, DSEInvalidRequestException, DSESQLException, java.io.IOException
retrieveNextRecord
in interface StoreService
retrieveNextRecord
in class Store
aContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSESQLException
- if an SQLException is caught
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic Hashtable retrieveNextRecordForForwarding() throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
retrieveNextRecordForForwarding
in interface StoreService
retrieveNextRecordForForwarding
in class Store
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInvalidRequestException
- if the request is not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic void retrieveNextRecordForForwarding(Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveNextRecordForForwarding
in interface StoreService
retrieveNextRecordForForwarding
in class Store
aContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic void retrieveNextRecordForForwarding(Context aContext, java.lang.String aFormatName) throws DSEInternalErrorException, DSEInvalidArgumentException, DSEInvalidRequestException, DSESQLException, java.io.IOException
retrieveNextRecordForForwarding
in interface StoreService
retrieveNextRecordForForwarding
in class Store
aContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- is an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSESQLException
- is an SQLException is caught
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic Hashtable retrieveRecord(int aRecordId) throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveRecord
in interface StoreService
retrieveRecord
in class Store
aRecordId
- int - the record Identifier
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic void retrieveRecord(int aRecordId, Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveRecord
in interface StoreService
retrieveRecord
in class Store
aContext
- com.ibm.dse.base.ContextaSelectionCriteria
- java.lang.StringaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic void retrieveRecord(int aRecordId, Context aContext, java.lang.String aFormatName) throws DSEInternalErrorException, DSEInvalidArgumentException, DSEInvalidRequestException, DSESQLException, java.io.IOException
retrieveRecord
in interface StoreService
retrieveRecord
in class Store
aRecordId
- intaContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSESQLException
- if an SQLException is caught
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic Hashtable retrieveRecord(java.lang.String aSelectionCriteria) throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveRecord
in interface StoreService
retrieveRecord
in class Store
aSelectionCriteria
- java.lang.String - the selection criteria in SQL format
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int retrieveRecord(java.lang.String aSelectionCriteria, Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
retrieveRecord
in interface StoreService
retrieveRecord
in class Store
aContext
- com.ibm.dse.base.ContextaSelectionCriteria
- java.lang.StringaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int retrieveRecord(java.lang.String aSelectionCriteria, Context aContext, HashtableFormat aHashtableFormat, Vector aColumnsVector) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aContext
- com.ibm.dse.base.ContextaSelectionCriteria
- java.lang.StringaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormataColumnsVector
- com.ibm.dse.base.Vector, the vector that contains the columns
to be retrieved
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int retrieveRecord(java.lang.String aSelectionCriteria, Context aContext, java.lang.String aFormatName) throws DSEInternalErrorException, DSEInvalidArgumentException, DSEInvalidRequestException, DSESQLException, java.io.IOException
retrieveRecord
in interface StoreService
retrieveRecord
in class Store
aSelectionCriteria
- java.lang.StringaContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSESQLException
- if an SQLException is caught
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic int retrieveRecord(java.lang.String aSelectionCriteria, Context aContext, java.lang.String aFormatName, Vector aColumnsVector) throws DSEInternalErrorException, DSEInvalidArgumentException, DSEInvalidRequestException, DSESQLException, java.io.IOException
aSelectionCriteria
- java.lang.StringaContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.StringaColumnsVector
- com.ibm.dse.base.Vector, the vector that contains the columns
to be retrieved
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSESQLException
- if an SQL Exception is caught
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic Hashtable retrieveRecord(java.lang.String aSelectionCriteria, Vector aColumnsVector) throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aSelectionCriteria
- java.lang.String - the selection criteria in SQL formataColumnsVector
- com.ibm.dse.base.Vector - the vector that contains the columns
to be retrieved
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic Hashtable retrieveRecordForForwarding(int aRecordId) throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aRecordId
- int - the record Identifier
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic void retrieveRecordForForwarding(int aRecordId, Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aContext
- com.ibm.dse.base.ContextaSelectionCriteria
- java.lang.StringaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic void retrieveRecordForForwarding(int aRecordId, Context aContext, java.lang.String aFormatName) throws DSEInternalErrorException, DSEInvalidArgumentException, DSEInvalidRequestException, DSESQLException, java.io.IOException
aRecordId
- intaContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSESQLException
- if an SQLException is caught
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic Hashtable retrieveRecordForForwarding(java.lang.String aSelectionCriteria) throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aSelectionCriteria
- java.lang.String - the selection criteria in SQL format
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int retrieveRecordForForwarding(java.lang.String aSelectionCriteria, Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aContext
- com.ibm.dse.base.ContextaSelectionCriteria
- java.lang.StringaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int retrieveRecordForForwarding(java.lang.String aSelectionCriteria, Context aContext, java.lang.String aFormatName) throws DSEInternalErrorException, DSEInvalidArgumentException, DSEInvalidRequestException, DSESQLException, java.io.IOException
aSelectionCriteria
- java.lang.StringaContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSESQLException
- if an SQLException is caught
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic Vector retrieveRecordsForForwarding(java.lang.String aSearchCondition) throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
retrieveRecordsForForwarding
in interface StoreService
retrieveRecordsForForwarding
in class Store
aSearchCondition
- java.lang.String the search condition in SQL format
DSEInvalidRequestException
- if the request is not valid
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic void retrieveRecordsForForwarding(java.lang.String aSearchCondition, Context aContext, HashtableIndexedCollectionFormat anOutputFormat) throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException, DSEObjectNotFoundException, java.io.IOException
retrieveRecordsForForwarding
in interface StoreService
retrieveRecordsForForwarding
in class Store
aSearchCondition
- java.lang.String - the search condition in SQL formataContext
- com.ibm.dse.base.Context - the context into which the
retrieved records will be unformattedanOutputFormat
- com.ibm.dse.base.HashtableIndexedCollectionFormat - the
formatter to unformat the retrieved records
DSEInvalidRequestException
- if the request is not valid
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
DSESObjectNotFoundException
- if an object is not found
java.io.IOException
- if there is an error instanciating the formatter from its
external definition
DSEObjectNotFoundException
public void retrieveRecordsForForwarding(java.lang.String aSearchCondition, Context aContext, java.lang.String anOutputFormatName) throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException, DSEObjectNotFoundException, java.io.IOException
retrieveRecordsForForwarding
in interface StoreService
retrieveRecordsForForwarding
in class Store
aSearchCondition
- java.lang.String - the search condition in SQL formataContext
- com.ibm.dse.base.Context - the context into which the
retrieved records will be unformattedanOutputFormatName
- java.lang.String - the name of the formatter to unformat the
retrieved records
DSEInvalidRequestException
- if the request is not valid
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
DSESObjectNotFoundException
- if an object is not found
java.io.IOException
- if there is an error instanciating the formatter from its
external definition
DSEObjectNotFoundException
public void rollback() throws DSESQLException
rollback
in interface StoreService
rollback
in class Store
DSESQLException
- when rollback failspublic void setCatalogName(java.lang.String newCatalogName)
s
- java.lang.Stringprotected void setColumnsTable(Hashtable aColumnsHashtable)
aColumnsHashtable
- Hashtablepublic void setJDBCDriver(java.lang.String newJDBCDriver)
newJDBCDriver
- java.lang.Stringprotected void setLastRecordNumber(int aRecordNumber)
aRecordNumber
- int, the number of the last record inserted in the store tablepublic void setSchemaName(java.lang.String s)
s
- java.lang.Stringpublic Vector toStrings()
toStrings
in class Service
public int updateRecord(int aRecordId, Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException, DSEInvalidClassException
updateRecord
in interface StoreService
updateRecord
in class Store
aRecordId
- intaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
DSEInvalidClassException
- if there is an error in the formatting processpublic int updateRecord(int aRecordId, Context aContext, HashtableFormat aHashtableFormat, Vector aColumnsVector) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException, DSEInvalidClassException
aRecordId
- intaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormataColumnsVector
- com.ibm.dse.base.Vector - the columns to be changed
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
DSEInvalidClassException
- if there is an error in the formatting processpublic int updateRecord(int aRecordId, Context aContext, java.lang.String aFormatName) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException, DSEInvalidClassException, java.io.IOException
updateRecord
in interface StoreService
updateRecord
in class Store
aRecordId
- intaContext
- com.ibm.dse.base.ContextaFormatName
- String - the name of the formatter to be used
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
DSEInvalidClassException
- if there is an error in the formatting process
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic int updateRecord(int aRecordId, Context aContext, java.lang.String aFormatName, Vector aColumnsVector) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException, DSEInvalidClassException, java.io.IOException
aRecordId
- intaContext
- com.ibm.dse.base.ContextaFormatName
- String - the name of the formatter to be usedaColumnsVector
- com.ibm.dse.base.Vector - the columns to be updated
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
DSEInvalidClassException
- if there is an error in the formatting process
java.io.IOException
- if there is an error instanciating the formatter from its
external definitionpublic int updateRecord(int aRecordId, Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
updateRecord
in interface StoreService
updateRecord
in class Store
aRecordId
- intaDataHashtable
- com.ibm.dse.base.Hashtable - the hashtable that contains the
new data
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caughtpublic int updateRecord(int aRecordId, Hashtable aDataHashtable, Vector aColumnsVector) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aRecordId
- intaDataHashtable
- com.ibm.dse.base.Hashtable - the hashtable that contains the
new dataaColumnsVector
- com.ibm.dse.base.Vector - the columns to be updated
DSEInvalidArgumentException
- if an argument is not valid
DSEInvalidRequestException
- if the input parameters are not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQLException is caught
|
IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |