gov.va.vinci.leo.cr

Class BaseDatabaseCollectionReader

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

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:

DatabaseCollectionReader

public abstract class BaseDatabaseCollectionReader
extends BaseLeoCollectionReader

Retrieves rows from a database and returns them one at a time for extending readers to handle. Assumes there is one record per row of results. User: Thomas Ginter Date: 7/11/14 Time: 15:00

Field Summary

Fields

Modifier and Type	Field and Description
protected DataManager	dataManager DataManager that performs the query and returns the results.
protected String	driver Driver to be used for the database connection.
protected List<Object[]>	mRecordList List of Records that were returned by the query.
protected int	mRowIndex Index of the current analyte being processed, -1 if the query has not yet been executed.
protected String	password Password for this database.
protected String	url Connection URL for the database to be accessed.
protected String	username Username for this database.

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
BaseDatabaseCollectionReader() Default constructor used during UIMA initialization.
BaseDatabaseCollectionReader(DatabaseConnectionInformation databaseConnectionInformation) Initialize the connection information from the DatabaseConnectionInformation object.
BaseDatabaseCollectionReader(String driver, String url, String username, String password) Initialize the connection information to the parameters provided.

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.
protected DataManager	getDataManager() Get the data manager to run queries with.
String	getDriver() Get the Driver text string.
abstract void	getNext(org.apache.uima.cas.CAS aCAS)
String	getPassword() Get the database password.
abstract 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	getURL() Database connection URL.
String	getUsername() Return the database username.
abstract boolean	hasNext()
<T extends BaseDatabaseCollectionReader> T	setDriver(String driver) Set the driver name for this reader.
<T extends BaseDatabaseCollectionReader> T	setPassword(String password) Set the database password.
<T extends BaseDatabaseCollectionReader> T	setURL(String url) Set the driver URL.
<T extends BaseDatabaseCollectionReader> T	setUsername(String username) Set the database username.

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

driver

@LeoConfigurationParameter(mandatory=true)
protected String driver

Driver to be used for the database connection.

url

@LeoConfigurationParameter(mandatory=true)
protected String url

Connection URL for the database to be accessed.

username

@LeoConfigurationParameter
protected String username

Username for this database.

password

@LeoConfigurationParameter
protected String password

Password for this database.

mRowIndex

protected int mRowIndex

Index of the current analyte being processed, -1 if the query has not yet been executed.

mRecordList

protected List<Object[]> mRecordList

List of Records that were returned by the query.

dataManager

protected DataManager dataManager

DataManager that performs the query and returns the results. Metadata is stored in the Handler object which is cached in the DataManager after a query has been performed.

Constructor Detail

BaseDatabaseCollectionReader

public BaseDatabaseCollectionReader()

Default constructor used during UIMA initialization.

BaseDatabaseCollectionReader

public BaseDatabaseCollectionReader(DatabaseConnectionInformation databaseConnectionInformation)

Initialize the connection information from the DatabaseConnectionInformation object.

Parameters:

databaseConnectionInformation - database connection information to set.

BaseDatabaseCollectionReader

public BaseDatabaseCollectionReader(String driver,
                                    String url,
                                    String username,
                                    String password)

Initialize the connection information to the parameters provided.

Parameters:

driver - JDBC driver to use.

url - JDBC url for the connection.

username - username for database access.

password - password of the database access user.

Method Detail

getDriver

public String getDriver()

Get the Driver text string.

Returns:

driver string

setDriver

public <T extends BaseDatabaseCollectionReader> T setDriver(String driver)

Set the driver name for this reader.

Parameters:

driver - driver string

Returns:

reference to this reader instance

getURL

public String getURL()

Database connection URL.

Returns:

connection URL String

setURL

public <T extends BaseDatabaseCollectionReader> T setURL(String url)

Set the driver URL.

Parameters:

url - driver URL.

Returns:

reference to this reader instance

getUsername

public String getUsername()

Return the database username.

Returns:

database username

setUsername

public <T extends BaseDatabaseCollectionReader> T setUsername(String username)

Set the database username.

Parameters:

username - database username

Returns:

reference to this reader instance

getPassword

public String getPassword()

Get the database password.

Returns:

database password

setPassword

public <T extends BaseDatabaseCollectionReader> T setPassword(String password)

Set the database password.

Parameters:

password - database password

Returns:

reference to this reader instance

getNext

public abstract 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 BaseLeoCollectionReader

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 abstract boolean hasNext()
                         throws IOException,
                                org.apache.uima.collection.CollectionException

Specified by:

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

Specified by:

hasNext in class BaseLeoCollectionReader

Returns:

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

Throws:

IOException

org.apache.uima.collection.CollectionException

getProgress

public abstract 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.

Returns:

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

getData

protected void getData(String query)
                throws SQLException,
                       ClassNotFoundException,
                       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.

Parameters:

query - the sql query to run.

Throws:

ClassNotFoundException - if the driver cannot be found

SQLException - if there is an error executing the query

org.apache.uima.collection.CollectionException - if there is an error setting the data.

getDataManager

protected DataManager getDataManager()
                              throws SQLException,
                                     ClassNotFoundException

Get the data manager to run queries with.

Returns:

the data manager to run queries with.

Throws:

SQLException

ClassNotFoundException