com.neurosys.etl.excel.transformers

Class AbstractExcelRowToEntityTransformer<T>

java.lang.Object

com.neurosys.etl.process.EventAwareProcess

com.neurosys.etl.common.transformers.AbstractEntityTransformer<TUPLE,CELL,ENTITY>

com.neurosys.etl.common.transformers.AbstractTupleToEntityTransformer<org.apache.poi.ss.usermodel.Row,org.apache.poi.ss.usermodel.Cell,T>

com.neurosys.etl.excel.transformers.AbstractExcelRowToEntityTransformer<T>

All Implemented Interfaces:

IdempotentAware, ModeAware, SourceAware, Process, Serializable, org.apache.commons.collections.Transformer

Direct Known Subclasses:

ExcelRowToAbstractEntityTransformer, ExcelRowToAreaTransformer, ExcelRowToProductTransformer

public abstract class AbstractExcelRowToEntityTransformer<T>
extends AbstractTupleToEntityTransformer<org.apache.poi.ss.usermodel.Row,org.apache.poi.ss.usermodel.Cell,T>
implements SourceAware

Converts an Excel Row to an Entity
This Process is EventAwareProcess.
If the Calling API supports Transactions, it is recommended that one override the AbstractTupleToEntityTransformer.transform(Object) method and make Transaction aware.

Author:

Arjun Dhar

See Also:

AbstractTupleToEntityTransformer.transform(Object), SourceAware, Serialized Form

Nested Class Summary

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

Process.Event, Process.EventPoint

Field Summary

Fields inherited from class com.neurosys.etl.common.transformers.AbstractEntityTransformer

columnFieldMapping, idempotent, mode, modesSupported, nestedObjectInitMap, nonAssociatedMappers

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

listeners, processState

Constructor Summary

Constructors

Constructor and Description
AbstractExcelRowToEntityTransformer()
AbstractExcelRowToEntityTransformer(AbstractExcelRowToEntityTransformer t)

Method Summary

Modifier and Type	Method and Description
protected int	getColumnIndex(org.apache.poi.ss.usermodel.Cell col)
protected Iterator<org.apache.poi.ss.usermodel.Cell>	getColumns(org.apache.poi.ss.usermodel.Row row)
Object	getDefaultValue(org.apache.poi.ss.usermodel.Cell cell)
String	getEncoding()
protected org.apache.poi.ss.usermodel.Row	getTuple(Object rawTupleInput)
protected int	getTupleIndex(org.apache.poi.ss.usermodel.Row row)
protected int	getTupleIndexFromCol(org.apache.poi.ss.usermodel.Cell col)
protected Object	getValue(org.apache.poi.ss.usermodel.Cell cell, Mapper mapper)
boolean	isConvertBlankCellToNullValue() When dealing with Numbers in the tuple, if this is false then 0 is returned as per Cell.getNumericCellValue(). To avoid conversion to 0, one can set this to true. To override @ a columns level see OutputTypeAwareMapperBehavior
void	setConvertBlankCellToNullValue(boolean convertBlankCellToNullValue) When dealing with Numbers in the tuple, if this is false then 0 is returned as per Cell.getNumericCellValue(). To avoid conversion to 0, one can set this to true. To override @ a columns level see OutputTypeAwareMapperBehavior
void	setEncoding(String encoding)

Methods inherited from class com.neurosys.etl.common.transformers.AbstractTupleToEntityTransformer

identifyNode, transform

Methods inherited from class com.neurosys.etl.common.transformers.AbstractEntityTransformer

consumeIntermediateObjects, getColumnFieldMapping, getEntityAccessTransformer, getMode, getModesSupported, getNestedObjectInitMap, getNonAssiciatedMappers, getNonAssociatedMappers, getValue, init, init, isIdempotent, nestedInit, processValue, setColumnFieldMapping, setEntity, setEntityAccessTransformer, setIdempotent, setMode, setModesSupported, setNestedObjectInitMap, setNonAssociatedMappers

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 com.neurosys.etl.common.ModeAware

getMode, getModesSupported, setMode

Constructor Detail

AbstractExcelRowToEntityTransformer

public AbstractExcelRowToEntityTransformer()

AbstractExcelRowToEntityTransformer

public AbstractExcelRowToEntityTransformer(AbstractExcelRowToEntityTransformer t)

Method Detail

getTupleIndex

protected final int getTupleIndex(org.apache.poi.ss.usermodel.Row row)

Specified by:

getTupleIndex in class AbstractTupleToEntityTransformer<org.apache.poi.ss.usermodel.Row,org.apache.poi.ss.usermodel.Cell,T>

getTupleIndexFromCol

protected final int getTupleIndexFromCol(org.apache.poi.ss.usermodel.Cell col)

Specified by:

getTupleIndexFromCol in class AbstractTupleToEntityTransformer<org.apache.poi.ss.usermodel.Row,org.apache.poi.ss.usermodel.Cell,T>

getColumnIndex

protected final int getColumnIndex(org.apache.poi.ss.usermodel.Cell col)

Specified by:

getColumnIndex in class AbstractTupleToEntityTransformer<org.apache.poi.ss.usermodel.Row,org.apache.poi.ss.usermodel.Cell,T>

getTuple

protected org.apache.poi.ss.usermodel.Row getTuple(Object rawTupleInput)

Specified by:

getTuple in class AbstractTupleToEntityTransformer<org.apache.poi.ss.usermodel.Row,org.apache.poi.ss.usermodel.Cell,T>

getColumns

protected Iterator<org.apache.poi.ss.usermodel.Cell> getColumns(org.apache.poi.ss.usermodel.Row row)

Specified by:

getColumns in class AbstractTupleToEntityTransformer<org.apache.poi.ss.usermodel.Row,org.apache.poi.ss.usermodel.Cell,T>

getDefaultValue

public Object getDefaultValue(org.apache.poi.ss.usermodel.Cell cell)
                       throws Exception

Throws:

Exception

getValue

protected Object getValue(org.apache.poi.ss.usermodel.Cell cell,
                          Mapper mapper)
                   throws Exception

Specified by:

getValue in class AbstractTupleToEntityTransformer<org.apache.poi.ss.usermodel.Row,org.apache.poi.ss.usermodel.Cell,T>

Parameters:

cell - as CELL

mapper - as Mapper @nullable true

Returns:

Throws:

Exception

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

isConvertBlankCellToNullValue

public boolean isConvertBlankCellToNullValue()

When dealing with Numbers in the tuple, if this is false then 0 is returned as per Cell.getNumericCellValue().
To avoid conversion to 0, one can set this to true.

To override @ a columns level see OutputTypeAwareMapperBehavior

See Also:

OutputTypeAwareMapperBehavior

Default value:

false

setConvertBlankCellToNullValue

public void setConvertBlankCellToNullValue(boolean convertBlankCellToNullValue)

When dealing with Numbers in the tuple, if this is false then 0 is returned as per Cell.getNumericCellValue().
To avoid conversion to 0, one can set this to true.

To override @ a columns level see OutputTypeAwareMapperBehavior

See Also:

OutputTypeAwareMapperBehavior

Default value:

false