org.apache.giraph.io.gora.utils

Class GoraUtils

java.lang.Object

org.apache.giraph.io.gora.utils.GoraUtils

public class GoraUtils
extends Object

Class used to handle the creation and querying of data stores through Gora.

Method Summary

Modifier and Type	Method and Description
static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.store.DataStore<K,T>	createDataStore(org.apache.hadoop.conf.Configuration conf, Class<K> keyClass, Class<T> persistentClass) Creates a generic data store using the data store class.
static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.store.DataStore<K,T>	createSpecificDataStore(org.apache.hadoop.conf.Configuration conf, Class<? extends org.apache.gora.store.DataStore> dataStoreClass, Class<K> keyClass, Class<T> persistentClass) Creates a specific data store specified by.
static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Query<K,T>	getQuery(org.apache.gora.store.DataStore<K,T> pDataStore) Gets a query object to be used as a simple get.
static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Query<K,T>	getQuery(org.apache.gora.store.DataStore<K,T> pDataStore, K pStartKey) Gets a query object to be used as a simple get.
static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.impl.QueryBase	getQuery(org.apache.gora.store.DataStore pDataStore, K pStartKey, K pEndKey) Gets a query object to be used as a range query.
static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Result<K,T>	getRequest(org.apache.gora.store.DataStore<K,T> pDataStore, K pStartKey) Performs a range query to Gora datastores
static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Result<K,T>	getRequest(org.apache.gora.store.DataStore<K,T> pDataStore, K pStartKey, K pEndKey) Performs a range query to Gora datastores
static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Result<K,T>	getRequest(org.apache.gora.store.DataStore<K,T> pDataStore, org.apache.gora.query.Query<K,T> query) Performs a query to Gora datastores

Methods inherited from class java.lang.Object

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

Method Detail

createDataStore

public static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.store.DataStore<K,T> createDataStore(org.apache.hadoop.conf.Configuration conf,
                                                                                                                        Class<K> keyClass,
                                                                                                                        Class<T> persistentClass)
                                                                                                                 throws org.apache.gora.util.GoraException

Creates a generic data store using the data store class. set using the class property

Type Parameters:

K - key class

T - value class

Parameters:

conf - Configuration

keyClass - key class used

persistentClass - persistent class used

Returns:

created data store

Throws:

org.apache.gora.util.GoraException - exception threw

createSpecificDataStore

public static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.store.DataStore<K,T> createSpecificDataStore(org.apache.hadoop.conf.Configuration conf,
                                                                                                                                Class<? extends org.apache.gora.store.DataStore> dataStoreClass,
                                                                                                                                Class<K> keyClass,
                                                                                                                                Class<T> persistentClass)
                                                                                                                         throws org.apache.gora.util.GoraException

Creates a specific data store specified by.

Type Parameters:

K - key class

T - value class

Parameters:

conf - Configuration

dataStoreClass - Defines the type of data store used.

keyClass - Handles the key class to be used.

persistentClass - Handles the persistent class to be used.

Returns:

DataStore created using parameters passed.

Throws:

org.apache.gora.util.GoraException - if an error occurs.

getRequest

public static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Result<K,T> getRequest(org.apache.gora.store.DataStore<K,T> pDataStore,
                                                                                                                K pStartKey,
                                                                                                                K pEndKey)

Performs a range query to Gora datastores

Type Parameters:

K - key class

T - value class

Parameters:

pDataStore - data store being used.

pStartKey - start key for the range query.

pEndKey - end key for the range query.

Returns:

Result containing all results for the query.

getRequest

public static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Result<K,T> getRequest(org.apache.gora.store.DataStore<K,T> pDataStore,
                                                                                                                org.apache.gora.query.Query<K,T> query)

Performs a query to Gora datastores

Type Parameters:

K - key class

T - value class

Parameters:

pDataStore - data store being used.

query - query executed over data stores.

Returns:

Result containing all results for the query.

getRequest

public static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Result<K,T> getRequest(org.apache.gora.store.DataStore<K,T> pDataStore,
                                                                                                                K pStartKey)

Performs a range query to Gora datastores

Type Parameters:

K - key class

T - value class

Parameters:

pDataStore - data store being used.

pStartKey - start key for the range query.

Returns:

Result containing all results for the query.

getQuery

public static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.impl.QueryBase getQuery(org.apache.gora.store.DataStore pDataStore,
                                                                                                                 K pStartKey,
                                                                                                                 K pEndKey)

Gets a query object to be used as a range query.

Type Parameters:

K - key class

T - value class

Parameters:

pDataStore - data store used.

pStartKey - range start key.

pEndKey - range end key.

Returns:

range query object.

getQuery

public static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Query<K,T> getQuery(org.apache.gora.store.DataStore<K,T> pDataStore,
                                                                                                             K pStartKey)

Gets a query object to be used as a simple get.

Type Parameters:

K - key class

T - value class

Parameters:

pDataStore - data store used.

pStartKey - range start key.

Returns:

query object.

getQuery

public static <K,T extends org.apache.gora.persistency.Persistent> org.apache.gora.query.Query<K,T> getQuery(org.apache.gora.store.DataStore<K,T> pDataStore)

Gets a query object to be used as a simple get.

Type Parameters:

K - key class

T - value class

Parameters:

pDataStore - data store used.

Returns:

query object.