org.apache.gora.store.ws.impl

Class WSDataStoreBase<K,T extends Persistent>

java.lang.Object

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

All Implemented Interfaces:

DataStore<K,T>

Direct Known Subclasses:

WSBackedDataStoreBase

public abstract class WSDataStoreBase<K,T extends Persistent>
extends Object
implements DataStore<K,T>

A Base class for persistent objectsDataStores.

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	authentication The authentication object to be used for our provider
protected Class<K>	keyClass Class of the key to be used
protected Class<T>	persistentClass Class of the persistent object
protected Properties	properties Properties object

Constructor Summary

Constructors

Constructor and Description
WSDataStoreBase() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	getConf() Gets the configuration (authentication) object
Class<K>	getKeyClass() Returns the class of the keys
Class<T>	getPersistentClass() Returns the class of the persistent objects
protected String	getSchemaName(String mappingSchemaName, Class<?> persistentClass) Returns the name of the schema to use for the persistent class.
String	getWSProvider() Get the service provider name.
void	initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties) Initializes this DataStore.
void	readFields(Object obj) Reads fields from an object
void	setConf(Object auth) Sets the configuration (authentication) object
void	setKeyClass(Class<K> keyClass) Sets the class of the keys
void	setPersistentClass(Class<T> persistentClass) Sets the class of the persistent objects
void	setWsProvider(String wsProvider) Sets web service provider name
void	truncateSchema() Deletes all the data associated with the schema, but keeps the schema (table or similar) intact.
void	write(Object obj) Writes an object

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.DataStore

close, createSchema, delete, deleteByQuery, deleteSchema, execute, flush, get, get, getBeanFactory, getPartitions, getSchemaName, newKey, newPersistent, newQuery, put, schemaExists, setBeanFactory

Field Detail

keyClass

protected Class<K> keyClass

Class of the key to be used

persistentClass

protected Class<T extends Persistent> persistentClass

Class of the persistent object

authentication

protected Object authentication

The authentication object to be used for our provider

properties

protected Properties properties

Properties object

Constructor Detail

WSDataStoreBase

public WSDataStoreBase()

Default constructor

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>

Parameters:

keyClass - the class of the keys

persistentClass - the class of the persistent objects

properties - extra metadata

setPersistentClass

public void setPersistentClass(Class<T> persistentClass)

Description copied from interface: DataStore

Sets the class of the persistent objects

Specified by:

setPersistentClass in interface DataStore<K,T extends Persistent>

Parameters:

persistentClass - class of persistent objects

getPersistentClass

public Class<T> getPersistentClass()

Description copied from interface: DataStore

Returns the class of the persistent objects

Specified by:

getPersistentClass in interface DataStore<K,T extends Persistent>

Returns:

class of the persistent objects

getKeyClass

public Class<K> getKeyClass()

Description copied from interface: DataStore

Returns the class of the keys

Specified by:

getKeyClass in interface DataStore<K,T extends Persistent>

Returns:

class of the keys

setKeyClass

public void setKeyClass(Class<K> keyClass)

Description copied from interface: DataStore

Sets the class of the keys

Specified by:

setKeyClass in interface DataStore<K,T extends Persistent>

Parameters:

keyClass - the class of keys

getConf

public Object getConf()

Gets the configuration (authentication) object

Returns:

Object containing the authentication values

setConf

public void setConf(Object auth)

Sets the configuration (authentication) object

readFields

public void readFields(Object obj)
                throws Exception

Reads fields from an object

Parameters:

obj - Object to read from.

Throws:

Exception

write

public void write(Object obj)
           throws Exception

Writes an object

Parameters:

obj - Object to write.

Throws:

Exception

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

truncateSchema

public void truncateSchema()

Description copied from interface: DataStore

Deletes all the data associated with the schema, but keeps the schema (table or similar) intact.

Specified by:

truncateSchema in interface DataStore<K,T extends Persistent>

getSchemaName

protected String getSchemaName(String mappingSchemaName,
                   Class<?> persistentClass)

Returns the name of the schema to use for the persistent class. First the schema name in the defined properties is returned. If null then the provided mappingSchemaName is returned. If this is null too, the class name, without the package, of the persistent class is returned.

Parameters:

mappingSchemaName - the name of the schema as read from the mapping file

persistentClass - persistent class

getWSProvider

public String getWSProvider()

Get the service provider name.

Returns:

the service provider name.

setWsProvider

public void setWsProvider(String wsProvider)

Sets web service provider name

Parameters:

wsProvider - Name to set the service provider to.