com.northconcepts.datapipeline.xml

Class XmlWriter

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.xml.XmlWriter

public class XmlWriter
extends TextWriter

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

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
XmlWriter(XmlTemplate template, File file)
XmlWriter(XmlTemplate template, Writer writer)

Method Summary

Modifier and Type	Method and Description
void	close() Indicates that this endpoint has finished reading or writing.
boolean	isPretty() Indicates if line breaks and indentations should be added to output (default false).
void	open() Makes this endpoint ready for reading or writing.
XmlWriter	setAutoCloseWriter(boolean autoCloseWriter) Indicates if the underlying java.io.BufferedWriter should be closed when this stream closes (defaults to true).
XmlWriter	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
XmlWriter	setFlushOnWrite(boolean flushOnWrite) Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written (defaults to false).
XmlWriter	setPretty(boolean pretty) Indicates if line breaks and indentations should be added to output (default false). Example output (pretty = true): <?xml version="1.0" ?> <records> <record> <field name="country">Philippines</field> </record> </records> Example output (pretty = false): <?xml version="1.0" ?><records><record><field name="country">Philippines</field></record></records>
protected void	writeRecord(Record record)

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

addExceptionProperties, getFile, getWriter, isAppend, isAutoCloseWriter, isFieldNamesInFirstRow, isFlushOnWrite, write

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

writeImpl

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

available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, getWriter

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

XmlWriter

public XmlWriter(XmlTemplate template,
                 File file)

XmlWriter

public XmlWriter(XmlTemplate template,
                 Writer writer)

Method Detail

isPretty

public boolean isPretty()

Indicates if line breaks and indentations should be added to output (default false).

setPretty

public XmlWriter setPretty(boolean pretty)

Indicates if line breaks and indentations should be added to output (default false).
Example output (pretty = true):
<?xml version="1.0" ?>
<records>
<record>
<field name="country">Philippines</field>
</record>
</records>

Example output (pretty = false):
<?xml version="1.0" ?><records><record><field name="country">Philippines</field></record></records>

setFieldNamesInFirstRow

public XmlWriter setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

Overrides:

setFieldNamesInFirstRow in class AbstractWriter

setAutoCloseWriter

public XmlWriter setAutoCloseWriter(boolean autoCloseWriter)

Description copied from class: TextWriter

Indicates if the underlying java.io.BufferedWriter should be closed when this stream closes (defaults to true).

Overrides:

setAutoCloseWriter in class TextWriter

setFlushOnWrite

public XmlWriter setFlushOnWrite(boolean flushOnWrite)

Description copied from class: TextWriter

Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written (defaults to false).

Overrides:

setFlushOnWrite in class TextWriter

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 TextWriter

writeRecord

protected void writeRecord(Record record)
                    throws Throwable

Specified by:

writeRecord in class AbstractWriter

Throws:

Throwable