com.northconcepts.datapipeline.jdbc

Class JdbcReader

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataReader

com.northconcepts.datapipeline.jdbc.JdbcReader

public class JdbcReader
extends DataReader

Obtains records from a database query.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

Fields

Modifier and Type	Field and Description
protected Record	currentRecord

Fields inherited from class com.northconcepts.datapipeline.core.DataReader

fieldLineage, recordLineage

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
JdbcReader(Connection connection, String queryString) Creates a new instance with the autoCloseConnection property set to false.
JdbcReader(Connection connection, String queryString, Object... parameters) Creates a new instance with the autoCloseConnection property set to false.
JdbcReader(Connection connection, String queryString, Object[] parameters, int[] parameterSqlTypes) Creates a new instance with the autoCloseConnection property set to false.
JdbcReader(JdbcConnectionFactory factory, String queryString) Creates a new instance with the autoCloseConnection property set to true.
JdbcReader(JdbcConnectionFactory factory, String queryString, Object... parameters) Creates a new instance with the autoCloseConnection property set to true.
JdbcReader(JdbcConnectionFactory factory, String queryString, Object[] parameters, int[] parameterSqlTypes) Creates a new instance with the autoCloseConnection property set to true.

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
protected Record	addLineage(Record record)
void	close() Indicates that this endpoint has finished reading or writing.
boolean	getAutoCloseConnection() Indicates if the database connection in this endpoint should be closed when the endpoint is closed.
Integer	getFetchSize() The fetch size to set on the Statement using Statement.setFetchSize(int) or null if the connection's default should be used (default null).
boolean	getUseColumnLabel()
JdbcValueReader	getValueReader()
boolean	isLineageSupported()
boolean	isStrictTypeMapping() Indicates if database types should be mapped to java type based only on java.sql.Types as defined by Sun/Oracle (defaults to false).
void	open() Makes this endpoint ready for reading or writing.
Record	read() Reads the next record from this DataReader and increases the record-count by 1.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
JdbcReader	setAutoCloseConnection(boolean closeConnection) Indicates if the database connection in this endpoint should be closed when the endpoint is closed.
JdbcReader	setFetchSize(Integer fetchSize) The fetch size to set on the Statement using Statement.setFetchSize(int) or null if the connection's default should be used (default null).
JdbcReader	setSaveLineage(boolean saveLineage)
JdbcReader	setStrictTypeMapping(boolean strictTypeMapping) Indicates if database types should be mapped to java type based only on java.sql.Types as defined by Sun/Oracle (defaults to false).
JdbcReader	setUseColumnLabel(boolean useColumnLabel) When set to true, column labels (or aliases) will be used for field names instead of the underlying, real column names.
JdbcReader	setValueReader(JdbcValueReader valueReader)

Methods inherited from class com.northconcepts.datapipeline.core.DataReader

available, getBufferSize, getNestedEndpoint, getNestedReader, getRootEndpoint, getRootReader, isExhausted, isSaveLineage, peek, pop, push, skip

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

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

Field Detail

currentRecord

protected Record currentRecord

Constructor Detail

JdbcReader

public JdbcReader(Connection connection,
                  String queryString)

Creates a new instance with the autoCloseConnection property set to false.

Parameters:

connection -

queryString -

JdbcReader

public JdbcReader(Connection connection,
                  String queryString,
                  Object... parameters)

Creates a new instance with the autoCloseConnection property set to false.

Parameters:

connection -

queryString -

parameters -

JdbcReader

public JdbcReader(Connection connection,
                  String queryString,
                  Object[] parameters,
                  int[] parameterSqlTypes)

Creates a new instance with the autoCloseConnection property set to false.

Parameters:

connection -

queryString -

parameters -

parameterSqlTypes -

JdbcReader

public JdbcReader(JdbcConnectionFactory factory,
                  String queryString)
           throws DataException

Creates a new instance with the autoCloseConnection property set to true.

Parameters:

factory -

queryString -

Throws:

DataException

JdbcReader

public JdbcReader(JdbcConnectionFactory factory,
                  String queryString,
                  Object... parameters)

Creates a new instance with the autoCloseConnection property set to true.

Parameters:

factory -

queryString -

parameters -

JdbcReader

public JdbcReader(JdbcConnectionFactory factory,
                  String queryString,
                  Object[] parameters,
                  int[] parameterSqlTypes)

Creates a new instance with the autoCloseConnection property set to true.

Parameters:

factory -

queryString -

parameters -

parameterSqlTypes -

Method Detail

getAutoCloseConnection

public boolean getAutoCloseConnection()

Indicates if the database connection in this endpoint should be closed when the endpoint is closed. The default is false if this instance was constructed with a Connection or true if constructed with a JdbcConnectionFactory.

setAutoCloseConnection

public JdbcReader setAutoCloseConnection(boolean closeConnection)

Indicates if the database connection in this endpoint should be closed when the endpoint is closed. The default is false if this instance was constructed with a Connection or true if constructed with a JdbcConnectionFactory.

getValueReader

public JdbcValueReader getValueReader()

setValueReader

public JdbcReader setValueReader(JdbcValueReader valueReader)

getUseColumnLabel

public boolean getUseColumnLabel()

getFetchSize

public Integer getFetchSize()

The fetch size to set on the Statement using Statement.setFetchSize(int) or null if the connection's default should be used (default null).

setFetchSize

public JdbcReader setFetchSize(Integer fetchSize)

The fetch size to set on the Statement using Statement.setFetchSize(int) or null if the connection's default should be used (default null).

setUseColumnLabel

public JdbcReader setUseColumnLabel(boolean useColumnLabel)

When set to true, column labels (or aliases) will be used for field names instead of the underlying, real column names. Defaults to false.

setSaveLineage

public JdbcReader setSaveLineage(boolean saveLineage)

Overrides:

setSaveLineage in class DataReader

isStrictTypeMapping

public boolean isStrictTypeMapping()

Indicates if database types should be mapped to java type based only on java.sql.Types as defined by Sun/Oracle (defaults to false). Otherwise, the column display size and scale will be considered for numeric types.

See Also:

JDBC / Relational Databases

setStrictTypeMapping

public JdbcReader setStrictTypeMapping(boolean strictTypeMapping)

Indicates if database types should be mapped to java type based only on java.sql.Types as defined by Sun/Oracle (defaults to false). Otherwise, the column display size and scale will be considered for numeric types.

See Also:

JDBC / Relational Databases

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: Endpoint

Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Overrides:

addExceptionProperties in class DataReader

read

public Record read()
            throws DataException

Description copied from class: DataReader

Reads the next record from this DataReader and increases the record-count by 1. This method will first read any pushed (DataReader.push(Record)) records before reading from the underlying source.

If no record is available, null will be returned. This method blocks until a record is available, the end of the stream is reached, or an exception is thrown.

Any exception raised while reading will be converted to a DataException using DataObject.exception(Throwable).

Subclasses generally do not need to override this method, instead they should implement DataReader.readImpl().

Overrides:

read in class DataReader

Throws:

DataException

See Also:

DataReader.push(Record), DataReader.peek(int), DataReader.read()

readImpl

protected Record readImpl()
                   throws Throwable

Description copied from class: DataReader

Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

If no record is available, null will be returned.

Specified by:

readImpl in class DataReader

Throws:

Throwable

isLineageSupported

public boolean isLineageSupported()

Overrides:

isLineageSupported in class DataReader

addLineage

protected Record addLineage(Record record)

Overrides:

addLineage in class DataReader

open

public void open()

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class DataEndpoint

close

public void close()

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint