com.northconcepts.datapipeline.xml

Class XmlRecordReader

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataReader

com.northconcepts.datapipeline.xml.XmlRecordReader

public class XmlRecordReader
extends DataReader

Field Summary

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

fieldLineage, recordLineage

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
XmlRecordReader(File file)
XmlRecordReader(Reader reader)
XmlRecordReader(XMLStreamReader reader)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
protected Record	addLineage(Record record)
XmlRecordReader	addRecordBreak(String locationPathAsString)
void	close() Indicates that this endpoint has finished reading or writing.
boolean	isAddTextToParent() Return true if each child node's text should be concatenated to its parent during parsing (defaults to false).
boolean	isAutoCloseReader()
boolean	isDebug()
boolean	isIgnoreEmptyText()
boolean	isIgnoreNamespaces() Indicates if namespaces on elements and attributes are to be removed (default to true).
boolean	isLineageSupported()
boolean	isMapTextRecordsToFields()
protected boolean	isRecordBreak(XmlNode node)
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
XmlRecordReader	setAddTextToParent(boolean addTextToParent) Indicates if each child node's text should be concatenated to its parent during parsing (defaults to false).
XmlRecordReader	setAutoCloseReader(boolean autoCloseReader)
XmlRecordReader	setDebug(boolean debug)
XmlRecordReader	setIgnoreEmptyText(boolean ignoreEmptyText)
XmlRecordReader	setIgnoreNamespaces(boolean ignoreNamespaces) Indicates if namespaces on elements and attributes are to be removed (default to true).
XmlRecordReader	setMapTextRecordsToFields(boolean mapTextRecordsToFields)
protected void	updateCurrentNode()

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

available, getBufferSize, getNestedEndpoint, getNestedReader, getReader, getRootEndpoint, getRootReader, isExhausted, isSaveLineage, peek, pop, push, read, setSaveLineage, skip

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

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, open, 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

XmlRecordReader

public XmlRecordReader(XMLStreamReader reader)

XmlRecordReader

public XmlRecordReader(File file)

XmlRecordReader

public XmlRecordReader(Reader reader)

Method Detail

isDebug

public boolean isDebug()

setDebug

public XmlRecordReader setDebug(boolean debug)

isAddTextToParent

public boolean isAddTextToParent()

Return true if each child node's text should be concatenated to its parent during parsing (defaults to false).

setAddTextToParent

public XmlRecordReader setAddTextToParent(boolean addTextToParent)

Indicates if each child node's text should be concatenated to its parent during parsing (defaults to false). Setting this to true will result in higher memory consumption.

isIgnoreNamespaces

public boolean isIgnoreNamespaces()

Indicates if namespaces on elements and attributes are to be removed (default to true).

setIgnoreNamespaces

public XmlRecordReader setIgnoreNamespaces(boolean ignoreNamespaces)

Indicates if namespaces on elements and attributes are to be removed (default to true).

addRecordBreak

public XmlRecordReader addRecordBreak(String locationPathAsString)

isRecordBreak

protected boolean isRecordBreak(XmlNode node)

close

public void close()

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

isIgnoreEmptyText

public boolean isIgnoreEmptyText()

setIgnoreEmptyText

public XmlRecordReader setIgnoreEmptyText(boolean ignoreEmptyText)

isMapTextRecordsToFields

public boolean isMapTextRecordsToFields()

setMapTextRecordsToFields

public XmlRecordReader setMapTextRecordsToFields(boolean mapTextRecordsToFields)

readImpl

protected Record readImpl()
                   throws Throwable

Description copied from class: DataReader

Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

If no record is available, null will be returned.

Specified by:

readImpl in class DataReader

Throws:

Throwable

updateCurrentNode

protected void updateCurrentNode()
                          throws DataException

Throws:

DataException

isLineageSupported

public boolean isLineageSupported()

Overrides:

isLineageSupported in class DataReader

addLineage

protected Record addLineage(Record record)

Overrides:

addLineage in class DataReader

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 DataReader

isAutoCloseReader

public boolean isAutoCloseReader()

setAutoCloseReader

public XmlRecordReader setAutoCloseReader(boolean autoCloseReader)