com.google.appengine.tools.mapreduce.outputs

Class MarshallingOutput<O,R>

java.lang.Object

com.google.appengine.tools.mapreduce.Output<O,R>

com.google.appengine.tools.mapreduce.outputs.MarshallingOutput<O,R>

Type Parameters:

O - type of values produced by this output

R - type returned by finish(java.util.Collection<? extends com.google.appengine.tools.mapreduce.OutputWriter<O>>) on the supplied sink

All Implemented Interfaces:

Serializable

public class MarshallingOutput<O,R>
extends Output<O,R>

An Output that marshalls records.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MarshallingOutput(Output<ByteBuffer,R> sink, Marshaller<O> marshaller)

Method Summary

Methods

Modifier and Type	Method and Description
List<MarshallingOutputWriter<O>>	createWriters(int numShards) Returns a list of writers, one for each shard, for this output.
R	finish(Collection<? extends OutputWriter<O>> writers) Returns a result to be made available through MapReduceResult.getOutputResult().

Methods inherited from class com.google.appengine.tools.mapreduce.Output

getContext, setContext

Methods inherited from class java.lang.Object

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

Constructor Detail

MarshallingOutput

public MarshallingOutput(Output<ByteBuffer,R> sink,
                 Marshaller<O> marshaller)

Method Detail

createWriters

public List<MarshallingOutputWriter<O>> createWriters(int numShards)

Description copied from class: Output

Returns a list of writers, one for each shard, for this output.

Specified by:

createWriters in class Output<O,R>

Parameters:

numShards - The number of shards which should be equal to the number of OutputWriters returned.

finish

public R finish(Collection<? extends OutputWriter<O>> writers)
         throws IOException

Description copied from class: Output

Returns a result to be made available through MapReduceResult.getOutputResult().

This method allows the Output to inspect the final state of its OutputWriters to produce a final result object. For example, if the OutputWriters produce blobs in blobstore, finish could collect and return a list of blob IDs.

Should return null if no such result makes sense for this kind of output.

Called after all OutputWriters have been closed (with OutputWriter.close()). It is possible for this method to be called more than once with the same writers collection. It is also possible for the job to fail after this is invoked.

The writers argument will contain the same writers that Output.createWriters(int) returned in the same order. Writers may be serialized and deserialized multiple times. typically, getWriter will have been called in a different JVM.

Specified by:

finish in class Output<O,R>

Throws:

IOException