com.northconcepts.datapipeline.foundations.pipeline.input

Class ExcelPipelineInput

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.core.FoundationObject

com.northconcepts.datapipeline.foundations.pipeline.PipelineObject

com.northconcepts.datapipeline.foundations.pipeline.PipelineInput

com.northconcepts.datapipeline.foundations.pipeline.input.FileSourcePipelineInput

com.northconcepts.datapipeline.foundations.pipeline.input.ExcelPipelineInput

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, DataReaderFactory, JavaCodeGenerator, Serializable

public class ExcelPipelineInput
extends FileSourcePipelineInput

See Also:

Serialized Form

Field Summary

Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

internalId, internalName, log, TIMESTAMP_FORMAT

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

SERIALIZED_CLASS_NAME, TYPE

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
ExcelPipelineInput()

Method Summary

Modifier and Type	Method and Description
DataReader	createDataReader()
ExcelPipelineInput	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
ExcelPipelineInput	fromXmlElement(Element element)
void	generateJavaCode(JavaCodeBuilder code)
List<String>	getFieldNames()
FileSource	getFileSource()
int	getLastRow()
String	getName()
ExcelDocument.ProviderType	getProviderType()
int	getSheetIndex()
String	getSheetName()
int	getStartingColumn()
int	getStartingRow()
boolean	isAutoCloseDocument()
boolean	isEvaluateExpressions()
boolean	isFieldNamesInFirstRow()
boolean	isLineageSupported()
boolean	isSkipEmptyRows()
boolean	isUseSheetColumnCount()
ExcelPipelineInput	setAutoCloseDocument(boolean autoCloseDocument)
ExcelPipelineInput	setEvaluateExpressions(boolean evaluateExpressions)
ExcelPipelineInput	setFieldNames(Collection<String> fieldNames)
ExcelPipelineInput	setFieldNames(String... fieldNames)
ExcelPipelineInput	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
ExcelPipelineInput	setFileSource(FileSource fileSource)
ExcelPipelineInput	setLastRow(int lastRow)
ExcelPipelineInput	setProviderType(ExcelDocument.ProviderType providerType)
ExcelPipelineInput	setSaveLineage(boolean saveLineage)
ExcelPipelineInput	setSheetIndex(int sheetIndex)
ExcelPipelineInput	setSheetName(String sheetName)
ExcelPipelineInput	setSkipEmptyRows(boolean skipEmptyRows)
ExcelPipelineInput	setStartingColumn(int startingColumn)
ExcelPipelineInput	setStartingRow(int startingRow)
ExcelPipelineInput	setUseSheetColumnCount(boolean useSheetColumnCount)
Record	toRecord()
Element	toXmlElement(Document document)

Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.PipelineInput

getNestedPipelineInput, getRootPipelineInput, isSaveLineage

Methods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

addExceptionProperties, assertValid, assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalId

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties

Constructor Detail

ExcelPipelineInput

public ExcelPipelineInput()

Method Detail

getName

public String getName()

Overrides:

getName in class FileSourcePipelineInput

isLineageSupported

public boolean isLineageSupported()

Overrides:

isLineageSupported in class PipelineInput

setSaveLineage

public ExcelPipelineInput setSaveLineage(boolean saveLineage)

Overrides:

setSaveLineage in class PipelineInput

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class PipelineInput

fromRecord

public ExcelPipelineInput fromRecord(Record source)

Description copied from interface: RecordSerializable

Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

Specified by:

fromRecord in interface RecordSerializable

Overrides:

fromRecord in class PipelineInput

Returns:

this instance.

getFileSource

public FileSource getFileSource()

Specified by:

getFileSource in class FileSourcePipelineInput

setFileSource

public ExcelPipelineInput setFileSource(FileSource fileSource)

Specified by:

setFileSource in class FileSourcePipelineInput

getProviderType

public ExcelDocument.ProviderType getProviderType()

setProviderType

public ExcelPipelineInput setProviderType(ExcelDocument.ProviderType providerType)

getSheetName

public String getSheetName()

setSheetName

public ExcelPipelineInput setSheetName(String sheetName)

getSheetIndex

public int getSheetIndex()

setSheetIndex

public ExcelPipelineInput setSheetIndex(int sheetIndex)

getStartingRow

public int getStartingRow()

setStartingRow

public ExcelPipelineInput setStartingRow(int startingRow)

getLastRow

public int getLastRow()

setLastRow

public ExcelPipelineInput setLastRow(int lastRow)

getStartingColumn

public int getStartingColumn()

setStartingColumn

public ExcelPipelineInput setStartingColumn(int startingColumn)

isSkipEmptyRows

public boolean isSkipEmptyRows()

setSkipEmptyRows

public ExcelPipelineInput setSkipEmptyRows(boolean skipEmptyRows)

isFieldNamesInFirstRow

public boolean isFieldNamesInFirstRow()

setFieldNamesInFirstRow

public ExcelPipelineInput setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

isEvaluateExpressions

public boolean isEvaluateExpressions()

setEvaluateExpressions

public ExcelPipelineInput setEvaluateExpressions(boolean evaluateExpressions)

isUseSheetColumnCount

public boolean isUseSheetColumnCount()

setUseSheetColumnCount

public ExcelPipelineInput setUseSheetColumnCount(boolean useSheetColumnCount)

isAutoCloseDocument

public boolean isAutoCloseDocument()

setAutoCloseDocument

public ExcelPipelineInput setAutoCloseDocument(boolean autoCloseDocument)

getFieldNames

public List<String> getFieldNames()

setFieldNames

public ExcelPipelineInput setFieldNames(String... fieldNames)

setFieldNames

public ExcelPipelineInput setFieldNames(Collection<String> fieldNames)

createDataReader

public DataReader createDataReader()

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

Overrides:

toXmlElement in class PipelineInput

fromXmlElement

public ExcelPipelineInput fromXmlElement(Element element)

Specified by:

fromXmlElement in interface XmlSerializable

Overrides:

fromXmlElement in class PipelineInput