BaseDatabaseListener (Leo Parent Project 2018.01.0 API)

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Object[]>`	`batch` List for holding a batch until pageSize is reached and the batch is committed.
`protected int`	`batchSize` Batch size before doing a commit.
`protected Connection`	`conn` The database connection.
`protected DatabaseConnectionInformation`	`databaseConnectionInformation` The database connection information.
`protected org.apache.log4j.Logger`	`LOG` Logging object of output.
`protected String`	`preparedStatementSQL` The insert statement sql.
`protected PreparedStatement`	`ps` The prepared statement for inserting a record.
`protected boolean`	`validateConnectionEachBatch` If true, the connection is validated before committing each batch.

Fields inherited from class gov.va.vinci.leo.listener.BaseListener
annotationTypeFilter, docInfo, exitOnError, inputType, lastException, logErrors, mOutputDir, numReceived, numSent, previousReferenceId, referenceID

Constructor Summary

Constructors
Constructor and Description
`BaseDatabaseListener(DatabaseConnectionInformation databaseConnectionInformation, String preparedStatementSQL)` Base gov.va.vinci.leo.listener.
`BaseDatabaseListener(DatabaseConnectionInformation databaseConnectionInformation, String databaseName, String databaseTable, List<DatabaseField> fieldList)` Constructor for using a fieldList.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus aStatus)`
`protected String`	`createCreateStatement(String dbsName, String tableName, List<DatabaseField> fieldList)` Protected method to build a create table statement.
`protected String`	`createPreparedStatementSQL(String databaseName, String tableName, List<DatabaseField> fields)` Creates an insert sql statement for the list of fields.
`void`	`createTable(boolean dropFirst, String dbsName, String tableName, List<DatabaseField> fieldList)` Creates the table structure.
`void`	`createTable(boolean dropFirst, String dbsName, String tableName, Map<String,String> fieldList)` Creates the table structure.
`void`	`createTable(String createStatement, boolean dropFirst, String tableName)` Creates the table structure.
`void`	`entityProcessComplete(org.apache.uima.cas.CAS aCas, org.apache.uima.collection.EntityProcessStatus aStatus)`
`int`	`getBatchSize()` Get the batch size for the number of records to accumulate before executing the batch.
`protected abstract List<Object[]>`	`getRows(org.apache.uima.cas.CAS aCas)` Abstract method: You must implement this method.
`boolean`	`isValidateConnectionEachBatch()` Return true if the connection will be validated when executing each batch.
`protected void`	`processBatch()` This is called when a batch is ready to be send to the database.
`<T extends BaseDatabaseListener> T`	`setBatchSize(int batchSize)` Set the batch size for the number of records to accumulate before executing the batch.
`<T extends BaseDatabaseListener> T`	`setValidateConnectionEachBatch(boolean validateConnectionEachBatch)` Set the flag that if true will cause the connection to be validated when executing each batch.
`protected void`	`validateConnection()` Method to validate the connection is not null, and if specified, run the validation query against the database.

Methods inherited from class gov.va.vinci.leo.listener.BaseListener
checkForError, entityProcessError, getAnnotationTypeFilter, getInputType, getInputTypesList, getNumReceived, getNumSent, getOutputDir, getReferenceLocation, hasAnnotationsToProcess, hasFilteredAnnotation, initializationComplete, isExitOnError, isLogErrors, onBeforeMessageSend, setAnnotationTypeFilter, setExitOnError, setInputType, setLogErrors, setOutputDir

Methods inherited from class org.apache.uima.aae.client.UimaAsBaseCallbackListener
onBeforeProcessCAS, onBeforeProcessMeta, onUimaAsServiceExit

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - conn
```
protected Connection conn
```
    The database connection.
  - ps
```
protected PreparedStatement ps
```
    The prepared statement for inserting a record.
  - databaseConnectionInformation
```
protected DatabaseConnectionInformation databaseConnectionInformation
```
    The database connection information.
  - validateConnectionEachBatch
```
protected boolean validateConnectionEachBatch
```
    If true, the connection is validated before committing each batch. If false, it is not.
  - preparedStatementSQL
```
protected String preparedStatementSQL
```
    The insert statement sql.
  - batchSize
```
protected int batchSize
```
    Batch size before doing a commit.
  - batch
```
protected List<Object[]> batch
```
    List for holding a batch until pageSize is reached and the batch is committed.
  - LOG
```
protected org.apache.log4j.Logger LOG
```
    Logging object of output.
- Constructor Detail
  - BaseDatabaseListener
```
public BaseDatabaseListener(DatabaseConnectionInformation databaseConnectionInformation,
                            String databaseName,
                            String databaseTable,
                            List<DatabaseField> fieldList)
```
    Constructor for using a fieldList. When this constructor is used, the insert sql statement is created for the fieldList. Note: if databaseName is not empty or null, the database name is prepended to the table. ie, if database name="myDB" and databaseTable = "myTable", the insert statement would be in the format insert into myDb.myTable If databaseName is empty or null, the insert statement only contains the table name.
    
    Parameters:
    
    databaseConnectionInformation - information on the database to connect to
    
    databaseName - The database name. This is prepended to the table in the insert statement.
    
    databaseTable - The database table fieldList belongs to.
    
    fieldList - The fields that will be inserted to from this listener.
  - BaseDatabaseListener
```
public BaseDatabaseListener(DatabaseConnectionInformation databaseConnectionInformation,
                            String preparedStatementSQL)
```
    Base gov.va.vinci.leo.listener.
    
    Parameters:
    
    databaseConnectionInformation - information on the database to connect to
    
    preparedStatementSQL - the prepared statement to use for inserts. For example: insert into myTable ( col1, col2, col2) values (?, ?, ?)
- Method Detail
  - isValidateConnectionEachBatch
```
public boolean isValidateConnectionEachBatch()
```
    Return true if the connection will be validated when executing each batch.
    
    Returns:
    
    validate connection batch flag value
  - setValidateConnectionEachBatch
```
public <T extends BaseDatabaseListener> T setValidateConnectionEachBatch(boolean validateConnectionEachBatch)
```
    Set the flag that if true will cause the connection to be validated when executing each batch.
    
    Parameters:
    
    validateConnectionEachBatch - validate connection batch flag value
    
    Returns:
    
    reference to this listener instance
  - getBatchSize
```
public int getBatchSize()
```
    Get the batch size for the number of records to accumulate before executing the batch. Defaults to 1.
    
    Returns:
    
    batch size
  - setBatchSize
```
public <T extends BaseDatabaseListener> T setBatchSize(int batchSize)
```
    Set the batch size for the number of records to accumulate before executing the batch. Defaults to 1.
    
    Parameters:
    
    batchSize - batch size
    
    Returns:
    
    reference to this listener instance
  - getRows
```
protected abstract List<Object[]> getRows(org.apache.uima.cas.CAS aCas)
```
    Abstract method: You must implement this method.
    
    Parameters:
    
    aCas - the currently processed CAS
    
    Returns:
    
    a list of object[]. Each entry in the list is a row to be inserted in the database, and each element in the object array is the column. This needs to match up with the prepared statement specified in the constructor.
  - entityProcessComplete
```
public void entityProcessComplete(org.apache.uima.cas.CAS aCas,
                                  org.apache.uima.collection.EntityProcessStatus aStatus)
```
    Specified by:
    
    entityProcessComplete in interface org.apache.uima.aae.client.UimaASStatusCallbackListener
    
    Overrides:
    
    entityProcessComplete in class BaseListener
    
    Parameters:
    
    aCas - the CAS containing the processed entity and the analysis results
    
    aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.
    
    See Also:
    
    UimaAsBaseCallbackListener.entityProcessComplete(org.apache.uima.cas.CAS, org.apache.uima.collection.EntityProcessStatus)
  - processBatch
```
protected void processBatch()
                     throws SQLException,
                            InstantiationException,
                            IllegalAccessException,
                            ClassNotFoundException
```
    This is called when a batch is ready to be send to the database. It connects to the database (if needed), created the prepared statement batch, and executes it.
    
    Throws:
    
    ClassNotFoundException - thrown if the JDBC driver cannot be found.
    
    IllegalAccessException - thrown if any of the reflection calls throw an exception.
    
    SQLException - thrown if there is an SQL Exception accessing the database.
    
    InstantiationException - thrown if the JDBC driver cannot be instantiated.
  - collectionProcessComplete
```
public void collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus aStatus)
```
    Specified by:
    
    collectionProcessComplete in interface org.apache.uima.aae.client.UimaASStatusCallbackListener
    
    Overrides:
    
    collectionProcessComplete in class BaseListener
    
    Parameters:
    
    aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.
    
    See Also:
    
    UimaAsBaseCallbackListener.collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus)
  - validateConnection
```
protected void validateConnection()
                           throws SQLException,
                                  InstantiationException,
                                  IllegalAccessException,
                                  ClassNotFoundException
```
    Method to validate the connection is not null, and if specified, run the validation query against the database. Any connection or query errors are thrown as exceptions.
    
    Throws:
    
    ClassNotFoundException - thrown if the JDBC driver cannot be found.
    
    IllegalAccessException - thrown if any of the reflection calls throw an exception.
    
    SQLException - thrown if there is an SQL Exception accessing the database.
    
    InstantiationException - thrown if the JDBC driver cannot be instantiated.
  - createTable
```
public void createTable(String createStatement,
                        boolean dropFirst,
                        String tableName)
                 throws ClassNotFoundException,
                        SQLException,
                        InstantiationException,
                        IllegalAccessException
```
    Creates the table structure.
    
    Parameters:
    
    createStatement - The sql create statement.
    
    dropFirst - If drop, the table is dropped before creation.
    
    tableName - The resulting table name.
    
    Throws:
    
    ClassNotFoundException - if the driver class is not in the classpath.
    
    SQLException - if there is an error executing the SQL to drop or create the table.
    
    InstantiationException - if there is an error creating the connection
    
    IllegalAccessException - if there is an error executing the query due to insufficient rights or the database cannot be reached.
  - createTable
```
public void createTable(boolean dropFirst,
                        String dbsName,
                        String tableName,
                        Map<String,String> fieldList)
                 throws ClassNotFoundException,
                        SQLException,
                        InstantiationException,
                        IllegalAccessException
```
    Creates the table structure.
    
    Parameters:
    
    dropFirst - If drop, the table is dropped before creation.
    
    dbsName - The database name (needed by some databases for the create statement)
    
    tableName - The resulting table name
    
    fieldList - A map of column names (key) and types (value) for example "id", "varchar(20)"
    
    Throws:
    
    ClassNotFoundException - if the driver class is not in the classpath.
    
    SQLException - if there is an error executing the SQL to drop or create the table.
    
    InstantiationException - if there is an error creating the connection
    
    IllegalAccessException - if there is an error executing the query due to insufficient rights or the database cannot be reached.
  - createTable
```
public void createTable(boolean dropFirst,
                        String dbsName,
                        String tableName,
                        List<DatabaseField> fieldList)
                 throws ClassNotFoundException,
                        SQLException,
                        InstantiationException,
                        IllegalAccessException
```
    Creates the table structure.
    
    Parameters:
    
    dropFirst - If drop, the table is dropped before creation.
    
    dbsName - The database name (needed by some databases for the create statement)
    
    tableName - The resulting table name
    
    fieldList - A map of column names (key) and types (value) for example "id", "varchar(20)"
    
    Throws:
    
    ClassNotFoundException - if the driver class is not in the classpath.
    
    SQLException - if there is an error executing the SQL to drop or create the table.
    
    InstantiationException - if there is an error creating the connection
    
    IllegalAccessException - if there is an error executing the query due to insufficient rights or the database cannot be reached.
  - createCreateStatement
```
protected String createCreateStatement(String dbsName,
                                       String tableName,
                                       List<DatabaseField> fieldList)
```
    Protected method to build a create table statement.
    
    Parameters:
    
    dbsName - the database name if needed.
    
    tableName - the table name.
    
    fieldList - A map of column names (key) and types (value) for example "id", "varchar(20)"
    
    Returns:
    
    The sql create statement.
  - createPreparedStatementSQL
```
protected String createPreparedStatementSQL(String databaseName,
                                            String tableName,
                                            List<DatabaseField> fields)
```
    Creates an insert sql statement for the list of fields. This requires using a constructor for this object that sets database name and database table. If database name is null, the sql statement is in the format: insert into tablename ... if database name is not null, the insert statement is in the format: insert into databasename.tablename ... NOTE: No sql escaping is performed! If using special characters or reserved works for column names, this will not work!
    
    Parameters:
    
    fields - the field list to create the insert statement for.
    
    Returns:
    
    the sql insert statement.

Class BaseDatabaseListener

Field Summary

Fields inherited from class gov.va.vinci.leo.listener.BaseListener

Constructor Summary

Method Summary

Methods inherited from class gov.va.vinci.leo.listener.BaseListener

Methods inherited from class org.apache.uima.aae.client.UimaAsBaseCallbackListener

Methods inherited from class java.lang.Object

Field Detail

conn

ps

databaseConnectionInformation

validateConnectionEachBatch

preparedStatementSQL

batchSize

batch

LOG

Constructor Detail

BaseDatabaseListener

BaseDatabaseListener

Method Detail

isValidateConnectionEachBatch

setValidateConnectionEachBatch

getBatchSize

setBatchSize

getRows

entityProcessComplete

processBatch

collectionProcessComplete

validateConnection

createTable

createTable

createTable

createCreateStatement

createPreparedStatementSQL