org.apache.gora.store.ws.impl

Class WSBackedDataStoreBase<K,T extends Persistent>

java.lang.Object

org.apache.gora.store.ws.impl.WSDataStoreBase<K,T>

org.apache.gora.store.ws.impl.WSBackedDataStoreBase<K,T>

All Implemented Interfaces:

DataStore<K,T>, WebServiceBackedDataStore<K,T>

public abstract class WSBackedDataStoreBase<K,T extends Persistent>
extends WSDataStoreBase<K,T>
implements WebServiceBackedDataStore<K,T>

Base implementations for WebServiceBackedDataStore methods.

Field Summary

Fields inherited from class org.apache.gora.store.ws.impl.WSDataStoreBase

authentication, keyClass, persistentClass, properties

Constructor Summary

Constructors

Constructor and Description
WSBackedDataStoreBase()

Method Summary

Methods

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.
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) Executes the given query and returns the results.
protected abstract Result<K,T>	executeQuery(Query<K,T> query) Executes a normal Query reading the whole data.
void	flush() Forces the write caches to be flushed.
void	initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties) Initializes this DataStore.
void	readFields(Object in) Reads fields from an object
boolean	schemaExists() Returns whether the schema that holds the data exists in the datastore.
void	write(Object out) Writes an object

Methods inherited from class org.apache.gora.store.ws.impl.WSDataStoreBase

equals, getConf, getKeyClass, getPersistentClass, getSchemaName, getWSProvider, setConf, setKeyClass, setPersistentClass, setWsProvider, truncateSchema

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.gora.store.WebServiceBackedDataStore

getProvider, setProvider

Methods inherited from interface org.apache.gora.store.DataStore

delete, deleteByQuery, get, get, getBeanFactory, getKeyClass, getPartitions, getPersistentClass, getSchemaName, newKey, newPersistent, newQuery, put, setBeanFactory, setKeyClass, setPersistentClass, truncateSchema

Constructor Detail

WSBackedDataStoreBase

public WSBackedDataStoreBase()

Method Detail

initialize

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

Description copied from interface: DataStore

Initializes this DataStore.

Specified by:

initialize in interface DataStore<K,T extends Persistent>

Overrides:

initialize in class WSDataStoreBase<K,T extends Persistent>

Parameters:

keyClass - the class of the keys

persistentClass - the class of the persistent objects

properties - extra metadata

execute

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

Description copied from interface: DataStore

Executes the given query and returns the results.

Specified by:

execute in interface DataStore<K,T extends Persistent>

Parameters:

query - the query to execute.

Returns:

the results as a Result object.

executeQuery

protected abstract Result<K,T> executeQuery(Query<K,T> query)
                                                        throws IOException

Executes a normal Query reading the whole data. #execute() calls this function for non-PartitionQuery's.

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.

Specified by:

flush in interface DataStore<K,T extends Persistent>

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.

Specified by:

createSchema in interface DataStore<K,T extends Persistent>

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.

Specified by:

deleteSchema in interface DataStore<K,T extends Persistent>

schemaExists

public boolean schemaExists()

Description copied from interface: DataStore

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

Specified by:

schemaExists in interface DataStore<K,T extends Persistent>

Returns:

whether schema exists

write

public void write(Object out)
           throws Exception

Description copied from class: WSDataStoreBase

Writes an object

Overrides:

write in class WSDataStoreBase<K,T extends Persistent>

Throws:

Exception

readFields

public void readFields(Object in)
                throws Exception

Description copied from class: WSDataStoreBase

Reads fields from an object

Overrides:

readFields in class WSDataStoreBase<K,T extends Persistent>

Throws:

Exception

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.

Specified by:

close in interface DataStore<K,T extends Persistent>