org.apache.giraph.io.gora

Class GoraVertexInputFormat.GoraVertexReader

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.gora.GoraVertexInputFormat.GoraVertexReader

All Implemented Interfaces:

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

Direct Known Subclasses:

GoraGVertexVertexInputFormat.GoraGVertexVertexReader

Enclosing class:

GoraVertexInputFormat<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>

protected abstract class GoraVertexInputFormat.GoraVertexReader
extends VertexReader<I,V,E>

Abstract class to be implemented by the user based on their specific vertex input. Easiest to ignore the key value separator and only use key instead.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GoraVertexReader()

Method Summary

Modifier and Type	Method and Description
void	close() Finishes the reading process.
Vertex<I,V,E>	getCurrentVertex() Gets current vertex.
float	getProgress() Gets the progress of reading results from Gora.
protected void	getResults() Performs a range query to a Gora data store.
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() Gets the next vertex from Gora data store.
protected abstract Vertex<I,V,E>	transformVertex(Object goraObject) Parser for a single Gora 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, setConf

Methods inherited from class java.lang.Object

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

Constructor Detail

GoraVertexReader

protected GoraVertexReader()

Method Detail

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

nextVertex

public boolean nextVertex()
                   throws IOException,
                          InterruptedException

Gets the next vertex from Gora data store.

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:

true/false depending on the existence of vertices.

Throws:

IOException - exceptions passed along.

InterruptedException - exceptions passed along.

getProgress

public float getProgress()
                  throws IOException,
                         InterruptedException

Gets the progress of reading results from Gora.

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:

the progress of reading results from Gora.

Throws:

IOException

InterruptedException

getCurrentVertex

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

Gets 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 vertex object represented by a Gora object

Throws:

IOException

InterruptedException

transformVertex

protected abstract Vertex<I,V,E> transformVertex(Object goraObject)

Parser for a single Gora object

Parameters:

goraObject - vertex represented as a GoraObject

Returns:

The vertex object represented by a Gora object

getResults

protected void getResults()

Performs a range query to a Gora data store.

close

public void close()
           throws IOException

Finishes the reading process.

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