org.apache.ctakes.core.cr

Class JdbcCollectionReader

java.lang.Object

CollectionReader_ImplBase

org.apache.ctakes.core.cr.JdbcCollectionReader

public class JdbcCollectionReader
extends CollectionReader_ImplBase

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

Field Summary

Fields

Modifier and Type	Field and Description
private int	currRowCount
private int	docColType
private java.lang.String	docColTypeName
private java.lang.String[]	docIdColNames
private java.lang.String	docIdDelimiter
private java.lang.String	docTextColName
private Logger	logger
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.
private java.util.List<java.lang.String>[]	prepStmtValArr
private int	prepStmtValArrIdx
private java.sql.PreparedStatement	queryPrepStmt
private java.sql.ResultSet	rs
private int	totalRowCount
private boolean	usePrepStmtVals

Constructor Summary

Constructors

Constructor and Description
JdbcCollectionReader()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
private java.lang.String	convertToString(java.sql.Clob clob) Loads the clob data into a String object.
private java.lang.String	getDocumentID(java.sql.ResultSet rs) Builds a document ID from one or more pieces of query data.
void	getNext(CAS cas)
Progress[]	getProgress()
private int	getRowCount(java.sql.Connection conn, java.lang.String querySql) Slice up the query SQL and rebuild a SQL statement that gets a row count;
boolean	hasNext()
void	initialize()
private void	loadValueFile(java.io.File valueFile) Loads the prepared statement value file.
private void	setPrepStmtValues(java.sql.PreparedStatement prepStmt, java.util.List<java.lang.String> valList) Helper method that sets the prepared statement values.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private Logger logger

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

queryPrepStmt

private java.sql.PreparedStatement queryPrepStmt

rs

private java.sql.ResultSet rs

docTextColName

private java.lang.String docTextColName

docColType

private int docColType

docColTypeName

private java.lang.String docColTypeName

docIdColNames

private java.lang.String[] docIdColNames

docIdDelimiter

private java.lang.String docIdDelimiter

totalRowCount

private int totalRowCount

currRowCount

private int currRowCount

prepStmtValArr

private java.util.List<java.lang.String>[] prepStmtValArr

prepStmtValArrIdx

private int prepStmtValArrIdx

usePrepStmtVals

private boolean usePrepStmtVals

Constructor Detail

JdbcCollectionReader

public JdbcCollectionReader()

Method Detail

initialize

public void initialize()
                throws ResourceInitializationException

Throws:

ResourceInitializationException

loadValueFile

private void loadValueFile(java.io.File valueFile)
                    throws java.io.IOException

Loads the prepared statement value file.

Parameters:

valueFile -

Throws:

java.io.IOException

getRowCount

private int getRowCount(java.sql.Connection conn,
              java.lang.String querySql)
                 throws java.sql.SQLException

Slice up the query SQL and rebuild a SQL statement that gets a row count;

Parameters:

querySql -

Returns:

Throws:

java.sql.SQLException

setPrepStmtValues

private void setPrepStmtValues(java.sql.PreparedStatement prepStmt,
                     java.util.List<java.lang.String> valList)
                        throws java.sql.SQLException

Helper method that sets the prepared statement values.

Parameters:

prepStmt -

valList -

Throws:

java.sql.SQLException

getNext

public void getNext(CAS cas)
             throws java.io.IOException,
                    CollectionException

Throws:

java.io.IOException

CollectionException

getDocumentID

private java.lang.String getDocumentID(java.sql.ResultSet rs)
                                throws java.sql.SQLException

Builds a document ID from one or more pieces of query data. If the query data is not specified, the current row # is used.

Parameters:

rs -

Returns:

Throws:

java.sql.SQLException

convertToString

private java.lang.String convertToString(java.sql.Clob clob)
                                  throws java.sql.SQLException,
                                         java.io.IOException

Loads the clob data into a String object.

Parameters:

clob -

Returns:

Throws:

java.sql.SQLException

java.io.IOException

hasNext

public boolean hasNext()
                throws java.io.IOException,
                       CollectionException

Throws:

java.io.IOException

CollectionException

getProgress

public Progress[] getProgress()

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException