org.apache.flink.formats.sequencefile

Class SequenceFileWriter<K extends org.apache.hadoop.io.Writable,V extends org.apache.hadoop.io.Writable>

java.lang.Object

org.apache.flink.formats.sequencefile.SequenceFileWriter<K,V>

Type Parameters:

K - The type of key written.

V - The type of value written.

All Implemented Interfaces:

BulkWriter<Tuple2<K,V>>

@PublicEvolving
public class SequenceFileWriter<K extends org.apache.hadoop.io.Writable,V extends org.apache.hadoop.io.Writable>
extends Object
implements BulkWriter<Tuple2<K,V>>

A BulkWriter implementation that wraps a SequenceFile.Writer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.api.common.serialization.BulkWriter

BulkWriter.Factory<T>

Method Summary

Modifier and Type	Method and Description
void	addElement(Tuple2<K,V> element) Adds an element to the encoder.
void	finish() Finishes the writing.
void	flush() Flushes all intermediate buffered data to the output stream.

Methods inherited from class java.lang.Object

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

Method Detail

addElement

public void addElement(Tuple2<K,V> element)
                throws IOException

Description copied from interface: BulkWriter

Adds an element to the encoder. The encoder may temporarily buffer the element, or immediately write it to the stream.

It may be that adding this element fills up an internal buffer and causes the encoding and flushing of a batch of internally buffered elements.

Specified by:

addElement in interface BulkWriter<Tuple2<K extends org.apache.hadoop.io.Writable,V extends org.apache.hadoop.io.Writable>>

Parameters:

element - The element to add.

Throws:

IOException - Thrown, if the element cannot be added to the encoder, or if the output stream throws an exception.

flush

public void flush()
           throws IOException

Description copied from interface: BulkWriter

Flushes all intermediate buffered data to the output stream. It is expected that flushing often may reduce the efficiency of the encoding.

Specified by:

flush in interface BulkWriter<Tuple2<K extends org.apache.hadoop.io.Writable,V extends org.apache.hadoop.io.Writable>>

Throws:

IOException - Thrown if the encoder cannot be flushed, or if the output stream throws an exception.

finish

public void finish()
            throws IOException

Description copied from interface: BulkWriter

Finishes the writing. This must flush all internal buffer, finish encoding, and write footers.

The writer is not expected to handle any more records via BulkWriter.addElement(Object) after this method is called.

Important: This method MUST NOT close the stream that the writer writes to. Closing the stream is expected to happen through the invoker of this method afterwards.

Specified by:

finish in interface BulkWriter<Tuple2<K extends org.apache.hadoop.io.Writable,V extends org.apache.hadoop.io.Writable>>

Throws:

IOException - Thrown if the finalization fails.