com.northconcepts.datapipeline.excel

Class ExcelReader

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.core.AbstractReader

com.northconcepts.datapipeline.excel.ExcelReader

public class ExcelReader
extends AbstractReader

Obtains records from a Microsoft Excel document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExcelReader.FailedExpressionStrategy Indicates how to handle failures when evaluating cell formulas/expressions.

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

DataEndpoint.State

Field Summary

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

currentRecord, fieldNames, lastRow, startingRow

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
ExcelReader(ExcelDocument document)

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.
protected boolean	fillRecord(Record record)
ExcelDocument	getDocument()
ExcelReader.FailedExpressionStrategy	getFailedExpressionStrategy() Indicates how to handle failures when evaluating cell formulas/expressions (default ExcelReader.FailedExpressionStrategy.FAIL).
long	getLineNumber()
int	getSheetIndex()
String	getSheetName()
int	getStartingColumn()
boolean	isAutoCloseDocument() Indicates if the ExcelDocument should be closed when this endpoint is closed.
boolean	isEvaluateExpressions() Indicates if cell formulas/expressions should be evaluated and the result set as the field's value (default true), otherwise, the cell's formula will be set as the field's value and no evaluation will take place.
boolean	isLineageSupported()
boolean	isReadMetadata() Returns whether Excel metadata (such as hyperlinks and cell styles) should be read.
boolean	isUseSheetColumnCount()
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.
ExcelReader	setAutoCloseDocument(boolean autoCloseDocument) Indicates if the ExcelDocument should be closed when this endpoint is closed.
ExcelReader	setDescription(String description)
ExcelReader	setEvaluateExpressions(boolean evaluateExpressions) Indicates if cell formulas/expressions should be evaluated and the result set as the field's value (default true), otherwise, the cell's formula will be set as the field's value and no evaluation will take place.
ExcelReader	setFailedExpressionStrategy(ExcelReader.FailedExpressionStrategy failedExpressionStrategy) Indicates how to handle failures when evaluating cell formulas/expressions (default ExcelReader.FailedExpressionStrategy.FAIL).
ExcelReader	setFieldNames(Collection<String> fieldNames)
ExcelReader	setFieldNames(String... fieldNames)
ExcelReader	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
ExcelReader	setLastRow(int lastRow)
ExcelReader	setReadMetadata(boolean readMetadata) Sets whether Excel metadata (such as hyperlinks and cell styles) should be read.
ExcelReader	setSaveLineage(boolean saveLineage)
ExcelReader	setSheetIndex(int sheetIndex)
ExcelReader	setSheetName(String sheetName)
ExcelReader	setSkipEmptyRows(boolean skipEmptyRows) Indicates that rows with only null values should not be returned by the reader (default is false).
ExcelReader	setStartingColumn(int startingColumn)
ExcelReader	setStartingRow(int startingRow)
ExcelReader	setUseSheetColumnCount(boolean useSheetColumnCount) Set whether to use the entire worksheet (or just the current row) when determining each record's field count.

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

getFieldNames, getLastRow, getStartingRow, isFieldNamesInFirstRow, isSkipEmptyRows, readImpl

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

available, getBufferSize, getNestedEndpoint, getNestedReader, getReader, 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

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

Constructor Detail

ExcelReader

public ExcelReader(ExcelDocument document)

Method Detail

open

public void open()

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class AbstractReader

close

public void close()
           throws DataException

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

Throws:

DataException

getDocument

public ExcelDocument getDocument()

getSheetName

public String getSheetName()

setSheetName

public ExcelReader setSheetName(String sheetName)

getSheetIndex

public int getSheetIndex()

setSheetIndex

public ExcelReader setSheetIndex(int sheetIndex)

getStartingColumn

public int getStartingColumn()

setStartingColumn

public ExcelReader setStartingColumn(int startingColumn)

getLineNumber

public long getLineNumber()

isEvaluateExpressions

public boolean isEvaluateExpressions()

Indicates if cell formulas/expressions should be evaluated and the result set as the field's value (default true), otherwise, the cell's formula will be set as the field's value and no evaluation will take place.

setEvaluateExpressions

public ExcelReader setEvaluateExpressions(boolean evaluateExpressions)

Indicates if cell formulas/expressions should be evaluated and the result set as the field's value (default true), otherwise, the cell's formula will be set as the field's value and no evaluation will take place.

getFailedExpressionStrategy

public ExcelReader.FailedExpressionStrategy getFailedExpressionStrategy()

Indicates how to handle failures when evaluating cell formulas/expressions (default ExcelReader.FailedExpressionStrategy.FAIL). This only applies when setEvaluateExpressions(boolean) is set to true (the default) and evaluation fails.

See Also:

#isEvaluateExpressions()}, #setEvaluateExpressions(boolean)}

setFailedExpressionStrategy

public ExcelReader setFailedExpressionStrategy(ExcelReader.FailedExpressionStrategy failedExpressionStrategy)

Indicates how to handle failures when evaluating cell formulas/expressions (default ExcelReader.FailedExpressionStrategy.FAIL). This only applies when setEvaluateExpressions(boolean) is set to true (the default) and evaluation fails.

See Also:

#isEvaluateExpressions()}, #setEvaluateExpressions(boolean)}

isUseSheetColumnCount

public boolean isUseSheetColumnCount()

setUseSheetColumnCount

public ExcelReader setUseSheetColumnCount(boolean useSheetColumnCount)

Set whether to use the entire worksheet (or just the current row) when determining each record's field count. Default is false meaning each record may contain a different number of fields depending on the row.

setAutoCloseDocument

public ExcelReader setAutoCloseDocument(boolean autoCloseDocument)

Indicates if the ExcelDocument should be closed when this endpoint is closed. The default is false.

isAutoCloseDocument

public boolean isAutoCloseDocument()

Indicates if the ExcelDocument should be closed when this endpoint is closed. The default is false.

setFieldNamesInFirstRow

public ExcelReader setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

Overrides:

setFieldNamesInFirstRow in class AbstractReader

setFieldNames

public ExcelReader setFieldNames(String... fieldNames)

Overrides:

setFieldNames in class AbstractReader

setFieldNames

public ExcelReader setFieldNames(Collection<String> fieldNames)

Overrides:

setFieldNames in class AbstractReader

setStartingRow

public ExcelReader setStartingRow(int startingRow)

Overrides:

setStartingRow in class AbstractReader

setLastRow

public ExcelReader setLastRow(int lastRow)

Overrides:

setLastRow in class AbstractReader

setSkipEmptyRows

public ExcelReader setSkipEmptyRows(boolean skipEmptyRows)

Description copied from class: AbstractReader

Indicates that rows with only null values should not be returned by the reader (default is false).

Overrides:

setSkipEmptyRows in class AbstractReader

setSaveLineage

public ExcelReader setSaveLineage(boolean saveLineage)

Overrides:

setSaveLineage in class DataReader

setDescription

public ExcelReader setDescription(String description)

Overrides:

setDescription in class Endpoint

fillRecord

protected boolean fillRecord(Record record)
                      throws Throwable

Specified by:

fillRecord in class AbstractReader

Throws:

Throwable

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 AbstractReader

Throws:

DataException

See Also:

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

isLineageSupported

public boolean isLineageSupported()

Overrides:

isLineageSupported in class DataReader

addLineage

protected Record addLineage(Record record)

Overrides:

addLineage in class DataReader

isReadMetadata

public boolean isReadMetadata()

Returns whether Excel metadata (such as hyperlinks and cell styles) should be read. When enabled, metadata is attached to fields as session properties that can be retrieved using ExcelFieldMetadata.

Returns:

true if metadata reading is enabled, false otherwise (default is false)

See Also:

ExcelFieldMetadata

setReadMetadata

public ExcelReader setReadMetadata(boolean readMetadata)

Sets whether Excel metadata (such as hyperlinks and cell styles) should be read. When enabled, metadata is attached to fields as session properties that can be retrieved using ExcelFieldMetadata.

Parameters:

readMetadata - true to enable metadata reading, false to disable (default is false)

Returns:

this ExcelReader instance for method chaining

See Also:

ExcelFieldMetadata

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 AbstractReader