org.apache.giraph.io.iterables

Class VertexReaderWrapper<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E 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.VertexReader<I,V,E>

org.apache.giraph.io.iterables.VertexReaderWrapper<I,V,E>

Type Parameters:

I - Vertex id

V - Vertex data

E - Edge data

All Implemented Interfaces:

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

public class VertexReaderWrapper<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>
extends VertexReader<I,V,E>

Wraps GiraphReader for vertices into VertexReader

Constructor Summary

Constructors

Constructor and Description
VertexReaderWrapper(GiraphReader<Vertex<I,V,E>> vertexReader) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Close this VertexReader to future operations.
Vertex<I,V,E>	getCurrentVertex() Get the current vertex.
float	getProgress() How much of the input has the VertexReader consumed i.e.
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.
boolean	nextVertex()
void	setConf(ImmutableClassesGiraphConfiguration<I,V,E> conf) Set the configuration to be used by this object.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

VertexReaderWrapper

public VertexReaderWrapper(GiraphReader<Vertex<I,V,E>> vertexReader)

Constructor

Parameters:

vertexReader - GiraphReader for vertices to wrap

Method Detail

setConf

public void setConf(ImmutableClassesGiraphConfiguration<I,V,E> conf)

Description copied from interface: GiraphConfigurationSettable

Set the configuration to be used by this object.

Specified by:

setConf in interface GiraphConfigurationSettable<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Overrides:

setConf in class DefaultImmutableClassesGiraphConfigurable<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Parameters:

conf - Set configuration

nextVertex

public boolean nextVertex()
                   throws IOException,
                          InterruptedException

Specified by:

nextVertex in class VertexReader<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Returns:

false iff there are no more vertices

Throws:

IOException

InterruptedException

getCurrentVertex

public Vertex<I,V,E> getCurrentVertex()
                               throws IOException,
                                      InterruptedException

Description copied from class: VertexReader

Get the current vertex.

Specified by:

getCurrentVertex in class VertexReader<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Returns:

the current vertex which has been read. nextVertex() should be called first.

Throws:

IOException

InterruptedException

initialize

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

Description copied from class: VertexReader

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

Specified by:

initialize in class VertexReader<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Parameters:

inputSplit - Input split to be used for reading vertices.

context - Context from the task.

Throws:

IOException

InterruptedException

close

public void close()
           throws IOException

Description copied from class: VertexReader

Close this VertexReader to future operations.

Specified by:

close in class VertexReader<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Throws:

IOException

getProgress

public float getProgress()
                  throws IOException,
                         InterruptedException

Description copied from class: VertexReader

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

Specified by:

getProgress in class VertexReader<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

Returns:

Progress from 0.0 to 1.0.

Throws:

IOException

InterruptedException