gov.va.vinci.leo.cr

Class DatabaseCollectionReader

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CollectionReader_ImplBase

gov.va.vinci.leo.cr.BaseLeoCollectionReader

gov.va.vinci.leo.cr.BaseDatabaseCollectionReader

gov.va.vinci.leo.cr.DatabaseCollectionReader

All Implemented Interfaces:

LeoCollectionReaderInterface, org.apache.uima.collection.base_cpm.BaseCollectionReader, org.apache.uima.collection.CollectionReader, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

Direct Known Subclasses:

BatchDatabaseCollectionReader, SQLServerPagedDatabaseCollectionReader

public class DatabaseCollectionReader
extends BaseDatabaseCollectionReader

CollectionReader that executes a SQL query one time to pull the needed data from the database. Assumes one record per row of the ResultSet. User: Thomas Ginter Date: 7/11/14 Time: 17:08

Field Summary

Fields

Modifier and Type	Field and Description
protected String	idColumn Zero based index of the ID column in the query.
protected String	noteColumn Zero based index of the note column in the query.
protected String	query Query to be used to get the data.

Fields inherited from class gov.va.vinci.leo.cr.BaseDatabaseCollectionReader

dataManager, driver, mRecordList, mRowIndex, password, url, username

Fields inherited from class gov.va.vinci.leo.cr.BaseLeoCollectionReader

filters, textFilters

Fields inherited from interface org.apache.uima.resource.Resource

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

Constructors

Constructor and Description
DatabaseCollectionReader() Default constructor used during UIMA initialization.
DatabaseCollectionReader(DatabaseConnectionInformation databaseConnectionInformation, DataQueryInformation dataQueryInformation) Initialize with the database connection and query information.
DatabaseCollectionReader(DatabaseConnectionInformation databaseConnectionInformation, String query, String idColumn, String noteColumn) Initialize with the database connection and query information.
DatabaseCollectionReader(String driver, String url, String username, String password, String query, String idColumn, String noteColumn) Initialize with the database connection and query information.

Method Summary

Modifier and Type	Method and Description
protected void	getData(String query) Executes the query and saves the results internally to a List of Object[] to be retrieved when getNext() is called.
String	getIdColumn() Get the ID Column name.
void	getNext(org.apache.uima.cas.CAS aCAS)
String	getNoteColumn() Get the note column name.
org.apache.uima.util.Progress[]	getProgress() Gets information about the number of entities and/or amount of data that has been read from this CollectionReader, and the total amount that remains (if that information is available).
String	getQuery() Get the database query used to pull data.
boolean	hasNext()
<T extends DatabaseCollectionReader> T	setIdColumn(String idColumn) Set the ID column to be used.
<T extends DatabaseCollectionReader> T	setNoteColumn(String noteColumn) Set the note column name.
<T extends DatabaseCollectionReader> T	setQuery(String query) Set the database query used to pull data.
protected void	validateParams(String query, String idColumn, String noteColumn) Validate the parameters for the DatabaseCollectionReader to ensure that none of the required arguments are missing or invalid.

Methods inherited from class gov.va.vinci.leo.cr.BaseDatabaseCollectionReader

getDataManager, getDriver, getPassword, getURL, getUsername, setDriver, setPassword, setURL, setUsername

Methods inherited from class gov.va.vinci.leo.cr.BaseLeoCollectionReader

addFilters, addFilters, close, generateCollectionReaderDescription, getFilters, initialize, produceCollectionReader

Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase

destroy, getCasInitializer, getProcessingResourceMetaData, initialize, isConsuming, reconfigure, setCasInitializer, typeSystemInit

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

getCasManager, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.uima.resource.ConfigurableResource

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from interface org.apache.uima.resource.Resource

getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

query

@LeoConfigurationParameter(mandatory=true)
protected String query

Query to be used to get the data.

idColumn

@LeoConfigurationParameter(mandatory=true)
protected String idColumn

Zero based index of the ID column in the query.

noteColumn

@LeoConfigurationParameter(mandatory=true)
protected String noteColumn

Zero based index of the note column in the query.

Constructor Detail

DatabaseCollectionReader

public DatabaseCollectionReader()

Default constructor used during UIMA initialization.

DatabaseCollectionReader

public DatabaseCollectionReader(DatabaseConnectionInformation databaseConnectionInformation,
                                DataQueryInformation dataQueryInformation)

Initialize with the database connection and query information.

Parameters:

databaseConnectionInformation - database connection information to use.

dataQueryInformation - database query for retrieving results, assumes one record per row.

DatabaseCollectionReader

public DatabaseCollectionReader(DatabaseConnectionInformation databaseConnectionInformation,
                                String query,
                                String idColumn,
                                String noteColumn)

Initialize with the database connection and query information.

Parameters:

databaseConnectionInformation - database connection information to use.

query - SQL query used to retrieve the data, one record per row of results.

idColumn - name of the ID column in the SQL query. Assumes only one column to use as the record ID. Additional ID fields are propagated through the row results String array of the CSI annotation.

noteColumn - name of the note column in the SQL query. Assumes only one note column.

DatabaseCollectionReader

public DatabaseCollectionReader(String driver,
                                String url,
                                String username,
                                String password,
                                String query,
                                String idColumn,
                                String noteColumn)

Initialize with the database connection and query information.

Parameters:

driver - JDBC driver class

url - JDBC connection URL

username - database user name.

password - database user password.

query - SQL query used to retrieve the data, one record per row of results.

idColumn - name of the ID column in the SQL query. Assumes only one column to use as the record ID. Additional ID fields are propagated through the row results String array of the CSI annotation.

noteColumn - name of the note column in the SQL query. Assumes only one note column.

Method Detail

getQuery

public String getQuery()

Get the database query used to pull data.

Returns:

database query

setQuery

public <T extends DatabaseCollectionReader> T setQuery(String query)

Set the database query used to pull data.

Parameters:

query - database query

Returns:

reference to this reader instance

getIdColumn

public String getIdColumn()

Get the ID Column name.

Returns:

ID Column name

setIdColumn

public <T extends DatabaseCollectionReader> T setIdColumn(String idColumn)

Set the ID column to be used.

Parameters:

idColumn - ID column name

Returns:

reference to this reader instance

getNoteColumn

public String getNoteColumn()

Get the note column name.

Returns:

note column name

setNoteColumn

public <T extends DatabaseCollectionReader> T setNoteColumn(String noteColumn)

Set the note column name.

Parameters:

noteColumn - note column name

Returns:

reference to this reader instance

validateParams

protected void validateParams(String query,
                              String idColumn,
                              String noteColumn)

Validate the parameters for the DatabaseCollectionReader to ensure that none of the required arguments are missing or invalid.

Parameters:

query - SQL query to execute to retrieve the data.

idColumn - Name of the column from which the record ID will be maintained.

noteColumn - Name of the column which contains the note.

getNext

public void getNext(org.apache.uima.cas.CAS aCAS)
             throws org.apache.uima.collection.CollectionException,
                    IOException

Specified by:

getNext in interface org.apache.uima.collection.CollectionReader

Specified by:

getNext in class BaseDatabaseCollectionReader

Parameters:

aCAS - the CAS to populate with the next document;

Throws:

org.apache.uima.collection.CollectionException - if there is a problem getting the next and populating the CAS.

IOException

hasNext

public boolean hasNext()
                throws org.apache.uima.collection.CollectionException

Specified by:

hasNext in interface org.apache.uima.collection.base_cpm.BaseCollectionReader

Specified by:

hasNext in class BaseDatabaseCollectionReader

Returns:

true if and only if there are more elements available from this CollectionReader.

Throws:

org.apache.uima.collection.CollectionException

getData

protected void getData(String query)
                throws org.apache.uima.collection.CollectionException

Executes the query and saves the results internally to a List of Object[] to be retrieved when getNext() is called. Validates the id and note column field names.

Overrides:

getData in class BaseDatabaseCollectionReader

Parameters:

query - the sql query to run.

Throws:

org.apache.uima.collection.CollectionException - if there is an error in the query or with the id or column names

getProgress

public org.apache.uima.util.Progress[] getProgress()

Gets information about the number of entities and/or amount of data that has been read from this CollectionReader, and the total amount that remains (if that information is available).

This method returns an array of Progress objects so that results can be reported using different units. For example, the CollectionReader could report progress in terms of the number of documents that have been read and also in terms of the number of bytes that have been read. In many cases, it will be sufficient to return just one Progress object.

Specified by:

getProgress in interface org.apache.uima.collection.base_cpm.BaseCollectionReader

Specified by:

getProgress in class BaseDatabaseCollectionReader

Returns:

an array of Progress objects. Each object may have different units (for example number of entities or bytes).