org.kepler.stratosphere.io.output

Class TokenOutputFormat

java.lang.Object

org.kepler.stratosphere.io.output.TokenOutputFormat

All Implemented Interfaces:

eu.stratosphere.api.common.io.OutputFormat<eu.stratosphere.types.Record>, java.io.Serializable

public class TokenOutputFormat
extends java.lang.Object
implements eu.stratosphere.api.common.io.OutputFormat<eu.stratosphere.types.Record>

An output format for Ptolemy tokens.

Author:

Daniel Crawl

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TokenOutputFormat.AbstractConfigBuilder<T> Abstract builder used to set parameters to the input format's configuration in a fluent way.
static class	TokenOutputFormat.ConfigBuilder A builder used to set parameters to the input format's configuration in a fluent way.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_TYPE_PARAMETER_PREFIX
static java.lang.String	NUM_FIELDS_PARAMETER
static java.lang.String	RECORD_POSITION_PARAMETER_PREFIX

Constructor Summary

Constructors

Constructor and Description
TokenOutputFormat()

Method Summary

Modifier and Type	Method and Description
void	close() Method that marks the end of the life-cycle of parallel output instance.
void	configure(eu.stratosphere.configuration.Configuration parameters) Configures this output format.
static TokenOutputFormat.ConfigBuilder	configureRecordFormat(eu.stratosphere.api.common.operators.GenericDataSink target) Creates a configuration builder that can be used to set the input format's parameters to the config in a fluent fashion.
void	open(int taskNumber) Opens a parallel instance of the output format to store the result of its parallel instance.
void	writeRecord(eu.stratosphere.types.Record record) Adds a record to the output.

Methods inherited from class java.lang.Object

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

Field Detail

NUM_FIELDS_PARAMETER

public static final java.lang.String NUM_FIELDS_PARAMETER

See Also:

Constant Field Values

FIELD_TYPE_PARAMETER_PREFIX

public static final java.lang.String FIELD_TYPE_PARAMETER_PREFIX

See Also:

Constant Field Values

RECORD_POSITION_PARAMETER_PREFIX

public static final java.lang.String RECORD_POSITION_PARAMETER_PREFIX

See Also:

Constant Field Values

Constructor Detail

TokenOutputFormat

public TokenOutputFormat()

Method Detail

configure

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

Configures this output format. Since output formats are instantiated generically and hence parameterless, this method is the place where the output formats set their basic fields based on configuration values.

This method is always called first on a newly instantiated output format.

Specified by:

configure in interface eu.stratosphere.api.common.io.OutputFormat<eu.stratosphere.types.Record>

Parameters:

parameters - The configuration with all parameters.

open

public void open(int taskNumber)
          throws java.io.IOException

Opens a parallel instance of the output format to store the result of its parallel instance.

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

Specified by:

open in interface eu.stratosphere.api.common.io.OutputFormat<eu.stratosphere.types.Record>

Parameters:

taskNumber - The number of the parallel instance.

Throws:

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

writeRecord

public void writeRecord(eu.stratosphere.types.Record record)
                 throws java.io.IOException

Adds a record to the output.

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

Specified by:

writeRecord in interface eu.stratosphere.api.common.io.OutputFormat<eu.stratosphere.types.Record>

Parameters:

record - The records to add to the output.

Throws:

java.io.IOException - Thrown, if the records could not be added to to an I/O problem.

close

public void close()
           throws java.io.IOException

Method that marks the end of the life-cycle of parallel output instance. Should be used to close channels and streams and release resources. After this method returns without an error, the output is assumed to be correct.

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

Specified by:

close in interface eu.stratosphere.api.common.io.OutputFormat<eu.stratosphere.types.Record>

Throws:

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

configureRecordFormat

public static TokenOutputFormat.ConfigBuilder configureRecordFormat(eu.stratosphere.api.common.operators.GenericDataSink target)

Creates a configuration builder that can be used to set the input format's parameters to the config in a fluent fashion.

Returns:

A config builder for setting parameters.