org.apache.ctakes.core.cr
Class JdbcCollectionReader

java.lang.Object
  org.apache.uima.resource.Resource_ImplBase
      org.apache.uima.resource.ConfigurableResource_ImplBase
          org.apache.uima.collection.CollectionReader_ImplBase
              org.apache.ctakes.core.cr.JdbcCollectionReader

All Implemented Interfaces:

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

public class JdbcCollectionReader
extends org.apache.uima.collection.CollectionReader_ImplBase

Collection Reader that pulls documents to be processed from a database.

Author:

Mayo Clinic

Field Summary

static java.lang.String	PARAM_DB_CONN_RESRC Name of external resource for database connection.
static java.lang.String	PARAM_DOCID_COLS Optional parameter.
static java.lang.String	PARAM_DOCID_DELIMITER Optional parameter.
static java.lang.String	PARAM_DOCTEXT_COL Name of column from resultset that contains the document text.
static java.lang.String	PARAM_SQL SQL statement to retrieve the document.
static java.lang.String	PARAM_VALUE_FILE_RESRC Optional parameter.

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

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

JdbcCollectionReader()

Method Summary

void	close()
void	getNext(org.apache.uima.cas.CAS cas)
org.apache.uima.util.Progress[]	getProgress()
boolean	hasNext()
void	initialize()

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

PARAM_SQL

public static final java.lang.String PARAM_SQL

SQL statement to retrieve the document.

See Also:

Constant Field Values

PARAM_DOCTEXT_COL

public static final java.lang.String PARAM_DOCTEXT_COL

Name of column from resultset that contains the document text. Supported column types are CHAR, VARCHAR, and CLOB.

See Also:

Constant Field Values

PARAM_DB_CONN_RESRC

public static final java.lang.String PARAM_DB_CONN_RESRC

Name of external resource for database connection.

See Also:

Constant Field Values

PARAM_DOCID_COLS

public static final java.lang.String PARAM_DOCID_COLS

Optional parameter. Specifies column names that will be used to form a document ID.

See Also:

Constant Field Values

PARAM_DOCID_DELIMITER

public static final java.lang.String PARAM_DOCID_DELIMITER

Optional parameter. Specifies delimiter used when document ID is built.

See Also:

Constant Field Values

PARAM_VALUE_FILE_RESRC

public static final java.lang.String PARAM_VALUE_FILE_RESRC

Optional parameter. Name of external resource for prepared statement value file. Each line of this file represents prepared statement values that will be used to substitute for the "?" placeholders. TAB character \t is used to delimit the values on a single line. The prepared statement will be called once for each line in this file.

See Also:

Constant Field Values

Constructor Detail

JdbcCollectionReader

public JdbcCollectionReader()

Method Detail

initialize

public void initialize()
                throws org.apache.uima.resource.ResourceInitializationException

Overrides:

initialize in class org.apache.uima.collection.CollectionReader_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

getNext

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

Throws:

java.io.IOException

org.apache.uima.collection.CollectionException

hasNext

public boolean hasNext()
                throws java.io.IOException,
                       org.apache.uima.collection.CollectionException

Throws:

java.io.IOException

org.apache.uima.collection.CollectionException

getProgress

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

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException