org.apache.flink.api.java.io

Class TextInputFormat

java.lang.Object

org.apache.flink.api.common.io.RichInputFormat<OT,org.apache.flink.core.fs.FileInputSplit>

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

org.apache.flink.api.common.io.DelimitedInputFormat<String>

org.apache.flink.api.java.io.TextInputFormat

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.io.CheckpointableInputFormat<org.apache.flink.core.fs.FileInputSplit,Long>, org.apache.flink.api.common.io.InputFormat<String,org.apache.flink.core.fs.FileInputSplit>, org.apache.flink.core.io.InputSplitSource<org.apache.flink.core.fs.FileInputSplit>

@PublicEvolving
public class TextInputFormat
extends org.apache.flink.api.common.io.DelimitedInputFormat<String>

Input Format that reads text files. Each line results in another element.

See Also:

Serialized Form

Nested Class Summary

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

org.apache.flink.api.common.io.FileInputFormat.FileBaseStatistics, org.apache.flink.api.common.io.FileInputFormat.InputSplitOpenThread

Field Summary

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

currBuffer, currLen, currOffset, RECORD_DELIMITER

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

currentSplit, ENUMERATE_NESTED_FILES_FLAG, enumerateNestedFiles, filePath, INFLATER_INPUT_STREAM_FACTORIES, minSplitSize, numSplits, openTimeout, READ_WHOLE_SPLIT_FLAG, splitLength, splitStart, stream, unsplittable

Constructor Summary

Constructors

Constructor and Description
TextInputFormat(org.apache.flink.core.fs.Path filePath)

Method Summary

Modifier and Type	Method and Description
void	configure(org.apache.flink.configuration.Configuration parameters)
String	getCharsetName()
String	readRecord(String reusable, byte[] bytes, int offset, int numBytes)
void	setCharsetName(String charsetName)
boolean	supportsMultiPaths()
String	toString()

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

close, getBufferSize, getCharset, getCurrentState, getDelimiter, getLineLengthLimit, getNumLineSamples, getStatistics, initializeSplit, loadConfigParameters, loadGlobalConfigParams, nextRecord, open, reachedEnd, readLine, reopen, setBufferSize, setCharset, setDelimiter, setDelimiter, setDelimiter, setLineLengthLimit, setNumLineSamples

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

acceptFile, createInputSplits, decorateInputStream, extractFileExtension, getFilePath, getFilePaths, getFileStats, getFileStats, getInflaterInputStreamFactory, getInputSplitAssigner, getMinSplitSize, getNestedFileEnumeration, getNumSplits, getOpenTimeout, getSplitLength, getSplitStart, registerInflaterInputStreamFactory, setFilePath, setFilePath, setFilePaths, setFilePaths, setFilesFilter, setMinSplitSize, setNestedFileEnumeration, setNumSplits, setOpenTimeout, testForUnsplittable

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

closeInputFormat, getRuntimeContext, openInputFormat, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TextInputFormat

public TextInputFormat(org.apache.flink.core.fs.Path filePath)

Method Detail

getCharsetName

public String getCharsetName()

setCharsetName

public void setCharsetName(String charsetName)

configure

public void configure(org.apache.flink.configuration.Configuration parameters)

Specified by:

configure in interface org.apache.flink.api.common.io.InputFormat<String,org.apache.flink.core.fs.FileInputSplit>

Overrides:

configure in class org.apache.flink.api.common.io.DelimitedInputFormat<String>

readRecord

public String readRecord(String reusable,
                         byte[] bytes,
                         int offset,
                         int numBytes)
                  throws IOException

Specified by:

readRecord in class org.apache.flink.api.common.io.DelimitedInputFormat<String>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class org.apache.flink.api.common.io.FileInputFormat<String>

supportsMultiPaths

public boolean supportsMultiPaths()

Overrides:

supportsMultiPaths in class org.apache.flink.api.common.io.FileInputFormat<String>