edu.iu.dsc.tws.data.fs.io

Interface InputSplit<OT>

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ArrowInputSplit, BinaryInputSplit, CSVInputSplit, DelimitedInputSplit, FileInputSplit, GenericCSVInputSplit, LocatableInputSplit, TextInputSplit

public interface InputSplit<OT>
extends java.io.Serializable

This interface must be implemented by all kind of input splits that can be assigned to input formats.

Input splits are transferred in serialized form via the messages, so they need to be serializable as defined by Serializable.

Method Summary

Modifier and Type	Method and Description
void	close() Method that marks the end of the life-cycle of an input split.
void	configure(Config parameters) Configure the split with parameters
int	getSplitNumber() Returns the number of this input split.
OT	nextRecord(OT reuse) Reads the next record from the input.
void	open() Opens a parallel instance of the input format to work on a split.
void	open(Config config)
boolean	reachedEnd() Method used to check if the end of the input is reached.

Method Detail

configure

void configure(Config parameters)

Configure the split with parameters

Parameters:

parameters - the parameters

getSplitNumber

int getSplitNumber()

Returns the number of this input split.

Returns:

the number of this input split

open

void open()
   throws java.io.IOException

Opens a parallel instance of the input format to work on a split.

When this method is called, the input format it guaranteed to be configured.

Throws:

java.io.IOException - Thrown, if the spit could not be opened due to an I/O problem.

open

void open(Config config)
   throws java.io.IOException

Throws:

java.io.IOException

reachedEnd

boolean reachedEnd()
            throws java.io.IOException

Method used to check if the end of the input is reached.

When this method is called, the input format it guaranteed to be opened.

Returns:

True if the end is reached, otherwise false.

Throws:

java.io.IOException - Thrown, if an I/O error occurred.

nextRecord

OT nextRecord(OT reuse)
       throws java.io.IOException

Reads the next record from the input.

When this method is called, the input format it guaranteed to be opened.

Parameters:

reuse - Object that may be reused.

Returns:

Read record.

Throws:

java.io.IOException - Thrown, if an I/O error occurred.

close

void close()
    throws java.io.IOException

Method that marks the end of the life-cycle of an input split. Should be used to close channels and streams and release resources. After this method returns without an error, the input is assumed to be correctly read.

When this method is called, the input format it guaranteed to be opened.

Throws:

java.io.IOException - Thrown, if the input could not be closed properly.