com.northconcepts.datapipeline.foundations.pipeline

Class PipelineInput

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DataReaderPipelineInput, DatasetPipelineInput, FileSourcePipelineInput, JdbcPipelineInput, ProxyPipelineInput

public abstract class PipelineInput
extends PipelineObject
implements DataReaderFactory

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
PipelineInput()

Method Summary

Modifier and Type	Method and Description
PipelineInput	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
XmlSerializable	fromXmlElement(Element element)
abstract String	getName()
PipelineInput	getNestedPipelineInput() Returns the PipelineInput held inside this one or null if there isn't one.
<T extends PipelineInput> T	getPipelineInput(Class<T> type) Searches for a nested PipelineInput of the specified type within this pipeline input hierarchy.
PipelineInput	getRootPipelineInput() Returns the deepest, nested PipelineInput held inside this one, otherwise this instance is returned if there aren't any nested PipelineInputs.
boolean	isLineageSupported()
boolean	isSaveLineage()
PipelineInput	setSaveLineage(boolean saveLineage)
Record	toRecord()
Element	toXmlElement(Document document)

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.job.DataReaderFactory

createDataReader

Methods inherited from interface com.northconcepts.datapipeline.sourcecode.JavaCodeGenerator

generateJavaCode

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

PipelineInput

public PipelineInput()

Method Detail

getName

public abstract String getName()

isLineageSupported

public boolean isLineageSupported()

isSaveLineage

public boolean isSaveLineage()

getNestedPipelineInput

public PipelineInput getNestedPipelineInput()

Returns the PipelineInput held inside this one or null if there isn't one.

getRootPipelineInput

public PipelineInput getRootPipelineInput()

Returns the deepest, nested PipelineInput held inside this one, otherwise this instance is returned if there aren't any nested PipelineInputs.

getPipelineInput

public <T extends PipelineInput> T getPipelineInput(Class<T> type)

Searches for a nested PipelineInput of the specified type within this pipeline input hierarchy.

This method first checks if the current instance is assignable to the specified type. If not, it traverses through all nested PipelineInputs to find one that matches the type.

Type Parameters:

T - the type of PipelineInput to search for

Parameters:

type - the class of the PipelineInput type to find

Returns:

the first matching PipelineInput of the specified type, or null if not found

setSaveLineage

public PipelineInput setSaveLineage(boolean saveLineage)

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord

public PipelineInput 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 Bean

Returns:

this instance.

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

fromXmlElement

public XmlSerializable fromXmlElement(Element element)

Specified by:

fromXmlElement in interface XmlSerializable