|
IBM Branch 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.Service
com.ibm.btt.services.BTTServiceImpl
com.ibm.btt.services.PoolableServiceImpl
com.ibm.btt.services.jdbcservicesinfra.JDBCServiceImpl
com.ibm.btt.services.jdbcjournalservice.JournalImpl
The Journal class is an abstract class that provides all of the data and methods required to build a Financial Electronic Journal. The Journal class is a subclass of real JDBC journal service. Because of this, it has an externalizer that allows you to define any journal object attributes in an external XML file which will been used when the journal object is instantiated. Obviously it inherits all Service Requester attributes. And it will allow you to request an journl action such as add record, query and etc. All the contact with the CHA and formatter service will be handler in this subclass instead of the journal service. . A journal object is then usually instantiated by providing the name of the service to be created to the Service Factory class. The service factory creates an instance of the class that is identified by the name (in this case, a journal) and sets its attributes to the values read from the services XML file.
Field Summary | |
---|---|
static java.lang.String |
COMPID
Keeps the component identification that will be used by the traces tool. |
protected static boolean |
currentSingleTableReset
|
java.lang.String |
date
Keeps the date that will be used by the Journal service to decide which table generation the current journal instance will have to work with. |
java.lang.String |
entity
Keeps the entity information for the current journal instance. |
protected boolean |
fromPool
|
protected int |
lastRecordNumber
Keeps the number of the last record inserted in the current journal table. |
protected boolean |
recIdFromTable
|
protected static java.lang.Object |
recIdSem
|
protected boolean |
singleTable
|
protected static int |
singleTableLastRecordNumber
|
Fields inherited from class com.ibm.btt.services.jdbcservicesinfra.JDBCServiceImpl |
---|
addPstmt, addString, autoCommit, connectionProperties, databaseConnection, databaseURL, dataSourceName, metaData, operationtime, password, poolName, sharedConnection, STMT_POOL_SIZE_DEFAULT, stmtPool, stmtPoolSize, updateString, user, waitRetry |
Fields inherited from class com.ibm.btt.services.BTTServiceImpl |
---|
DEFAULT_RESPONSE |
Fields inherited from class com.ibm.btt.base.Service |
---|
externalizer, name |
Constructor Summary | |
---|---|
JournalImpl()
|
Method Summary | |
---|---|
abstract int |
addRecord(Hashtable aDataHashtable)
Inserts the data in aDataHashtable as a new row in the current journal table. |
void |
close()
Closes the journal (sets its status to inactive). |
abstract void |
commit()
Commits all changes to the database. |
protected abstract java.lang.String |
controlTableName()
Returns the control table name that is used internally by the journal service. |
abstract java.lang.String |
currentGenerationDate()
Returns the last date that the journal service was used by a specific entity. |
java.lang.String |
getDate()
Returns the date attribute value. |
java.lang.String |
getEntity()
Returns the entity attribute value. |
boolean |
getInUse()
Returns the value of the inUse attribute. |
protected int |
getLastRecordNumber()
Returns the lastRecordNumber attribute value. |
abstract int |
getLastRecordNumberFromTable()
Returns the lastRecordNumber from control table. |
abstract java.lang.String |
getSchemaName()
Returns the schemaName attribute value. |
static int |
getSingleTableLastRecordNumber()
Returns the singleTableLastRecordNumber. |
protected java.lang.String |
getState()
Returns the state attribute value. |
abstract java.lang.String |
getTableName()
Returns the current journal table name. |
void |
initialize()
Performs any required actions after service instanciation and before starting to use it. |
boolean |
isActive()
Answers true if the journal is in an active state. |
abstract boolean |
isCreateSchema()
Answers whether a schema has been created for the journal schema in the database. |
static boolean |
isCurrentSingleTableReset()
Returns the currentSingleTableReset. |
boolean |
isFromPool()
Returns the fromPool. |
boolean |
isRecIdFromTable()
Returns the recIdFromTable. |
boolean |
isSingleTable()
Returns the singleTable. |
protected abstract boolean |
isValidEntity()
Checks whether the entity set for the journal instance is a valid entity or not based on the previously created journal tables. |
void |
open()
Decides which table should use the journal instance. |
abstract void |
openOnCurrentTable()
Sets the journal instance attributes that work with the database table that is currently in use. |
abstract void |
openOnNextTable()
Sets the journal instance attributes that work with the next table generation that is available for the specific journal definition. |
abstract int |
queryLastRecordNumber()
Retrieves the last record number from the current journal table. |
void |
reset()
Resets the Journal. |
abstract void |
resetSingleTableLastRecordNumber()
Resets the Journal last record number when different instances are accessing the same tables |
abstract Hashtable |
retrieveLastRecord()
Returns the last record in the current journal table in a Hashtable instance. |
abstract Vector |
retrieveLastRecords(int aNumber)
|
abstract Hashtable |
retrieveRecord(int aRecordNumber)
Returns the record that is identified by aRecordNumber from the current journal table. |
abstract Vector |
retrieveRecords(java.lang.String aSearchCondition)
Returns a Vector with a set of Hashtables built from the records in the current journal table that match the selection criteria. |
abstract void |
rollback()
Rolls back all changes made to the database using the current connection. |
abstract void |
setCreateSchema(boolean newCreateSchema)
Sets the createSchema attribute that keeps information about the existence of a schema in the journal table database. |
static void |
setCurrentSingleTableReset(boolean CurrentSingleTableReset)
Sets the currentSingleTableReset. |
abstract void |
setEntity(java.lang.String anEntityName)
Sets the entity attribute value to anEntityName. |
void |
setFromPool(boolean fromPool)
Sets the fromPool. |
void |
setInUse(boolean b)
Sets the value of the attribute inUse. |
protected void |
setLastRecordNumber(int aRecordNumber)
Sets the lastRecordNumber attribute value to aRecordNumber. |
abstract void |
setLastRecordNumberFromTable(int aLastRecordNumberFromTable)
Sets the lastRecordNumberFromTable into control table. |
void |
setRecIdFromTable(boolean recIdFromTable)
Sets the recIdFromTable. |
abstract void |
setSchemaName(java.lang.String aSchemaName)
Sets the schemaName attribute to aSchemaName. |
void |
setSingleTable(boolean singleTable)
Sets the singleTable. |
static void |
setSingleTableLastRecordNumber(int singleTableNumber)
Sets the singleTableLastRecordNumber. |
protected void |
setState(java.lang.String aState)
Sets the state attribute value of the journal instance to aState. |
protected abstract void |
setTableName(java.lang.String aTableName)
Sets the name of the table that will use the journal instance. |
void |
terminate()
Performs any actions required before stopping using the service instance. |
protected java.lang.String |
today()
Returns today's date. |
abstract int |
updateLastRecord(Hashtable aDataHashtable)
Updates the contents of the last journal table record with the data in aDataHashtable. |
abstract int |
updateRecord(int aRecordNumber,
Hashtable aDataHashtable)
Updates the contents of the aRecordNumber journal record with the data in aDataHashtable. |
abstract int |
updateRecords(java.lang.String aSearchCondition,
Hashtable aDataHashtable)
Updates the contents of all the journal records that match the specified search condition with the data in aDataHashtable. |
Methods inherited from class com.ibm.btt.services.PoolableServiceImpl |
---|
getGrantTime, getUID, setGrantTime, setUID |
Methods inherited from class com.ibm.btt.services.BTTServiceImpl |
---|
getInactiveTimeout, getLastAccess, initializeFrom, processRequest, setInactiveTimeout, setLastAccess |
Methods inherited from class com.ibm.btt.base.Service |
---|
externalizer, getExternalizer, getName, getTagName, readExternal, readExternal, readObject, removeExternal, setExternalizer, setName, toString, toStrings, toTags, writeExternal, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String COMPID
public java.lang.String date
public java.lang.String entity
protected int lastRecordNumber
protected boolean recIdFromTable
protected boolean fromPool
protected static java.lang.Object recIdSem
protected boolean singleTable
protected static int singleTableLastRecordNumber
protected static boolean currentSingleTableReset
Constructor Detail |
public JournalImpl()
Method Detail |
public static boolean isCurrentSingleTableReset()
public static void setCurrentSingleTableReset(boolean CurrentSingleTableReset)
CurrentSingleTableReset
- The currentSingleTableReset to setpublic static int getSingleTableLastRecordNumber()
public static void setSingleTableLastRecordNumber(int singleTableNumber)
singleTableNumber
- The singleTableLastRecordNumber to setpublic abstract int addRecord(Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
aDataHashtable
- com.ibm.dse.base.Hashtable
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 SQL Exception is caughtpublic void close() throws DSESQLException
DSESQLException
- if the close failspublic abstract void commit() throws DSESQLException
DSESQLException
- if an SQL Exception is caughtprotected abstract java.lang.String controlTableName()
public abstract java.lang.String currentGenerationDate() throws DSEInternalErrorException, DSESQLException
DSESQLException
- if an SQL Exception is caught
DSEInternalErrorException
- if an internal program error occurspublic java.lang.String getDate()
public java.lang.String getEntity()
public boolean getInUse()
getInUse
in interface Poolable
getInUse
in class PoolableServiceImpl
Poolable.getInUse()
protected int getLastRecordNumber()
public abstract java.lang.String getSchemaName()
protected java.lang.String getState()
public abstract java.lang.String getTableName()
public void initialize() throws DSEException
initialize
in interface Poolable
initialize
in class PoolableServiceImpl
DSEException
DSEException
Poolable.initialize()
public boolean isActive()
public abstract boolean isCreateSchema()
protected abstract boolean isValidEntity() throws DSEInternalErrorException, DSESQLException
DSEInternalErrorException
- if an internal program error is detected
DSESQLException
- if a SQL Exception is caughtpublic void open() throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
DSEInvalidRequestException
- if the entity name is not valid
DSEInternalErrorException
- if an internal program error occurs
DSEInvalidArgumentException
- if an argument is not valid
DSESQLException
- if a SQL Exception occurspublic abstract void openOnCurrentTable() throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
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 SQL Exception is caughtpublic abstract void openOnNextTable() throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
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 SQL Exception is caughtpublic abstract int queryLastRecordNumber() throws DSESQLException, DSEInternalErrorException
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQL Exception is caughtpublic void reset() throws DSEException
reset
in interface Poolable
reset
in class PoolableServiceImpl
DSEException
Poolable.reset()
public abstract void resetSingleTableLastRecordNumber() throws DSESQLException, DSEInternalErrorException
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQL Exception is caughtpublic abstract Hashtable retrieveLastRecord() throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQL Exception is caughtpublic abstract Vector retrieveLastRecords(int aNumber) throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
DSEInternalErrorException
DSEInvalidRequestException
DSEInvalidArgumentException
DSESQLException
public abstract Hashtable retrieveRecord(int aRecordNumber) throws DSEInternalErrorException, DSEInvalidArgumentException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aRecordNumber
- int
DSEInvalidArgumentException
- if the argument(s) is(are) not valid
DSEInternalErrorException
- if an internal program error occurs
DSESQLException
- if an SQL Exception is caughtpublic abstract Vector retrieveRecords(java.lang.String aSearchCondition) throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
aSearchCondition
- java.lang.String - the selection criteria
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 SQL Exception is caughtpublic abstract void rollback() throws DSESQLException
DSESQLException
- if an SQL Exception is caughtpublic abstract void setCreateSchema(boolean newCreateSchema)
newCreateSchema
- booleanpublic abstract void setEntity(java.lang.String anEntityName)
anEntityName
- java.lang.Stringpublic void setInUse(boolean b)
setInUse
in interface Poolable
setInUse
in class PoolableServiceImpl
b
- - The new value of the attribute inUsePoolable.setInUse(boolean)
protected void setLastRecordNumber(int aRecordNumber)
aRecordNumber
- intpublic abstract void setSchemaName(java.lang.String aSchemaName)
aSchemaName
- java.lang.Stringprotected void setState(java.lang.String aState)
aState
- java.lang.Stringprotected abstract void setTableName(java.lang.String aTableName)
aTableName
- java.lang.Stringpublic void terminate() throws DSEException
terminate
in interface Poolable
terminate
in class PoolableServiceImpl
DSEException
DSEException
protected java.lang.String today()
public abstract int updateLastRecord(Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
aDataHashtable
- com.ibm.dse.base.Hashtable
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 SQL Exception is caughtpublic abstract int updateRecord(int aRecordNumber, Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
aRecordNumber
- int the number of the record to be updatedaDataHashtable
- Hashtable
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 SQL Exception is caughtpublic abstract int updateRecords(java.lang.String aSearchCondition, Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aSearchCondition
- java.lang.StringaDataHashtable
- Hashtable
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 SQL Exception is caughtpublic boolean isRecIdFromTable()
public void setRecIdFromTable(boolean recIdFromTable)
recIdFromTable
- The recIdFromTable to setpublic boolean isFromPool()
public void setFromPool(boolean fromPool)
fromPool
- The fromPool to setpublic boolean isSingleTable()
public void setSingleTable(boolean singleTable)
singleTable
- The singleTable to setpublic abstract int getLastRecordNumberFromTable() throws DSEInvalidRequestException
DSEInvalidRequestException
public abstract void setLastRecordNumberFromTable(int aLastRecordNumberFromTable)
aLastRecordNumberFromTable
- The lastRecordNumberFromTable to set
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |