com.northconcepts.datapipeline.foundations.pipeline.input

Class XmlPipelineInput

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.core.FoundationObject

com.northconcepts.datapipeline.foundations.pipeline.PipelineObject

com.northconcepts.datapipeline.foundations.pipeline.PipelineInput

com.northconcepts.datapipeline.foundations.pipeline.input.FileSourcePipelineInput

com.northconcepts.datapipeline.foundations.pipeline.input.XmlPipelineInput

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, DataReaderFactory, JavaCodeGenerator, Serializable

Direct Known Subclasses:

JsonPipelineInput

public class XmlPipelineInput
extends FileSourcePipelineInput

See Also:

Serialized Form

Field Summary

Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

internalId, internalName, log, TIMESTAMP_FORMAT

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

SERIALIZED_CLASS_NAME, TYPE

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
XmlPipelineInput()

Method Summary

Modifier and Type	Method and Description
XmlPipelineInput	addField(String name, String locationPathAsString)
XmlPipelineInput	addField(String name, String locationPathAsString, boolean cascadeValues)
XmlPipelineInput	addField(String name, String locationPathAsString, String cascadeResetLocationPath)
XmlPipelineInput	addField(XmlField xmlField)
XmlPipelineInput	addRecordBreak(String locationPathAsString)
DataReader	createDataReader()
protected XmlReader	createDataReaderImpl(InputStream in)
XmlPipelineInput	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
XmlPipelineInput	fromXmlElement(Element pipelineInputElement)
void	generateJavaCode(JavaCodeBuilder code)
protected void	generateJavaCodeImpl(JavaCodeBuilder code, CodeWriter writer)
XmlReader.DuplicateFieldPolicy	getDuplicateFieldPolicy()
List<XmlField>	getFields()
List<XmlField>	getFields(boolean create)
FileSource	getFileSource()
String	getName()
List<String>	getRecordBreaks()
List<String>	getRecordBreaks(boolean create)
boolean	isAutoCloseReader()
boolean	isDebug()
boolean	isLineageSupported()
XmlPipelineInput	setAutoCloseReader(boolean autoCloseReader)
XmlPipelineInput	setDebug(boolean debug)
XmlPipelineInput	setDuplicateFieldPolicy(XmlReader.DuplicateFieldPolicy duplicateFieldPolicy)
XmlPipelineInput	setFileSource(FileSource fileSource)
Record	toRecord()
Element	toXmlElement(Document document)

Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.PipelineInput

getNestedPipelineInput, getRootPipelineInput, isSaveLineage, setSaveLineage

Methods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

addExceptionProperties, assertValid, assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalId

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties

Constructor Detail

XmlPipelineInput

public XmlPipelineInput()

Method Detail

createDataReader

public DataReader createDataReader()

createDataReaderImpl

protected XmlReader createDataReaderImpl(InputStream in)

getFileSource

public FileSource getFileSource()

Specified by:

getFileSource in class FileSourcePipelineInput

setFileSource

public XmlPipelineInput setFileSource(FileSource fileSource)

Specified by:

setFileSource in class FileSourcePipelineInput

getName

public String getName()

Overrides:

getName in class FileSourcePipelineInput

getFields

public List<XmlField> getFields()

getFields

public List<XmlField> getFields(boolean create)

addField

public XmlPipelineInput addField(XmlField xmlField)

addField

public XmlPipelineInput addField(String name,
                                 String locationPathAsString)

addField

public XmlPipelineInput addField(String name,
                                 String locationPathAsString,
                                 boolean cascadeValues)

addField

public XmlPipelineInput addField(String name,
                                 String locationPathAsString,
                                 String cascadeResetLocationPath)

getRecordBreaks

public List<String> getRecordBreaks()

getRecordBreaks

public List<String> getRecordBreaks(boolean create)

addRecordBreak

public XmlPipelineInput addRecordBreak(String locationPathAsString)

getDuplicateFieldPolicy

public XmlReader.DuplicateFieldPolicy getDuplicateFieldPolicy()

setDuplicateFieldPolicy

public XmlPipelineInput setDuplicateFieldPolicy(XmlReader.DuplicateFieldPolicy duplicateFieldPolicy)

isDebug

public boolean isDebug()

setDebug

public XmlPipelineInput setDebug(boolean debug)

isAutoCloseReader

public boolean isAutoCloseReader()

setAutoCloseReader

public XmlPipelineInput setAutoCloseReader(boolean autoCloseReader)

isLineageSupported

public boolean isLineageSupported()

Overrides:

isLineageSupported in class PipelineInput

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

generateJavaCodeImpl

protected void generateJavaCodeImpl(JavaCodeBuilder code,
                                    CodeWriter writer)

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class PipelineInput

fromRecord

public XmlPipelineInput fromRecord(Record source)

Description copied from interface: RecordSerializable

Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

Specified by:

fromRecord in interface RecordSerializable

Overrides:

fromRecord in class PipelineInput

Returns:

this instance.

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

Overrides:

toXmlElement in class PipelineInput

fromXmlElement

public XmlPipelineInput fromXmlElement(Element pipelineInputElement)

Specified by:

fromXmlElement in interface XmlSerializable

Overrides:

fromXmlElement in class PipelineInput