org.apache.ctakes.ytex.uima

Class DBCollectionReader

java.lang.Object

CollectionReader_ImplBase

org.apache.ctakes.ytex.uima.DBCollectionReader

public class DBCollectionReader
extends CollectionReader_ImplBase

Read documents from db. Config parameters:

• queryGetDocumentKeys the query to get the document keys
• queryGetDocument the query to get a document given a key. should have named parameters that match the columns of the result set returned by queryGetDocumentKeys
• keyTypeName the uima type of the document key to be added to the cas. defaults to org.apache.ctakes.ytex.uima.types.DocKey.
• keyNameToLowerCase convert the column names returned by queryGetDocumentKeys to lower case, default true

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.sql.DataSource	dataSource
(package private) int	i
protected boolean	keyNameToLowerCase
protected java.lang.String	keyTypeName the key type.
(package private) java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listDocumentIds
private static Log	log
protected NamedParameterJdbcTemplate	namedJdbcTemplate
protected java.lang.String	queryGetDocument the queyr to get a document given a key.
protected java.lang.String	queryGetDocumentKeys the query to get the document keys set in config file
protected SimpleJdbcTemplate	simpleJdbcTemplate
protected TransactionTemplate	txTemplate

Constructor Summary

Constructors

Constructor and Description
DBCollectionReader()

Method Summary

Methods

Modifier and Type	Method and Description
private void	addDocKey(JCas aCAS, java.util.Map<java.lang.String,java.lang.Object> id)
void	close()
protected void	getDocumentById(JCas aCAS, java.util.Map<java.lang.String,java.lang.Object> id)
void	getNext(CAS aCAS)
void	getNext(JCas aCAS)
Progress[]	getProgress()
boolean	hasNext()
protected void	initDB(java.lang.String dbDriver, java.lang.String dbURL)
void	initialize()
protected void	initializePreLoad()
boolean	isKeyNameToLowerCase()
protected void	loadDocumentIds()
void	setKeyNameToLowerCase(boolean keyNameToLowerCase)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final Log log

queryGetDocumentKeys

protected java.lang.String queryGetDocumentKeys

the query to get the document keys set in config file

queryGetDocument

protected java.lang.String queryGetDocument

the queyr to get a document given a key. set in config file

keyTypeName

protected java.lang.String keyTypeName

the key type. if not set, will default to org.apache.ctakes.ytex.uima.types.DocKey

dataSource

protected javax.sql.DataSource dataSource

simpleJdbcTemplate

protected SimpleJdbcTemplate simpleJdbcTemplate

namedJdbcTemplate

protected NamedParameterJdbcTemplate namedJdbcTemplate

txTemplate

protected TransactionTemplate txTemplate

keyNameToLowerCase

protected boolean keyNameToLowerCase

listDocumentIds

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> listDocumentIds

i

int i

Constructor Detail

DBCollectionReader

public DBCollectionReader()

Method Detail

isKeyNameToLowerCase

public boolean isKeyNameToLowerCase()

setKeyNameToLowerCase

public void setKeyNameToLowerCase(boolean keyNameToLowerCase)

initialize

public void initialize()
                throws ResourceInitializationException

Throws:

ResourceInitializationException

initializePreLoad

protected void initializePreLoad()
                          throws ResourceInitializationException

Throws:

ResourceInitializationException

initDB

protected void initDB(java.lang.String dbDriver,
          java.lang.String dbURL)
               throws ResourceInitializationException

Throws:

ResourceInitializationException

loadDocumentIds

protected void loadDocumentIds()

getNext

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

Throws:

java.io.IOException

CollectionException

getNext

public void getNext(JCas aCAS)
             throws java.io.IOException,
                    CollectionException

Throws:

java.io.IOException

CollectionException

addDocKey

private void addDocKey(JCas aCAS,
             java.util.Map<java.lang.String,java.lang.Object> id)
                throws CollectionException

Throws:

CollectionException

getDocumentById

protected void getDocumentById(JCas aCAS,
                   java.util.Map<java.lang.String,java.lang.Object> id)

getProgress

public Progress[] getProgress()

hasNext

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

Throws:

java.io.IOException

CollectionException

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException