Class OrcPipelineInput
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.orc.input.OrcPipelineInput
- All Implemented Interfaces:
DataExceptionContributor,JsonSerializable,RecordSerializable,XmlSerializable,DataReaderFactory,JavaCodeGenerator,Serializable
A pipeline input that reads the Apache ORC file at a
FileSource's path using an OrcDataReader.- See Also:
-
Field Summary
Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject
internalId, internalName, log, TIMESTAMP_FORMATFields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
SERIALIZED_CLASS_NAME, TYPEFields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
XML_SERIALIZED_CLASS_NAME -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdds a parameter to the Hadoopused to read the file.invalid reference
ConfigurationSets the Orc configuration parameters.fromRecord(Record source) Loads this instance's state from a record and returnsthis(for fluid API call chaining).fromXmlElement(Element pipelineInputElement) voidgenerateJavaCode(JavaCodeBuilder javaCodeBuilder) Appends Java source code representing this object to the given builder.intIndicates the maximum number of records to buffer when reading ORC data (default 1024).Indicates the columns to read from ORC file.Returns the Orc configuration parameters.getName()Returns a display name for this input, such as the source's name followed by its format.TypeDescriptionIndicates the schema used to read the file.booleanIndicates if this input can save data lineage on the records it reads (false unless a subclass overrides it).booleanIndicates if data lineage (where each record and field came from) is saved on the records read (defaults to false).setBatchSize(int batchSize) Indicates the maximum number of records to buffer when reading ORC data (default 1024).setColumns(FieldList columns) Indicates the columns to read from ORC file.setFileSource(FileSource fileSource) setSaveLineage(boolean saveLineage) Indicates if data lineage (where each record and field came from) is saved on the records read (defaults to false); enabling it throws an exception if lineage is not supported.Sets the schema used to read the file as a string.setSchema(TypeDescription schema) Indicates the schema used to read the file.toRecord()Converts this object's state to a record thatRecordSerializable.fromRecord(Record)can load.toXmlElement(Document document) Returns an element, created withdocument, describing this object; the default implementation throws aDataException.Methods inherited from class com.northconcepts.datapipeline.foundations.pipeline.PipelineInput
getNestedPipelineInput, getPipelineInput, getRootPipelineInputMethods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject
addExceptionProperties, assertValid, assertValid, clone, exception, exception, exception, getInternalId, getInternalName, resetInternalIdMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor
addExceptionProperties
-
Constructor Details
-
OrcPipelineInput
public OrcPipelineInput()
-
-
Method Details
-
getName
Description copied from class:PipelineInputReturns a display name for this input, such as the source's name followed by its format.- Overrides:
getNamein classFileSourcePipelineInput
-
getFileSource
- Specified by:
getFileSourcein classFileSourcePipelineInput
-
setFileSource
- Specified by:
setFileSourcein classFileSourcePipelineInput
-
isSaveLineage
public boolean isSaveLineage()Description copied from class:PipelineInputIndicates if data lineage (where each record and field came from) is saved on the records read (defaults to false).- Overrides:
isSaveLineagein classPipelineInput
-
setSaveLineage
Description copied from class:PipelineInputIndicates if data lineage (where each record and field came from) is saved on the records read (defaults to false); enabling it throws an exception if lineage is not supported.- Overrides:
setSaveLineagein classPipelineInput
-
createDataReader
-
generateJavaCode
Description copied from interface:JavaCodeGeneratorAppends Java source code representing this object to the given builder. -
isLineageSupported
public boolean isLineageSupported()Description copied from class:PipelineInputIndicates if this input can save data lineage on the records it reads (false unless a subclass overrides it).- Overrides:
isLineageSupportedin classPipelineInput
-
getBatchSize
public int getBatchSize()Indicates the maximum number of records to buffer when reading ORC data (default 1024). -
setBatchSize
Indicates the maximum number of records to buffer when reading ORC data (default 1024). -
getSchema
public TypeDescription getSchema()Indicates the schema used to read the file. -
setSchema
Sets the schema used to read the file as a string. -
setSchema
Indicates the schema used to read the file. -
getColumns
Indicates the columns to read from ORC file. -
setColumns
Indicates the columns to read from ORC file. -
getConfig
Returns the Orc configuration parameters. -
addConfig
Sets the Orc configuration parameters. -
addConfig
Adds a parameter to the Hadoopused to read the file.invalid reference
Configuration -
toRecord
Description copied from interface:RecordSerializableConverts this object's state to a record thatRecordSerializable.fromRecord(Record)can load.- Specified by:
toRecordin interfaceRecordSerializable- Overrides:
toRecordin classPipelineInput
-
fromRecord
Description copied from interface:RecordSerializableLoads this instance's state from a record and returnsthis(for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.- Specified by:
fromRecordin interfaceRecordSerializable- Overrides:
fromRecordin classPipelineInput- Parameters:
source-- Returns:
- this instance.
-
toXmlElement
Description copied from interface:XmlSerializableReturns an element, created withdocument, describing this object; the default implementation throws aDataException.- Specified by:
toXmlElementin interfaceXmlSerializable- Overrides:
toXmlElementin classPipelineInput
-
fromXmlElement
- Specified by:
fromXmlElementin interfaceXmlSerializable- Overrides:
fromXmlElementin classPipelineInput
-