org.kepler.stratosphere.io.input

Class TokenInputFormat

java.lang.Object

eu.stratosphere.api.common.io.GenericInputFormat<eu.stratosphere.types.Record>

eu.stratosphere.api.java.record.io.GenericInputFormat

org.kepler.stratosphere.io.input.TokenInputFormat

All Implemented Interfaces:

eu.stratosphere.api.common.io.InputFormat<eu.stratosphere.types.Record,eu.stratosphere.core.io.GenericInputSplit>, java.io.Serializable

public class TokenInputFormat
extends eu.stratosphere.api.java.record.io.GenericInputFormat

An input format for Ptolemy tokens. FIXME: only supports array of strings tokens.

Author:

Daniel Crawl

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.stratosphere.api.common.io.GenericInputFormat

partitionNumber

Constructor Summary

Constructors

Constructor and Description
TokenInputFormat()

Method Summary

Modifier and Type	Method and Description
void	close() Close an input split.
void	configure(eu.stratosphere.configuration.Configuration parameters) Configure the format.
TokenInputSplit[]	createInputSplits(int numSplits) Create the input splits that can be processed in parallel.
boolean	nextRecord(eu.stratosphere.types.Record record) Populate a Record with the token from the split.
void	open(eu.stratosphere.core.io.GenericInputSplit split) Opens a parallel instance of the input format to work on a split.
boolean	reachedEnd() See if the token split has been read.

Methods inherited from class eu.stratosphere.api.common.io.GenericInputFormat

getInputSplitType, getStatistics

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenInputFormat

public TokenInputFormat()

Method Detail

configure

public void configure(eu.stratosphere.configuration.Configuration parameters)

Configure the format.

Specified by:

configure in interface eu.stratosphere.api.common.io.InputFormat<eu.stratosphere.types.Record,eu.stratosphere.core.io.GenericInputSplit>

Overrides:

configure in class eu.stratosphere.api.common.io.GenericInputFormat<eu.stratosphere.types.Record>

createInputSplits

public TokenInputSplit[] createInputSplits(int numSplits)
                                    throws java.io.IOException

Create the input splits that can be processed in parallel.

Specified by:

createInputSplits in interface eu.stratosphere.api.common.io.InputFormat<eu.stratosphere.types.Record,eu.stratosphere.core.io.GenericInputSplit>

Overrides:

createInputSplits in class eu.stratosphere.api.common.io.GenericInputFormat<eu.stratosphere.types.Record>

Parameters:

numSplits - The minimum number of splits to create. If fewer are created, some instances may remain idle.

Throws:

java.io.IOException

open

public void open(eu.stratosphere.core.io.GenericInputSplit split)
          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.

Specified by:

open in interface eu.stratosphere.api.common.io.InputFormat<eu.stratosphere.types.Record,eu.stratosphere.core.io.GenericInputSplit>

Overrides:

open in class eu.stratosphere.api.common.io.GenericInputFormat<eu.stratosphere.types.Record>

Parameters:

split - The split to be opened.

Throws:

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

close

public void close()
           throws java.io.IOException

Close an input split.

Specified by:

close in interface eu.stratosphere.api.common.io.InputFormat<eu.stratosphere.types.Record,eu.stratosphere.core.io.GenericInputSplit>

Overrides:

close in class eu.stratosphere.api.common.io.GenericInputFormat<eu.stratosphere.types.Record>

Throws:

java.io.IOException

reachedEnd

public boolean reachedEnd()
                   throws java.io.IOException

See if the token split has been read.

Throws:

java.io.IOException

nextRecord

public boolean nextRecord(eu.stratosphere.types.Record record)
                   throws java.io.IOException

Populate a Record with the token from the split.

Returns:

True if the token split has not already been read, otherwise false.

Throws:

java.io.IOException