|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.dse.base.DSENotifier | +--com.ibm.dse.base.Service | +--com.ibm.dse.services.jdbc.JDBCService | +--com.ibm.dse.services.jdbc.Journal
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 Service. Because of this, it has an externalizer that allows you to define any journal object attributes in an external XML file (these attributes values are then used when the journal object is instantiated), and it inherits all Service attributes; for example, the name attribute that allows you to request a specific journal service instance in the application hierarchy of contexts. A journal object is then usually instantiated by providing the name of the service to be created to the ServiceExternalizer class. The ServiceExternalizer 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. |
java.sql.Date |
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 int |
lastRecordNumber
Keeps the number of the last record inserted in the current journal table. |
Fields inherited from class com.ibm.dse.services.jdbc.JDBCService |
autoCommit,
connectionProperties,
databaseConnection,
databaseURL,
dataSourceName,
metaData,
password,
poolName,
sharedConnection,
user,
waitRetry |
Fields inherited from class com.ibm.dse.base.Service |
externalizer |
Fields inherited from class com.ibm.dse.base.DSENotifier |
handlersList,
name |
Constructor Summary | |
Journal()
|
Method Summary | |
abstract int |
addRecord(Context aContext,
HashtableFormat aHashtableFormat)
It should call the formatter (HashtableFormat parameter) format method by passing aContext as an argument, and then use the returned object (a Hashtable instance) to build the journal record and insert it into the journal table. |
abstract int |
addRecord(Context aContext,
java.lang.String aFormatName)
It should instantiate the journal format with the name aFormatName and call its format method by passing aContext as an argument. |
abstract int |
addRecord(Hashtable aDataHashtable)
It should insert the data in aDataHashtable as a new row in the current journal table. |
void |
close()
Closes the journal (set its status to inactive). |
abstract void |
commit()
It should commit all changes to the database. |
protected abstract java.lang.String |
controlTableName()
It should return the control table name that is used internally by the journal service. |
abstract java.sql.Date |
currentGenerationDate()
It should return the last date that the journal service was used by a specific entity. |
java.sql.Date |
getDate()
Returns the date attribute value. |
java.lang.String |
getEntity()
Returns the entity attribute value. |
abstract java.lang.String |
getJDBCDriver()
Returns the value of the attribute that keeps the name of the JDBC Driver being used by the service. |
protected int |
getLastRecordNumber()
Returns the lastRecordNumber attribute value. |
abstract java.lang.String |
getSchemaName()
Returns the schemaName attribute value. |
protected java.lang.String |
getState()
Returns the state attribute value. |
abstract java.lang.String |
getTableName()
Returns the current journal table name. |
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. |
protected abstract boolean |
isValidEntity()
It should check whether the entity set for the journal instance is a valid entity or not based on the journal tables previously created. |
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. |
abstract Hashtable |
retrieveLastRecord()
Returns the last record in the current journal table in a Hashtable instance. |
abstract void |
retrieveLastRecord(Context aContext,
HashtableFormat aHashtableFormat)
Retrieves the last record from the current journal table; it uses the formatter aHashtableFormat to unformat the retrieved record and update the context aContext. |
abstract void |
retrieveLastRecord(Context aContextName,
java.lang.String aFormatName)
Updates the context aContext with the values in the last record of the current journal table, by using the formatter named aFormatName. |
abstract Vector |
retrieveLastRecords(int aNumber)
Returns a vector containing the last aNumber records in the current journal table. |
abstract Hashtable |
retrieveRecord(int aRecordNumber)
Returns the record that is identified by aRecordNumber from the current journal table. |
abstract void |
retrieveRecord(int aRecordNumber,
Context aContext,
HashtableFormat aHashtableFormat)
Returns the record from the current journal table that is identified by aRecordNumber. |
abstract void |
retrieveRecord(int aRecordNumber,
Context aContext,
java.lang.String aFormatName)
Returns the record from the current journal table that is identified by aRecordNumber. |
abstract Vector |
retrieveRecords(java.lang.String aSearchCondition)
Returns a Vector with a set of hash tables built from the records in the current journal table and 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 database keeping the journal tables. |
abstract void |
setEntity(java.lang.String anEntityName)
Sets the entity attribute value to anEntityName. |
abstract void |
setJDBCDriver(java.lang.String newJDBCDriver)
Sets the value of the attribute that keeps the name of the JDBC Driver being used by the service. |
protected void |
setLastRecordNumber(int aRecordNumber)
Sets the lastRecordNumber attribute value to aRecordNumber. |
abstract void |
setSchemaName(java.lang.String aSchemaName)
Sets the schemaName attribute to aSchemaName. |
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. |
protected java.sql.Date |
today()
Returns today's date. |
abstract int |
updateLastRecord(Context aContext,
HashtableFormat aHashtableFormat)
Updates the last record of the current journal table with the data in context aContext. |
abstract int |
updateLastRecord(Context aContext,
java.lang.String aFormatName)
Updates the contents of the last journal table record with the data in context aContext. |
abstract int |
updateLastRecord(Hashtable aDataHashtable)
Updates the contents of the last journal table record with the data in aDataHashtable. |
abstract int |
updateRecord(int aRecordNumber,
Context aContext,
HashtableFormat aHashtableFormat)
Updates the record identified by aRecordNumber within the journal table with the data in context aContext. |
abstract int |
updateRecord(int aRecordNumber,
Context aContext,
java.lang.String aFormatName)
Updates the contents of the journal record that is identified by aRecordNumber with the data obtained by formatting the context aContext with the aFormatName formatter. |
abstract int |
updateRecord(int aRecordNumber,
Hashtable aDataHashtable)
Updates the contents of the journal record that is identified by aRecordNumber with the data in aDataHashtable. |
abstract int |
updateRecords(java.lang.String aSearchCondition,
Context aContext,
HashtableFormat aHashtableFormat)
Updates all of the current journal table records, which match the search condition that is passed as an argument, with the data obtained by formatting aContext using the journal format aHashtableFormat .To be implemented by the subclass. |
abstract int |
updateRecords(java.lang.String aSearchCondition,
Context aContext,
java.lang.String aFormatName)
Updates the contents of all of the journal records that match the specified search condition with the data in the context aContext. |
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.dse.base.Service |
externalizer,
getExternalizer,
getTagName,
initializeFrom,
readExternal,
readExternal,
readObject,
removeExternal,
setExternalizer,
terminate,
toString,
toStrings,
toTags,
writeExternal,
writeExternal |
Methods inherited from class com.ibm.dse.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 |
Field Detail |
public static final java.lang.String COMPID
public java.sql.Date date
public java.lang.String entity
protected int lastRecordNumber
Constructor Detail |
public Journal()
Method Detail |
public abstract int addRecord(Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidArgumentException, DSEInvalidRequestException, DSEInternalErrorException, DSESQLException
aContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormatpublic abstract int addRecord(Context aContext, java.lang.String aFormatName) throws DSEInvalidArgumentException, DSEInvalidRequestException, DSEInternalErrorException, DSESQLException
aContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.Stringpublic abstract int addRecord(Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
aDataHashtable
- com.ibm.dse.base.Hashtablepublic void close()
public abstract void commit() throws DSESQLException
protected abstract java.lang.String controlTableName()
public abstract java.sql.Date currentGenerationDate() throws DSEInternalErrorException, DSESQLException
public java.sql.Date getDate()
public java.lang.String getEntity()
public abstract java.lang.String getJDBCDriver()
protected int getLastRecordNumber()
public abstract java.lang.String getSchemaName()
protected java.lang.String getState()
public abstract java.lang.String getTableName()
public boolean isActive()
public abstract boolean isCreateSchema()
protected abstract boolean isValidEntity() throws DSEInternalErrorException, DSESQLException
public void open() throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
public abstract void openOnCurrentTable() throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
public abstract void openOnNextTable() throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
public abstract int queryLastRecordNumber() throws DSESQLException, DSEInternalErrorException
public abstract Hashtable retrieveLastRecord() throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
public abstract void retrieveLastRecord(Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormatpublic abstract void retrieveLastRecord(Context aContextName, java.lang.String aFormatName) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.Stringpublic abstract Vector retrieveLastRecords(int aNumber) throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
aNumber
- int, the number of records to be retrieved from the databasepublic abstract Hashtable retrieveRecord(int aRecordNumber) throws DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aRecordNumber
- intpublic abstract void retrieveRecord(int aRecordNumber, Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aRecordNumber
- intaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormatpublic abstract void retrieveRecord(int aRecordNumber, Context aContext, java.lang.String aFormatName) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aRecordNumber
- intaContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.Stringpublic abstract Vector retrieveRecords(java.lang.String aSearchCondition) throws DSEInternalErrorException, DSEInvalidRequestException, DSEInvalidArgumentException, DSESQLException
aSearchCondition
- java.lang.String, the selection criteriapublic abstract void rollback() throws DSESQLException
public abstract void setCreateSchema(boolean newCreateSchema)
newCreateSchema
- booleanpublic abstract void setEntity(java.lang.String anEntityName)
anEntityName
- java.lang.Stringpublic abstract void setJDBCDriver(java.lang.String newJDBCDriver)
newJDBCDriver
- java.lang.Stringprotected 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.Stringprotected java.sql.Date today()
public abstract int updateLastRecord(Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormat, the format to be usedpublic abstract int updateLastRecord(Context aContext, java.lang.String aFormatName) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
aContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String, the name of the format to be usedpublic abstract int updateLastRecord(Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
aDataHashtable
- com.ibm.dse.base.Hashtablepublic abstract int updateRecord(int aRecordNumber, Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aRecordNumber
- int, the number of the record to be updatedaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormatpublic abstract int updateRecord(int aRecordNumber, Context aContext, java.lang.String aFormatName) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
aRecordNumber
- int, the number of the record to be updatedaContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String, the name of the formatter to be usedpublic abstract int updateRecord(int aRecordNumber, Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
aRecordNumber
- int, the number of the record to be updatedaDataHashtable
- Hashtablepublic abstract int updateRecords(java.lang.String aSearchCondition, Context aContext, HashtableFormat aHashtableFormat) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aSearchCondition
- java.lang.StringaContext
- com.ibm.dse.base.ContextaHashtableFormat
- com.ibm.dse.base.HashtableFormatpublic abstract int updateRecords(java.lang.String aSearchCondition, Context aContext, java.lang.String aFormatName) throws DSEInvalidRequestException, DSEInvalidArgumentException, DSEInternalErrorException, DSESQLException
aSearchCondition
- java.lang.StringaContext
- com.ibm.dse.base.ContextaFormatName
- java.lang.String, the name of the format to be usedpublic abstract int updateRecords(java.lang.String aSearchCondition, Hashtable aDataHashtable) throws DSEInvalidRequestException, DSEInternalErrorException, DSEInvalidArgumentException, DSESQLException
aSearchCondition
- java.lang.StringaDataHashtable
- Hashtable
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |