com.northconcepts.datapipeline.excel

Class ExcelWriter

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataWriter

com.northconcepts.datapipeline.core.AbstractWriter

com.northconcepts.datapipeline.excel.ExcelWriter

public class ExcelWriter
extends AbstractWriter

Writes records to a Microsoft Excel document.

Nested Class Summary

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

DataEndpoint.State

Field Summary

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

currentRecord

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

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
ExcelDocument	getDocument()
int	getFirstColumnIndex()
int	getFirstRowIndex()
int	getSheetIndex()
String	getSheetName()
boolean	isAutofilterColumns()
boolean	isAutofitColumns()
void	open() Makes this endpoint ready for reading or writing.
ExcelWriter	setAutoFilterColumns(boolean autoFilterColumns) Indicates if a row containing a drop-down filter with values from each column should be added above the data rows.
ExcelWriter	setAutofitColumns(boolean autofitColumns) Indicates if the columns should be expanded to fit the widest value.
ExcelWriter	setDescription(String description)
ExcelWriter	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
ExcelWriter	setFirstColumnIndex(int firstColumnIndex)
ExcelWriter	setFirstRowIndex(int firstRowIndex)
ExcelWriter	setSheetIndex(int sheetIndex)
ExcelWriter	setSheetName(String sheetName)
ExcelWriter	setStyleFormat(FieldType fieldType, String pattern)
protected void	writeRecord(Record record)

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

isFieldNamesInFirstRow, write, writeImpl

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

available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter

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

ExcelWriter

public ExcelWriter(ExcelDocument document)

Method Detail

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 AbstractWriter

isAutofitColumns

public boolean isAutofitColumns()

setAutofitColumns

public ExcelWriter setAutofitColumns(boolean autofitColumns)

Indicates if the columns should be expanded to fit the widest value.

isAutofilterColumns

public boolean isAutofilterColumns()

setAutoFilterColumns

public ExcelWriter setAutoFilterColumns(boolean autoFilterColumns)

Indicates if a row containing a drop-down filter with values from each column should be added above the data rows.

getSheetName

public String getSheetName()

setSheetName

public ExcelWriter setSheetName(String sheetName)

getSheetIndex

public int getSheetIndex()

setSheetIndex

public ExcelWriter setSheetIndex(int sheetIndex)

getFirstColumnIndex

public int getFirstColumnIndex()

setFirstColumnIndex

public ExcelWriter setFirstColumnIndex(int firstColumnIndex)

getFirstRowIndex

public int getFirstRowIndex()

setFirstRowIndex

public ExcelWriter setFirstRowIndex(int firstRowIndex)

setFieldNamesInFirstRow

public ExcelWriter setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

Overrides:

setFieldNamesInFirstRow in class AbstractWriter

setDescription

public ExcelWriter setDescription(String description)

Overrides:

setDescription in class Endpoint

open

public void open()

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class AbstractWriter

close

public void close()

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

getDocument

public ExcelDocument getDocument()

writeRecord

protected void writeRecord(Record record)

Specified by:

writeRecord in class AbstractWriter

setStyleFormat

public ExcelWriter setStyleFormat(FieldType fieldType,
                                  String pattern)