com.northconcepts.datapipeline.template

Class TemplateWriter

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.core.TextWriter

com.northconcepts.datapipeline.template.TemplateWriter

public class TemplateWriter
extends TextWriter

Writes records to a text stream using FreeMarker template. See the Write an XML file example. See the FreeMarker Manual.

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
TemplateWriter(File file)
TemplateWriter(File file, boolean append)
TemplateWriter(File file, boolean append, boolean useTemplateObjectWrapper)
TemplateWriter(Writer writer)
TemplateWriter(Writer writer, boolean useTemplateObjectWrapper)

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.
Configuration	getConfiguration()
Map<String,Object>	getData()
Template	getDetailTemplate()
Template	getFooterTemplate()
Template	getHeaderTemplate()
boolean	isAlwaysShowFooter()
boolean	isAlwaysShowHeader()
boolean	isUseTemplateObjectWrapper()
void	open() Makes this endpoint ready for reading or writing.
TemplateWriter	setAlwaysShowFooter(boolean alwaysShowFooter) Indicates if the footer should be written, even if no records were written (defaults to true).
TemplateWriter	setAlwaysShowHeader(boolean alwaysShowHeader) Indicates if the header should be written, even if no records are written (defaults to true).
TemplateWriter	setDetailTemplate(String detailTemplate)
TemplateWriter	setDetailTemplate(Template detailTemplate)
TemplateWriter	setFooterTemplate(String footerTemplate)
TemplateWriter	setFooterTemplate(Template footerTemplate)
TemplateWriter	setHeaderTemplate(String headerTemplate)
TemplateWriter	setHeaderTemplate(Template headerTemplate)
protected void	writeRecord(Record record)

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

getFile, getWriter, isAppend, isAutoCloseWriter, isFieldNamesInFirstRow, isFlushOnWrite, setAutoCloseWriter, setFlushOnWrite, write

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

setFieldNamesInFirstRow, 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, setDescription

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

TemplateWriter

public TemplateWriter(File file,
                      boolean append)

TemplateWriter

public TemplateWriter(File file)

TemplateWriter

public TemplateWriter(Writer writer)

TemplateWriter

public TemplateWriter(File file,
                      boolean append,
                      boolean useTemplateObjectWrapper)

TemplateWriter

public TemplateWriter(Writer writer,
                      boolean useTemplateObjectWrapper)

Method Detail

getData

public Map<String,Object> getData()

getConfiguration

public Configuration getConfiguration()

isAlwaysShowFooter

public boolean isAlwaysShowFooter()

setAlwaysShowFooter

public TemplateWriter setAlwaysShowFooter(boolean alwaysShowFooter)

Indicates if the footer should be written, even if no records were written (defaults to true).

isAlwaysShowHeader

public boolean isAlwaysShowHeader()

setAlwaysShowHeader

public TemplateWriter setAlwaysShowHeader(boolean alwaysShowHeader)

Indicates if the header should be written, even if no records are written (defaults to true).

isUseTemplateObjectWrapper

public boolean isUseTemplateObjectWrapper()

getHeaderTemplate

public Template getHeaderTemplate()

setHeaderTemplate

public TemplateWriter setHeaderTemplate(String headerTemplate)

setHeaderTemplate

public TemplateWriter setHeaderTemplate(Template headerTemplate)

getFooterTemplate

public Template getFooterTemplate()

setFooterTemplate

public TemplateWriter setFooterTemplate(String footerTemplate)

setFooterTemplate

public TemplateWriter setFooterTemplate(Template footerTemplate)

getDetailTemplate

public Template getDetailTemplate()

setDetailTemplate

public TemplateWriter setDetailTemplate(String detailTemplate)

setDetailTemplate

public TemplateWriter setDetailTemplate(Template detailTemplate)

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class AbstractWriter

Throws:

DataException

close

public void close()
           throws DataException

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class TextWriter

Throws:

DataException

writeRecord

protected void writeRecord(Record record)
                    throws Throwable

Specified by:

writeRecord in class AbstractWriter

Throws:

Throwable

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 TextWriter