com.northconcepts.datapipeline.excel
Class ExcelWriter

java.lang.Object
  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 an 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

BUFFER_SIZE, log

Constructor Summary

ExcelWriter(ExcelDocument document)

Method Summary

DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
int	getFirstColumnIndex()
int	getFirstRowIndex()
int	getSheetIndex()
String	getSheetName()
boolean	isAutofitColumns()
void	open() Makes this endpoint ready for reading or writing.
ExcelWriter	setAutofitColumns(boolean autofitColumns)
ExcelWriter	setFirstColumnIndex(int firstColumnIndex)
ExcelWriter	setFirstRowIndex(int firstRowIndex)
ExcelWriter	setSheetIndex(int sheetIndex)
ExcelWriter	setSheetName(String sheetName)
protected void	writeRecord(Record record)

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

isFieldNamesInFirstRow, setFieldNamesInFirstRow, write, writeImpl

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

getNestedWriter, getRootWriter

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

assertNotOpened, assertOpened, decrementRecordCount, exception, exception, exception, finalize, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, getState, incrementRecordCount, isClosed, isOpen, isRecordCountBigInteger, resetRecordCount, toString

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: DataEndpoint

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)

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)

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

writeRecord

protected void writeRecord(Record record)

Specified by:

writeRecord in class AbstractWriter