com.northconcepts.datapipeline.foundations.pipeline.output

Class ExcelPipelineOutput

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.PipelineOutput

com.northconcepts.datapipeline.foundations.pipeline.output.FileSinkPipelineOutput

com.northconcepts.datapipeline.foundations.pipeline.output.ExcelPipelineOutput

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, DataWriterFactory, JavaCodeGenerator, Serializable

public class ExcelPipelineOutput
extends FileSinkPipelineOutput

A pipeline output that writes to an Excel file using the ExcelWriter.

This ExcelPipelineOutput does not support Excel cell styles and formatting, but only supports data formats for different field types. See setDataFormat(FieldType, String).

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
ExcelPipelineOutput()

Method Summary

Modifier and Type	Method and Description
DataWriter	createDataWriter()
ExcelPipelineOutput	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
ExcelPipelineOutput	fromXmlElement(Element pipelineOutputElement)
void	generateJavaCode(JavaCodeBuilder code)
void	generateSaveCode(JavaCodeBuilder code)
Map<FieldType,String>	getDataFormats()
Map<FieldType,String>	getDataFormats(boolean create)
FileSink	getFileSink()
int	getFirstColumnIndex()
int	getFirstRowIndex()
Integer	getFreezeColumns() Gets the number of columns to freeze (make non-scrollable) in the Excel sheet.
Integer	getFreezeRows() Gets the number of rows to freeze (make non-scrollable) in the Excel sheet.
LargeCellHandler	getLargeCellHandler()
String	getName()
ExcelDocument.ProviderType	getProviderType()
int	getSheetIndex()
String	getSheetName()
Map<FieldType,String>	getStyleFormats() Deprecated. use getDataFormats() instead
Map<FieldType,String>	getStyleFormats(boolean create) Deprecated. use getDataFormats(boolean) instead
boolean	isAutoFilterColumns()
boolean	isAutofitColumns()
boolean	isFieldNamesInFirstRow()
ExcelPipelineOutput	setAutoFilterColumns(boolean autoFilterColumns)
ExcelPipelineOutput	setAutofitColumns(boolean autofitColumns)
ExcelPipelineOutput	setDataFormat(FieldType fieldType, String dataFormat)
ExcelPipelineOutput	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
ExcelPipelineOutput	setFileSink(FileSink fileSink)
ExcelPipelineOutput	setFirstColumnIndex(int firstColumnIndex)
ExcelPipelineOutput	setFirstRowIndex(int firstRowIndex)
ExcelPipelineOutput	setFreezeColumns(Integer freezeColumns) Sets the number of columns to freeze (make non-scrollable) in the Excel sheet.
ExcelPipelineOutput	setFreezeRows(Integer freezeRows) Sets the number of rows to freeze (make non-scrollable) in the Excel sheet.
ExcelPipelineOutput	setLargeCellHandler(LargeCellHandler largeCellHandler)
ExcelPipelineOutput	setProviderType(ExcelDocument.ProviderType providerType)
ExcelPipelineOutput	setSheetIndex(int sheetIndex)
ExcelPipelineOutput	setSheetName(String sheetName)
ExcelPipelineOutput	setStyleFormat(FieldType fieldType, String dataFormat) Deprecated. use setDataFormat(FieldType, String) instead
Record	toRecord()
Element	toXmlElement(Document document)

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

getNestedPipelineOutput, getPipelineOutput, getRootPipelineOutput

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

ExcelPipelineOutput

public ExcelPipelineOutput()

Method Detail

getName

public String getName()

Overrides:

getName in class FileSinkPipelineOutput

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord

public ExcelPipelineOutput 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 PipelineOutput

Returns:

this instance.

getProviderType

public ExcelDocument.ProviderType getProviderType()

setProviderType

public ExcelPipelineOutput setProviderType(ExcelDocument.ProviderType providerType)

getSheetName

public String getSheetName()

getSheetIndex

public int getSheetIndex()

setSheetIndex

public ExcelPipelineOutput setSheetIndex(int sheetIndex)

getFirstRowIndex

public int getFirstRowIndex()

setFirstRowIndex

public ExcelPipelineOutput setFirstRowIndex(int firstRowIndex)

getFirstColumnIndex

public int getFirstColumnIndex()

setFirstColumnIndex

public ExcelPipelineOutput setFirstColumnIndex(int firstColumnIndex)

isAutofitColumns

public boolean isAutofitColumns()

setAutofitColumns

public ExcelPipelineOutput setAutofitColumns(boolean autofitColumns)

isAutoFilterColumns

public boolean isAutoFilterColumns()

setAutoFilterColumns

public ExcelPipelineOutput setAutoFilterColumns(boolean autoFilterColumns)

isFieldNamesInFirstRow

public boolean isFieldNamesInFirstRow()

setFieldNamesInFirstRow

public ExcelPipelineOutput setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

getLargeCellHandler

public LargeCellHandler getLargeCellHandler()

setLargeCellHandler

public ExcelPipelineOutput setLargeCellHandler(LargeCellHandler largeCellHandler)

setSheetName

public ExcelPipelineOutput setSheetName(String sheetName)

createDataWriter

public DataWriter createDataWriter()

getFileSink

public FileSink getFileSink()

Specified by:

getFileSink in class FileSinkPipelineOutput

setFileSink

public ExcelPipelineOutput setFileSink(FileSink fileSink)

Specified by:

setFileSink in class FileSinkPipelineOutput

getStyleFormats

@Deprecated
public Map<FieldType,String> getStyleFormats()

Deprecated. use getDataFormats() instead

getDataFormats

public Map<FieldType,String> getDataFormats()

getStyleFormats

@Deprecated
public Map<FieldType,String> getStyleFormats(boolean create)

Deprecated. use getDataFormats(boolean) instead

getDataFormats

public Map<FieldType,String> getDataFormats(boolean create)

setStyleFormat

@Deprecated
public ExcelPipelineOutput setStyleFormat(FieldType fieldType,
                                                       String dataFormat)

Deprecated. use setDataFormat(FieldType, String) instead

setDataFormat

public ExcelPipelineOutput setDataFormat(FieldType fieldType,
                                         String dataFormat)

getFreezeRows

public Integer getFreezeRows()

Gets the number of rows to freeze (make non-scrollable) in the Excel sheet.

Frozen rows remain visible at the top of the sheet when scrolling vertically.

Returns:

the number of rows to freeze, or null if no rows are frozen

setFreezeRows

public ExcelPipelineOutput setFreezeRows(Integer freezeRows)

Sets the number of rows to freeze (make non-scrollable) in the Excel sheet.

Frozen rows remain visible at the top of the sheet when scrolling vertically.

Parameters:

freezeRows - the number of rows to freeze, or null to not freeze any rows

Returns:

this instance for method chaining

getFreezeColumns

public Integer getFreezeColumns()

Gets the number of columns to freeze (make non-scrollable) in the Excel sheet.

Frozen columns remain visible on the left side of the sheet when scrolling horizontally.

Returns:

the number of columns to freeze, or null if no columns are frozen

setFreezeColumns

public ExcelPipelineOutput setFreezeColumns(Integer freezeColumns)

Sets the number of columns to freeze (make non-scrollable) in the Excel sheet.

Frozen columns remain visible on the left side of the sheet when scrolling horizontally.

Parameters:

freezeColumns - the number of columns to freeze, or null to not freeze any columns

Returns:

this instance for method chaining

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

generateSaveCode

public void generateSaveCode(JavaCodeBuilder code)

Overrides:

generateSaveCode in class FileSinkPipelineOutput

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

Overrides:

toXmlElement in class PipelineOutput

fromXmlElement

public ExcelPipelineOutput fromXmlElement(Element pipelineOutputElement)