org.apache.beam.sdk.io.xml

Class XmlSource<T>

java.lang.Object

org.apache.beam.sdk.io.Source<T>

org.apache.beam.sdk.io.BoundedSource<T>

org.apache.beam.sdk.io.OffsetBasedSource<T>

org.apache.beam.sdk.io.FileBasedSource<T>

org.apache.beam.sdk.io.xml.XmlSource<T>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

public class XmlSource<T>
extends FileBasedSource<T>

Implementation of XmlIO.read().

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.io.FileBasedSource

FileBasedSource.FileBasedReader<T>, FileBasedSource.Mode

Nested classes/interfaces inherited from class org.apache.beam.sdk.io.OffsetBasedSource

OffsetBasedSource.OffsetBasedReader<T>

Nested classes/interfaces inherited from class org.apache.beam.sdk.io.BoundedSource

BoundedSource.BoundedReader<T>

Nested classes/interfaces inherited from class org.apache.beam.sdk.io.Source

Source.Reader<T>

Method Summary

Modifier and Type	Method and Description
protected FileBasedSource<T>	createForSubrangeOfFile(MatchResult.Metadata metadata, long start, long end) Creates and returns a new FileBasedSource of the same type as the current FileBasedSource backed by a given file and an offset range.
protected FileBasedSource.FileBasedReader<T>	createSingleFileReader(PipelineOptions options) Creates and returns an instance of a FileBasedReader implementation for the current source assuming the source represents a single file.
Coder<T>	getOutputCoder() Returns the Coder to use for the data read from this source.

Methods inherited from class org.apache.beam.sdk.io.FileBasedSource

createReader, createSourceForSubrange, getEmptyMatchTreatment, getEstimatedSizeBytes, getFileOrPatternSpec, getFileOrPatternSpecProvider, getMaxEndOffset, getMode, getSingleFileMetadata, isSplittable, populateDisplayData, split, toString, validate

Methods inherited from class org.apache.beam.sdk.io.OffsetBasedSource

getBytesPerOffset, getEndOffset, getMinBundleSize, getStartOffset

Methods inherited from class org.apache.beam.sdk.io.Source

getDefaultOutputCoder

Methods inherited from class java.lang.Object

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

Method Detail

createForSubrangeOfFile

protected FileBasedSource<T> createForSubrangeOfFile(MatchResult.Metadata metadata,
                                                     long start,
                                                     long end)

Description copied from class: FileBasedSource

Creates and returns a new FileBasedSource of the same type as the current FileBasedSource backed by a given file and an offset range. When current source is being split, this method is used to generate new sub-sources. When creating the source subclasses must call the constructor #FileBasedSource(Metadata, long, long, long) of FileBasedSource with corresponding parameter values passed here.

Specified by:

createForSubrangeOfFile in class FileBasedSource<T>

Parameters:

metadata - file backing the new FileBasedSource.

start - starting byte offset of the new FileBasedSource.

end - ending byte offset of the new FileBasedSource. May be Long.MAX_VALUE, in which case it will be inferred using FileBasedSource.getMaxEndOffset(org.apache.beam.sdk.options.PipelineOptions).

createSingleFileReader

protected FileBasedSource.FileBasedReader<T> createSingleFileReader(PipelineOptions options)

Description copied from class: FileBasedSource

Creates and returns an instance of a FileBasedReader implementation for the current source assuming the source represents a single file. File patterns will be handled by FileBasedSource implementation automatically.

Specified by:

createSingleFileReader in class FileBasedSource<T>

getOutputCoder

public Coder<T> getOutputCoder()

Description copied from class: Source

Returns the Coder to use for the data read from this source.

Overrides:

getOutputCoder in class Source<T>