org.apache.gora.infinispan.store

Class InfinispanStore<K,T extends PersistentBase>

java.lang.Object

org.apache.gora.store.impl.DataStoreBase<K,T>

org.apache.gora.infinispan.store.InfinispanStore<K,T>

All Implemented Interfaces:

Closeable, AutoCloseable, DataStore<K,T>, org.apache.hadoop.conf.Configurable, org.apache.hadoop.io.Writable

public class InfinispanStore<K,T extends PersistentBase>
extends DataStoreBase<K,T>

InfinispanStore is the primary class responsible for directing Gora CRUD operations to Infinispan.This class delegate most operations, e.g., initialization, creation and deletion to (Infinispan caches), via InfinispanClient. To specify the Infinispan deployment, include parameter infinispan.connectionstring in gora.properties with the list of servers, e.g., "127.0.0.1:11222,127.0.0.1:11223".

Author:

Pierre Sutra, Valerio Schiavoni

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Fields inherited from class org.apache.gora.store.impl.DataStoreBase

autoCreateSchema, beanFactory, conf, datumReader, datumWriter, fieldMap, keyClass, persistentClass, properties, schema

Constructor Summary

Constructors

Constructor and Description
InfinispanStore() Default constructor

Method Summary

Modifier and Type	Method and Description
void	close() Close the DataStore.
void	createSchema() Creates the optional schema or table (or similar) in the datastore to hold the objects.
boolean	delete(K key) Deletes the object with the given key
long	deleteByQuery(Query<K,T> query) Deletes all the objects matching the query.
void	deleteSchema() Deletes the underlying schema or table (or similar) in the datastore that holds the objects.
Result<K,T>	execute(Query<K,T> query) Execute the query and return the result.
void	flush() Forces the write caches to be flushed.
T	get(K key) Returns the object corresponding to the given key fetching all the fields.
T	get(K key, String[] fields) Returns the object corresponding to the given key.
InfinispanClient<K,T>	getClient()
List<PartitionQuery<K,T>>	getPartitions(Query<K,T> query) Split the query per infinispan node resulting in a list of queries.
String	getPrimaryFieldName()
int	getPrimaryFieldPos()
String	getSchemaName() In Infinispan, Schemas are referred to as caches.
void	initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties) Initialize the data store by reading the credentials, setting the client's properties up and reading the mapping file.
Query<K,T>	newQuery() Constructs and returns a new Query.
void	put(K key, T obj) Inserts the persistent object with the given key.
boolean	schemaExists() Returns whether the schema that holds the data exists in the datastore.
void	setPrimaryFieldName(String name)
void	setPrimaryFieldPos(int p)

Methods inherited from class org.apache.gora.store.impl.DataStoreBase

equals, getBeanFactory, getConf, getFields, getFieldsToQuery, getKeyClass, getOrCreateConf, getPersistentClass, getSchemaName, newKey, newPersistent, readFields, setBeanFactory, setConf, setKeyClass, setPersistentClass, truncateSchema, write

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

InfinispanStore

public InfinispanStore()

Default constructor

Method Detail

initialize

public void initialize(Class<K> keyClass,
                       Class<T> persistentClass,
                       Properties properties)

Initialize the data store by reading the credentials, setting the client's properties up and reading the mapping file. Initialize is called when then the call to DataStoreFactory.createDataStore(java.lang.Class<D>, java.lang.Class<K>, java.lang.Class<T>, org.apache.hadoop.conf.Configuration) is made.

Specified by:

initialize in interface DataStore<K,T extends PersistentBase>

Overrides:

initialize in class DataStoreBase<K,T extends PersistentBase>

Parameters:

keyClass -

persistentClass -

properties -

close

public void close()

Description copied from interface: DataStore

Close the DataStore. This should release any resources held by the implementation, so that the instance is ready for GC. All other DataStore methods cannot be used after this method was called. Subsequent calls of this method are ignored.

createSchema

public void createSchema()

Description copied from interface: DataStore

Creates the optional schema or table (or similar) in the datastore to hold the objects. If the schema is already created previously, or the underlying data model does not support or need this operation, the operation is ignored.

delete

public boolean delete(K key)

Description copied from interface: DataStore

Deletes the object with the given key

Parameters:

key - the key of the object

Returns:

whether the object was successfully deleted

deleteByQuery

public long deleteByQuery(Query<K,T> query)

Description copied from interface: DataStore

Deletes all the objects matching the query. See also the note on visibility.

Parameters:

query - matching records to this query will be deleted

Returns:

number of deleted records

deleteSchema

public void deleteSchema()

Description copied from interface: DataStore

Deletes the underlying schema or table (or similar) in the datastore that holds the objects. This also deletes all the data associated with the schema.

execute

public Result<K,T> execute(Query<K,T> query)

Execute the query and return the result.

Parameters:

query - the query to execute.

Returns:

the results as a Result object.

get

public T get(K key)

Description copied from interface: DataStore

Returns the object corresponding to the given key fetching all the fields.

Specified by:

get in interface DataStore<K,T extends PersistentBase>

Overrides:

get in class DataStoreBase<K,T extends PersistentBase>

Parameters:

key - the key of the object

Returns:

the Object corresponding to the key or null if it cannot be found

get

public T get(K key,
             String[] fields)

Description copied from interface: DataStore

Returns the object corresponding to the given key.

Parameters:

key - the key of the object

fields - the fields required in the object. Pass null, to retrieve all fields

Returns:

the Object corresponding to the key or null if it cannot be found

getPartitions

public List<PartitionQuery<K,T>> getPartitions(Query<K,T> query)
                                        throws IOException

Split the query per infinispan node resulting in a list of queries. For each Infinispan server, this function returns a set of qeuries using pagination of the originial query. The size of each query in this pagination equals gora.buffer.read.limit.

Parameters:

query - the base query to create the partitions for. If the query is null, then the data store returns the partitions for the default query (returning every object)

Returns:

Throws:

IOException

flush

public void flush()

Description copied from interface: DataStore

Forces the write caches to be flushed. DataStore implementations may optimize their writing by deferring the actual put / delete operations until this moment. See also the note on visibility.

getSchemaName

public String getSchemaName()

In Infinispan, Schemas are referred to as caches.

Returns:

Cache

newQuery

public Query<K,T> newQuery()

Description copied from interface: DataStore

Constructs and returns a new Query.

Returns:

a new Query.

put

public void put(K key,
                T obj)

Description copied from interface: DataStore

Inserts the persistent object with the given key. If an object with the same key already exists it will silently be replaced. See also the note on visibility.

schemaExists

public boolean schemaExists()

Description copied from interface: DataStore

Returns whether the schema that holds the data exists in the datastore.

Returns:

whether schema exists

getClient

public InfinispanClient<K,T> getClient()

getPrimaryFieldName

public String getPrimaryFieldName()

setPrimaryFieldName

public void setPrimaryFieldName(String name)

getPrimaryFieldPos

public int getPrimaryFieldPos()

setPrimaryFieldPos

public void setPrimaryFieldPos(int p)