co.cask.cdap.data.file

Class PartitionedFileWriter<T,P>

java.lang.Object

co.cask.cdap.data.file.PartitionedFileWriter<T,P>

Type Parameters:

T - Type of event.

P - Type of partition.

All Implemented Interfaces:

FileWriter<T>, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

TimePartitionedStreamFileWriter

@NotThreadSafe
public abstract class PartitionedFileWriter<T,P>
extends Object
implements FileWriter<T>

An abstract base class for implementation partitioned FileWriter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	PartitionedFileWriter.PartitionedFileWriterFactory<T,P>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PartitionedFileWriter(PartitionedFileWriter.PartitionedFileWriterFactory<T,P> fileWriterFactory) Constructs with the given file writer factory.

Method Summary

Methods

Modifier and Type	Method and Description
void	append(T event) Appends an event to the file.
void	appendAll(Iterator<? extends T> events) Appends multiple events to the file.
void	close()
protected void	closePartitionWriter(P partition) Closes the FileWriter for the given partition.
void	flush()
protected abstract P	getPartition(T event) Returns the partition ID for the given event.
protected void	partitionChanged(P oldPartition, P newPartition) Invoked when partition changed (different from the last event get appended).

Methods inherited from class java.lang.Object

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

Constructor Detail

PartitionedFileWriter

protected PartitionedFileWriter(PartitionedFileWriter.PartitionedFileWriterFactory<T,P> fileWriterFactory)

Constructs with the given file writer factory.

Method Detail

append

public void append(T event)
            throws IOException

Description copied from interface: FileWriter

Appends an event to the file.

Specified by:

append in interface FileWriter<T>

Parameters:

event - event to append

Throws:

IOException - if fail to append

appendAll

public void appendAll(Iterator<? extends T> events)
               throws IOException

Description copied from interface: FileWriter

Appends multiple events to the file. This method will block until the iterator ends.

Specified by:

appendAll in interface FileWriter<T>

Parameters:

events - an Iterator that provides events to append

Throws:

IOException - if fail to append

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

closePartitionWriter

protected final void closePartitionWriter(P partition)
                                   throws IOException

Closes the FileWriter for the given partition.

Throws:

IOException

partitionChanged

protected void partitionChanged(P oldPartition,
                    P newPartition)
                         throws IOException

Invoked when partition changed (different from the last event get appended).

Throws:

IOException

getPartition

protected abstract P getPartition(T event)

Returns the partition ID for the given event.

Parameters:

event - The event for computing a partition ID.

Returns:

A long representing the partition ID.