com.neurosys.etl.excel.readers

Class ExcelRowByRowReader<T>

java.lang.Object

com.neurosys.etl.process.EventAwareProcess

com.neurosys.etl.readers.BaseIterativeProcessor<TUPLE_IN,RECORD_OUT,STATE>

com.neurosys.etl.readers.AbstractReader<org.apache.poi.ss.usermodel.Row,T,Long>

com.neurosys.etl.excel.readers.ExcelRowByRowReader<T>

All Implemented Interfaces:

FailFastAware, Identifiable, ParamsAware, BatchProcess, ControllableProcess<Long>, Process, RealTimeLineReader<T>, ResourceAwareRealTimeLineReader<T>, TransformAwareReader, TupleContextAwareReader<org.apache.poi.ss.usermodel.Row,T>, Serializable, Iterator<T>

Direct Known Subclasses:

ExcelContextualReader

public class ExcelRowByRowReader<T>
extends AbstractReader<org.apache.poi.ss.usermodel.Row,T,Long>

Parse an Excel File Row by Row; the Row is represented by A simple List of values.
This implementation loads an Excel FileInputStream straight into memory.

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.neurosys.etl.process.Process

Process.Event, Process.EventPoint

Field Summary

Fields

Modifier and Type	Field and Description
protected int	TIMEOUT_LOAD_IO_SECONDS The time it should load the file in
protected Iterator<org.apache.poi.ss.usermodel.Row>	worksheetRowIter

Fields inherited from class com.neurosys.etl.readers.BaseIterativeProcessor

exceptions, failFast, filter, hasNext, index, messages, params, paused, resource, transformer

Fields inherited from class com.neurosys.etl.process.EventAwareProcess

listeners, processState

Constructor Summary

Constructors

Constructor and Description
ExcelRowByRowReader() Default Constructor to allow lazy initialization If so, init() must be called by the calling API explicitly after calling BaseIterativeProcessor.setResource(Resource)
ExcelRowByRowReader(org.springframework.core.io.Resource resource)

Method Summary

Modifier and Type	Method and Description
void	dispose() Un-initialize reader, so that it maybe re consumed Except for the main Resource & configuration set by Spring context all other instance variables used will be re-set/disposed/cleared.
protected boolean	filter(org.apache.poi.ss.usermodel.Row tuple) A false will filter out the record, i.e.
Long	getCurrentRawIndex(org.apache.poi.ss.usermodel.Row row) Get the raw index/position on the source; BaseIterativeProcessor.getCurrentIndex() only tracks the relevant position.
Long	getState() Get current state of process
int	getTIMEOUT_LOAD_IO_SECONDS() The time it should load the file in
org.apache.poi.ss.usermodel.Sheet	getWorksheet()
int	getWorksheetIndex() One reader can be assigned to one worksheet.
boolean	hasNext() True if there is another record that can be read by the parser, false implies end of parse/read
void	init() Allow lazy initialization of Reader in cases where the resource may not be known @ PostConstruct time
boolean	isInitialized() Allow the calling API to determine if the reader has been initialized via RealTimeLineReader.init() or PostConstruct phase If not RealTimeLineReader.init() should be called upon the instance.
protected org.apache.poi.ss.usermodel.Row	nextRecord()
protected org.apache.poi.ss.usermodel.Workbook	readBookTypeFromResource() Determine the resource type, from extension XLS (HSSF format) or XLSX type Defaults to XSSF format (XSSF)
void	resume()
void	resumeFromState(Long state) Resume process from the given State provided
void	setTIMEOUT_LOAD_IO_SECONDS(int tIMEOUT_LOAD_IO_SECONDS) The time it should load the file in
void	setWorksheetIndex(int worksheetIndex) One reader can be assigned to one worksheet.
Long	size() Get number of tuples/records in resource

Methods inherited from class com.neurosys.etl.readers.BaseIterativeProcessor

close, getCurrentIndex, getCurrentTupleIdentifier, getExceptions, getFilter, getId, getMessages, getMeta, getParams, getResource, getSourceLocation, getTransformer, handleMiscException, isFailFast, isPaused, kill, next, nextTupleResult, pause, remove, setExceptions, setFailFast, setFilter, setId, setMessages, setMeta, setParams, setResource, setTransformer, stop, transform

Methods inherited from class com.neurosys.etl.process.EventAwareProcess

addListener, getListeners, onChangeHandler, setListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

worksheetRowIter

protected transient Iterator<org.apache.poi.ss.usermodel.Row> worksheetRowIter

TIMEOUT_LOAD_IO_SECONDS

protected int TIMEOUT_LOAD_IO_SECONDS

The time it should load the file in

Constructor Detail

ExcelRowByRowReader

public ExcelRowByRowReader(org.springframework.core.io.Resource resource)

ExcelRowByRowReader

public ExcelRowByRowReader()

Default Constructor to allow lazy initialization
If so, init() must be called by the calling API explicitly after calling BaseIterativeProcessor.setResource(Resource)

Method Detail

readBookTypeFromResource

protected org.apache.poi.ss.usermodel.Workbook readBookTypeFromResource()
                                                                 throws IOException

Determine the resource type, from extension XLS (HSSF format) or XLSX type Defaults to XSSF format (XSSF)

Parameters:

poiFs - as POIFSFileSystem

Returns:

Throws:

IOException

See Also:

http://poi.apache.org/spreadsheet/index.html, Features for different Types

init

@PostConstruct
public void init()
                         throws IOException,
                                Exception

Description copied from interface: RealTimeLineReader

Allow lazy initialization of Reader in cases where the resource may not be known @ PostConstruct time

Specified by:

init in interface RealTimeLineReader<T>

Overrides:

init in class BaseIterativeProcessor<org.apache.poi.ss.usermodel.Row,T,Long>

Throws:

Exception

IOException

filter

protected boolean filter(org.apache.poi.ss.usermodel.Row tuple)

Description copied from class: BaseIterativeProcessor

A false will filter out the record, i.e. not consider it.

Overrides:

filter in class BaseIterativeProcessor<org.apache.poi.ss.usermodel.Row,T,Long>

Parameters:

tuple - as

Returns:

boolean

getWorksheetIndex

public int getWorksheetIndex()

One reader can be assigned to one worksheet. This is the index in the workbook that corresponds to the worksheet it will read.

Default value:

0

setWorksheetIndex

public void setWorksheetIndex(int worksheetIndex)

One reader can be assigned to one worksheet. This is the index in the workbook that corresponds to the worksheet it will read.

Default value:

0

dispose

public void dispose()

Description copied from interface: RealTimeLineReader

Un-initialize reader, so that it maybe re consumed
Except for the main Resource & configuration set by Spring context all other instance variables used will be re-set/disposed/cleared.

isInitialized

public boolean isInitialized()
                      throws Exception

Description copied from interface: RealTimeLineReader

Allow the calling API to determine if the reader has been initialized via RealTimeLineReader.init() or PostConstruct phase
If not RealTimeLineReader.init() should be called upon the instance.

Throws:

Exception

hasNext

public boolean hasNext()

Description copied from interface: RealTimeLineReader

True if there is another record that can be read by the parser, false implies end of parse/read

Specified by:

hasNext in interface RealTimeLineReader<T>

Specified by:

hasNext in interface Iterator<T>

Overrides:

hasNext in class BaseIterativeProcessor<org.apache.poi.ss.usermodel.Row,T,Long>

Returns:

boolean

resume

public void resume()
            throws Exception

Specified by:

resume in interface ControllableProcess<Long>

Overrides:

resume in class BaseIterativeProcessor<org.apache.poi.ss.usermodel.Row,T,Long>

Throws:

Exception

nextRecord

protected org.apache.poi.ss.usermodel.Row nextRecord()

Specified by:

nextRecord in class BaseIterativeProcessor<org.apache.poi.ss.usermodel.Row,T,Long>

size

public Long size()

Description copied from interface: ResourceAwareRealTimeLineReader

Get number of tuples/records in resource

Returns:

Long

resumeFromState

public void resumeFromState(Long state)
                     throws Exception

Description copied from interface: ControllableProcess

Resume process from the given State provided

Throws:

Exception

getCurrentRawIndex

public Long getCurrentRawIndex(org.apache.poi.ss.usermodel.Row row)

Description copied from class: BaseIterativeProcessor

Get the raw index/position on the source; BaseIterativeProcessor.getCurrentIndex() only tracks the relevant position. This method allows us to get the position on the source.
In many cases/implementations this maybe used internally to derive the BaseIterativeProcessor.getCurrentIndex()

Specified by:

getCurrentRawIndex in class BaseIterativeProcessor<org.apache.poi.ss.usermodel.Row,T,Long>

Returns:

Long

getState

public Long getState()

Description copied from interface: ControllableProcess

Get current state of process

getWorksheet

public org.apache.poi.ss.usermodel.Sheet getWorksheet()

getTIMEOUT_LOAD_IO_SECONDS

public int getTIMEOUT_LOAD_IO_SECONDS()

The time it should load the file in

setTIMEOUT_LOAD_IO_SECONDS

public void setTIMEOUT_LOAD_IO_SECONDS(int tIMEOUT_LOAD_IO_SECONDS)

The time it should load the file in