org.apache.flink.api.java.record.io

Class FixedLengthInputFormat

java.lang.Object

org.apache.flink.api.common.io.FileInputFormat<Record>

org.apache.flink.api.java.record.io.FileInputFormat

org.apache.flink.api.java.record.io.FixedLengthInputFormat

All Implemented Interfaces:

Serializable, InputFormat<Record,FileInputSplit>, InputSplitSource<FileInputSplit>

public abstract class FixedLengthInputFormat
extends FileInputFormat

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.api.common.io.FileInputFormat

FileInputFormat.AbstractConfigBuilder<T>, FileInputFormat.ConfigBuilder, FileInputFormat.FileBaseStatistics, FileInputFormat.InputSplitOpenThread

Field Summary

Fields

Modifier and Type	Field and Description
static String	RECORDLENGTH_PARAMETER_KEY The config parameter which defines the fixed length of a record.

Fields inherited from class org.apache.flink.api.common.io.FileInputFormat

DEFLATE_SUFFIX, enumerateNestedFiles, filePath, minSplitSize, numSplits, openTimeout, READ_WHOLE_SPLIT_FLAG, splitLength, splitStart, stream, unsplittable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FixedLengthInputFormat() Constructor only sets the key and value classes

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(Configuration parameters)
int	getReadBufferSize() Gets the size of the buffer internally used to parse record boundaries.
int	getRecordLength() Returns the fixed length of a record.
FileInputFormat.FileBaseStatistics	getStatistics(BaseStatistics cachedStats)
Record	nextRecord(Record reuse)
void	open(FileInputSplit split)
boolean	reachedEnd()
abstract boolean	readBytes(Record target, byte[] buffer, int startPos) Reads a record out of the given buffer.

Methods inherited from class org.apache.flink.api.common.io.FileInputFormat

acceptFile, close, configureFileFormat, createInputSplits, getFilePath, getFileStats, getInputSplitAssigner, getMinSplitSize, getNumSplits, getOpenTimeout, getSplitLength, getSplitStart, setFilePath, setFilePath, setMinSplitSize, setNumSplits, setOpenTimeout, testForUnsplittable, toString

Methods inherited from class java.lang.Object

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

Field Detail

RECORDLENGTH_PARAMETER_KEY

public static final String RECORDLENGTH_PARAMETER_KEY

The config parameter which defines the fixed length of a record.

See Also:

Constant Field Values

Constructor Detail

FixedLengthInputFormat

protected FixedLengthInputFormat()

Constructor only sets the key and value classes

Method Detail

readBytes

public abstract boolean readBytes(Record target,
                byte[] buffer,
                int startPos)

Reads a record out of the given buffer. This operation always consumes the standard number of bytes, regardless of whether the produced record was valid.

Parameters:

target - The target Record

buffer - The buffer containing the binary data.

startPos - The start position in the byte array.

Returns:

True, is the record is valid, false otherwise.

getRecordLength

public int getRecordLength()

Returns the fixed length of a record.

Returns:

the fixed length of a record.

getReadBufferSize

public int getReadBufferSize()

Gets the size of the buffer internally used to parse record boundaries.

Returns:

The size of the parsing buffer.

configure

public void configure(Configuration parameters)

Specified by:

configure in interface InputFormat<Record,FileInputSplit>

Overrides:

configure in class FileInputFormat<Record>

open

public void open(FileInputSplit split)
          throws IOException

Specified by:

open in interface InputFormat<Record,FileInputSplit>

Overrides:

open in class FileInputFormat<Record>

Throws:

IOException

getStatistics

public FileInputFormat.FileBaseStatistics getStatistics(BaseStatistics cachedStats)
                                                 throws IOException

Specified by:

getStatistics in interface InputFormat<Record,FileInputSplit>

Overrides:

getStatistics in class FileInputFormat<Record>

Throws:

IOException

reachedEnd

public boolean reachedEnd()

nextRecord

public Record nextRecord(Record reuse)
                  throws IOException

Throws:

IOException