de.julielab.jcore.reader.db

Class DBSubsetReader

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CollectionReader_ImplBase

org.apache.uima.fit.component.JCasCollectionReader_ImplBase

de.julielab.jcore.reader.db.DBReaderBase

de.julielab.jcore.reader.db.DBSubsetReader

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

Direct Known Subclasses:

DBMultiplierReader, DBReader

public abstract class DBSubsetReader
extends DBReaderBase

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	additionalTableNames
protected String[]	additionalTableSchemas
protected String	dataTable The name of the primary data table to read data from.
protected Boolean	fetchIdsProactively
protected String	hostName
static String	PARAM_ADDITIONAL_TABLES
static String	PARAM_ADDITONAL_TABLES_STORAGE_PG_SCHEMA
static String	PARAM_RESET_TABLE
protected String	pid
protected Boolean	readDataTable This is true if the table name provided by the DBReaderBase.PARAM_TABLE parameter is a data table.
protected Boolean	resetTable
protected String[]	schemas The list of table schemas of the tables to read from.
protected String[]	tables The list of tables to read data from.

Fields inherited from class de.julielab.jcore.reader.db.DBReaderBase

batchSize, costosysConfig, dbc, driver, hasNext, joinTables, limitParameter, numberFetchedDocIDs, PARAM_BATCH_SIZE, PARAM_COSTOSYS_CONFIG_NAME, PARAM_TABLE, processedDocuments, selectionOrder, tableName, totalDocumentCount, whereCondition

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
DBSubsetReader()

Method Summary

Modifier and Type	Method and Description
protected void	checkAdditionalTableParameters(String[] additionalTableNames, String[] additionalTableSchemas) This method checks whether the required parameters are set to meaningful values and throws an IllegalArgumentException when not.
protected org.apache.commons.lang3.tuple.ImmutablePair<Integer,String[]>	checkAndAdjustAdditionalTables(de.julielab.xmlData.dataBase.DataBaseConnector dbc, String dataTable, String[] additionalTableNames) Checks whether the given additional tables exist.
protected List<Map<String,Object>>	getAllRetrievedColumns() Convenience method for extending classes.
void	initialize(org.apache.uima.UimaContext context)

Methods inherited from class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

close, getLogger, getNext, getNext, 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, getMetaData, getRelativePathResolver, 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.collection.base_cpm.BaseCollectionReader

getProgress, hasNext

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

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

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

getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

PARAM_ADDITIONAL_TABLES

public static final String PARAM_ADDITIONAL_TABLES

See Also:

Constant Field Values

PARAM_RESET_TABLE

public static final String PARAM_RESET_TABLE

See Also:

Constant Field Values

PARAM_ADDITONAL_TABLES_STORAGE_PG_SCHEMA

public static final String PARAM_ADDITONAL_TABLES_STORAGE_PG_SCHEMA

See Also:

Constant Field Values

resetTable

protected Boolean resetTable

fetchIdsProactively

protected Boolean fetchIdsProactively

additionalTableNames

protected String[] additionalTableNames

additionalTableSchemas

protected String[] additionalTableSchemas

hostName

protected String hostName

pid

protected String pid

dataTable

protected String dataTable

The name of the primary data table to read data from. This is either the exact parameter value given with DBReaderBase.PARAM_TABLE or, if this parameter denotes a subset table, the data table referenced by the subset.

readDataTable

protected Boolean readDataTable

This is true if the table name provided by the DBReaderBase.PARAM_TABLE parameter is a data table. If this parameter is false it means that we read from a subset table.

tables

protected String[] tables

The list of tables to read data from. The first element is always the data table. The following entries reference the "additional tables".

schemas

protected String[] schemas

The list of table schemas of the tables to read from. This is parallel to tables.

Constructor Detail

DBSubsetReader

public DBSubsetReader()

Method Detail

initialize

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

Overrides:

initialize in class DBReaderBase

Throws:

org.apache.uima.resource.ResourceInitializationException

getAllRetrievedColumns

protected List<Map<String,Object>> getAllRetrievedColumns()

Convenience method for extending classes.

Returns:

checkAdditionalTableParameters

protected void checkAdditionalTableParameters(String[] additionalTableNames,
                                              String[] additionalTableSchemas)
                                       throws org.apache.uima.resource.ResourceInitializationException

This method checks whether the required parameters are set to meaningful values and throws an IllegalArgumentException when not.

Throws:

org.apache.uima.resource.ResourceInitializationException

checkAndAdjustAdditionalTables

protected org.apache.commons.lang3.tuple.ImmutablePair<Integer,String[]> checkAndAdjustAdditionalTables(de.julielab.xmlData.dataBase.DataBaseConnector dbc,
                                                                                                        String dataTable,
                                                                                                        String[] additionalTableNames)

Checks whether the given additional tables exist. If not, it is checked if the table names contain dots which are reserved for schema qualification in Postgres. It is tried again to find the tables with underscores ('_'), then. In this case, a colon character is interpreted as the separation between a specified Postgres schema and a Java-style path to be converted to a valid table name by replacing dots with underscores. Always includes the data table.