com.northconcepts.datapipeline.xml

Class XmlRecordWriter

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

com.northconcepts.datapipeline.xml.XmlRecordWriter

public class XmlRecordWriter
extends TextStreamWriter

Writes XML using the structure of each record's natural representation.

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.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
XmlRecordWriter(File file)
XmlRecordWriter(Writer writer)

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.
String	getRecordTagName()
String	getRootTagName()
boolean	isPretty() Indicates if line breaks and indentations should be added to output (default false).
boolean	isWriteFieldsAsAttributes()
boolean	isWriteXmlDeclaration()
void	open() Makes this endpoint ready for reading or writing.
XmlRecordWriter	setPretty(boolean pretty) Indicates if line breaks and indentations should be added to output (default false).
XmlRecordWriter	setRecordTagName(String recordTagName)
XmlRecordWriter	setRootTagName(String rootTagName)
XmlRecordWriter	setWriteFieldsAsAttributes(boolean writeFieldsAsAttributes)
XmlRecordWriter	setWriteXmlDeclaration(boolean writeXmlDeclaration)
protected void	writeImpl(Record record) Overridden by subclasses to write the specified record to this DataWriter.

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

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

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

XmlRecordWriter

public XmlRecordWriter(File file)

XmlRecordWriter

public XmlRecordWriter(Writer writer)

Method Detail

isPretty

public boolean isPretty()

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

setPretty

public XmlRecordWriter setPretty(boolean pretty)

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

getRootTagName

public String getRootTagName()

setRootTagName

public XmlRecordWriter setRootTagName(String rootTagName)

getRecordTagName

public String getRecordTagName()

setRecordTagName

public XmlRecordWriter setRecordTagName(String recordTagName)

isWriteXmlDeclaration

public boolean isWriteXmlDeclaration()

setWriteXmlDeclaration

public XmlRecordWriter setWriteXmlDeclaration(boolean writeXmlDeclaration)

isWriteFieldsAsAttributes

public boolean isWriteFieldsAsAttributes()

setWriteFieldsAsAttributes

public XmlRecordWriter setWriteFieldsAsAttributes(boolean writeFieldsAsAttributes)

open

public void open()

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class DataEndpoint

close

public void close()

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class TextStreamWriter

writeImpl

protected void writeImpl(Record record)
                  throws Throwable

Description copied from class: DataWriter

Overridden by subclasses to write the specified record to this DataWriter.

Specified by:

writeImpl in class DataWriter

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 TextStreamWriter