org.apache.giraph.io.gora

Class GoraVertexInputFormat<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.io.GiraphInputFormat<I,V,E>

org.apache.giraph.io.VertexInputFormat<I,V,E>

org.apache.giraph.io.gora.GoraVertexInputFormat<I,V,E>

Type Parameters:

I - vertex id type

V - vertex value type

E - edge type

All Implemented Interfaces:

GiraphConfigurationSettable<I,V,E>, ImmutableClassesGiraphConfigurable<I,V,E>

Direct Known Subclasses:

GoraGVertexVertexInputFormat

public abstract class GoraVertexInputFormat<I extends org.apache.hadoop.io.WritableComparable,V extends org.apache.hadoop.io.Writable,E extends org.apache.hadoop.io.Writable>
extends VertexInputFormat<I,V,E>

Class which wraps the GoraInputFormat. It's designed as an extension point to VertexInputFormat subclasses who wish to read from Gora data sources. Works with GoraVertexOutputFormat

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GoraVertexInputFormat.GoraVertexReader Abstract class to be implemented by the user based on their specific vertex input.

Constructor Summary

Constructors

Constructor and Description
GoraVertexInputFormat()

Method Summary

Modifier and Type	Method and Description
void	checkInputSpecs(org.apache.hadoop.conf.Configuration conf) Check that input is valid.
org.apache.gora.store.DataStore	createDataStore(org.apache.hadoop.conf.Configuration conf) Gets the data store object initialized.
abstract GoraVertexInputFormat.GoraVertexReader	createVertexReader(org.apache.hadoop.mapreduce.InputSplit split, org.apache.hadoop.mapreduce.TaskAttemptContext context) Create a vertex reader for a given split.
static org.apache.gora.store.DataStore	getDataStore() Gets the data store.
static Class<? extends org.apache.gora.store.DataStore>	getDatastoreClass()
List<org.apache.hadoop.mapreduce.InputSplit>	getSplits(org.apache.hadoop.mapreduce.JobContext context, int minSplitCountHint) Gets the splits for a data store.
Object	getStartKey() Gets the start key for querying.
static void	setDataStore(org.apache.gora.store.DataStore dStore) Sets the data store
static void	setDatastoreClass(Class<? extends org.apache.gora.store.DataStore> dataStoreClass)
static void	setStartKey(Object startKey) Gets the start key for querying.

Methods inherited from class org.apache.giraph.io.GiraphInputFormat

readInputSplit, writeInputSplit

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

GoraVertexInputFormat

public GoraVertexInputFormat()

Method Detail

checkInputSpecs

public void checkInputSpecs(org.apache.hadoop.conf.Configuration conf)

Description copied from class: GiraphInputFormat

Check that input is valid.

Specified by:

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

Parameters:

conf - configuration parameters

createVertexReader

public abstract GoraVertexInputFormat.GoraVertexReader createVertexReader(org.apache.hadoop.mapreduce.InputSplit split,
                                                                          org.apache.hadoop.mapreduce.TaskAttemptContext context)
                                                                   throws IOException

Create a vertex reader for a given split. Guaranteed to have been configured with setConf() prior to use. The framework will also call VertexReader.initialize(InputSplit, TaskAttemptContext) before the split is used.

Specified by:

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

Parameters:

split - the split to be read

context - the information about the task

Returns:

a new record reader

Throws:

IOException

getSplits

public List<org.apache.hadoop.mapreduce.InputSplit> getSplits(org.apache.hadoop.mapreduce.JobContext context,
                                                              int minSplitCountHint)
                                                       throws IOException,
                                                              InterruptedException

Gets the splits for a data store.

Specified by:

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

Parameters:

context - JobContext

minSplitCountHint - Hint for a minimum split count

Returns:

A list of splits

Throws:

IOException

InterruptedException

createDataStore

public org.apache.gora.store.DataStore createDataStore(org.apache.hadoop.conf.Configuration conf)

Gets the data store object initialized.

Parameters:

conf - Configuration

Returns:

DataStore created

getDatastoreClass

public static Class<? extends org.apache.gora.store.DataStore> getDatastoreClass()

Returns:

Class the DATASTORE_CLASS

setDatastoreClass

public static void setDatastoreClass(Class<? extends org.apache.gora.store.DataStore> dataStoreClass)

Parameters:

dataStoreClass - the dataStore class to set

getStartKey

public Object getStartKey()

Gets the start key for querying.

Returns:

the start key.

setStartKey

public static void setStartKey(Object startKey)

Gets the start key for querying.

Parameters:

startKey - start key.

getDataStore

public static org.apache.gora.store.DataStore getDataStore()

Gets the data store.

Returns:

DataStore

setDataStore

public static void setDataStore(org.apache.gora.store.DataStore dStore)

Sets the data store

Parameters:

dStore - the dATA_STORE to set