org.apache.giraph.io

Class MappingReader<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,B extends org.apache.hadoop.io.Writable>

java.lang.Object

org.apache.giraph.conf.DefaultImmutableClassesGiraphConfigurable<I,V,E>

org.apache.giraph.worker.WorkerAggregatorDelegator<I,V,E>

org.apache.giraph.io.MappingReader<I,V,E,B>

Type Parameters:

I - vertexId type

V - vertexValue type

E - edgeValue type

B - mappingTarget type

All Implemented Interfaces:

AggregatorUsage, GiraphConfigurationSettable<I,V,E>, ImmutableClassesGiraphConfigurable<I,V,E>, WorkerAggregatorUsage, WorkerBroadcastUsage, WorkerGlobalCommUsage, WorkerReduceUsage

Direct Known Subclasses:

MappingReaderWrapper, WrappedMappingReader

public abstract class MappingReader<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable,B extends org.apache.hadoop.io.Writable>
extends WorkerAggregatorDelegator<I,V,E>

Will read the mapping from an input split.

Constructor Summary

Constructors

Constructor and Description
MappingReader()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Close this MappingReader to future operations.
abstract MappingEntry<I,B>	getCurrentEntry() Get the current entry.
abstract float	getProgress() How much of the input has the VertexReader consumed i.e.
abstract void	initialize(org.apache.hadoop.mapreduce.InputSplit inputSplit, org.apache.hadoop.mapreduce.TaskAttemptContext context) Use the input split and context to setup reading the vertices.
abstract boolean	nextEntry()

Methods inherited from class org.apache.giraph.worker.WorkerAggregatorDelegator

aggregate, getAggregatedValue, getBroadcast, reduce, reduceMerge, setWorkerGlobalCommUsage

Methods inherited from class org.apache.giraph.conf.DefaultImmutableClassesGiraphConfigurable

getConf, setConf

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingReader

public MappingReader()

Method Detail

initialize

public abstract void initialize(org.apache.hadoop.mapreduce.InputSplit inputSplit,
                                org.apache.hadoop.mapreduce.TaskAttemptContext context)
                         throws IOException,
                                InterruptedException

Use the input split and context to setup reading the vertices. Guaranteed to be called prior to any other function.

Parameters:

inputSplit - Input split to be used for reading vertices.

context - Context from the task.

Throws:

IOException

InterruptedException

nextEntry

public abstract boolean nextEntry()
                           throws IOException,
                                  InterruptedException

Returns:

false iff there are no more vertices

Throws:

IOException

InterruptedException

getCurrentEntry

public abstract MappingEntry<I,B> getCurrentEntry()
                                           throws IOException,
                                                  InterruptedException

Get the current entry.

Returns:

the current entry which has been read. nextVEntry() should be called first.

Throws:

IOException

InterruptedException

close

public abstract void close()
                    throws IOException

Close this MappingReader to future operations.

Throws:

IOException

getProgress

public abstract float getProgress()
                           throws IOException,
                                  InterruptedException

How much of the input has the VertexReader consumed i.e. has been processed by?

Returns:

Progress from 0.0 to 1.0.

Throws:

IOException

InterruptedException