org.apache.flink.api.java.io

Class PrintingOutputFormat<T>

java.lang.Object

org.apache.flink.api.common.io.RichOutputFormat<T>

org.apache.flink.api.java.io.PrintingOutputFormat<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable, OutputFormat<T>

@PublicEvolving
public class PrintingOutputFormat<T>
extends RichOutputFormat<T>

Output format that prints results into either stdout or stderr.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PrintingOutputFormat() Instantiates a printing output format that prints to standard out.
PrintingOutputFormat(boolean stdErr) Instantiates a printing output format that prints to standard out.
PrintingOutputFormat(String sinkIdentifier, boolean stdErr) Instantiates a printing output format that prints to standard out with a prefixed message.

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(Configuration parameters) Configures this output format.
void	open(int taskNumber, int numTasks) Opens a parallel instance of the output format to store the result of its parallel instance.
void	setTargetToStandardErr()
void	setTargetToStandardOut()
String	toString()
void	writeRecord(T record) Adds a record to the output.

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

getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintingOutputFormat

public PrintingOutputFormat()

Instantiates a printing output format that prints to standard out.

PrintingOutputFormat

public PrintingOutputFormat(boolean stdErr)

Instantiates a printing output format that prints to standard out.

Parameters:

stdErr - True, if the format should print to standard error instead of standard out.

PrintingOutputFormat

public PrintingOutputFormat(String sinkIdentifier,
                            boolean stdErr)

Instantiates a printing output format that prints to standard out with a prefixed message.

Parameters:

sinkIdentifier - Message that is prefixed to the output of the value.

stdErr - True, if the format should print to standard error instead of standard out.

Method Detail

setTargetToStandardOut

public void setTargetToStandardOut()

setTargetToStandardErr

public void setTargetToStandardErr()

configure

public void configure(Configuration parameters)

Description copied from interface: OutputFormat

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.

Parameters:

parameters - The configuration with all parameters.

open

public void open(int taskNumber,
                 int numTasks)

Description copied from interface: OutputFormat

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.

Parameters:

taskNumber - The number of the parallel instance.

numTasks - The number of parallel tasks.

writeRecord

public void writeRecord(T record)

Description copied from interface: OutputFormat

Adds a record to the output.

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

Parameters:

record - The records to add to the output.

close

public void close()

Description copied from interface: OutputFormat

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.

toString

public String toString()

Overrides:

toString in class Object