org.apache.gora.persistency.ws.impl

Class PersistentWSBase

java.lang.Object

org.apache.gora.persistency.ws.impl.PersistentWSBase

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord, Dirtyable, Persistent

public abstract class PersistentWSBase
extends Object
implements Persistent

Base classs implementing common functionality for Web services backed persistent classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<Class<?>,Map<String,Integer>>	FIELD_MAP Maps keys to their own classes
protected static Map<Class<?>,String[]>	FIELDS Maps fields to their own classes

Fields inherited from interface org.apache.gora.persistency.Persistent

DIRTY_BYTES_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
PersistentWSBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears the inner state of the object without any modification to the actual data on the data store.
Persistent	clone()
boolean	equals(Object o)
String	getField(int index) Gets a specific field from the fields map
int	getFieldIndex(String field) Gets a field index based on the field name
String[]	getFields() Gets fields using a specific class
int	hashCode()
boolean	isDirty() Returns whether any of the fields of the object has been modified after construction or loading.
boolean	isDirty(int fieldIndex) Returns whether the field has been modified.
boolean	isDirty(String field) Returns whether the field has been modified.
protected boolean	isFieldEqual(int index, Object value) Checks if a field is equal between two objects
protected static void	registerFields(Class<?> clazz, String... fields) Subclasses should call this function for all the persistable fields in the class to register them.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.gora.persistency.Persistent

clearDirty, clearDirty, getTombstone, getUnmanagedFields, newInstance, setDirty, setDirty, setDirty

Methods inherited from interface org.apache.avro.generic.IndexedRecord

get, put

Methods inherited from interface org.apache.avro.generic.GenericContainer

getSchema

Methods inherited from interface org.apache.gora.persistency.Dirtyable

clearDirty

Field Detail

FIELD_MAP

protected static Map<Class<?>,Map<String,Integer>> FIELD_MAP

Maps keys to their own classes

FIELDS

protected static Map<Class<?>,String[]> FIELDS

Maps fields to their own classes

Constructor Detail

PersistentWSBase

public PersistentWSBase()

Method Detail

registerFields

protected static void registerFields(Class<?> clazz,
                  String... fields)

Subclasses should call this function for all the persistable fields in the class to register them.

Parameters:

clazz - the Persistent class

fields - the name of the fields of the class

getFields

public String[] getFields()

Gets fields using a specific class

getField

public String getField(int index)

Gets a specific field from the fields map

getFieldIndex

public int getFieldIndex(String field)

Gets a field index based on the field name

clear

public void clear()

Description copied from interface: Persistent

Clears the inner state of the object without any modification to the actual data on the data store. This method should be called before re-using the object to hold the data for another result.

Specified by:

clear in interface Persistent

isDirty

public boolean isDirty()

Description copied from interface: Dirtyable

Returns whether any of the fields of the object has been modified after construction or loading.

Specified by:

isDirty in interface Dirtyable

Returns:

whether any of the fields of the object has changed

isDirty

public boolean isDirty(int fieldIndex)

Description copied from interface: Persistent

Returns whether the field has been modified.

Specified by:

isDirty in interface Persistent

Parameters:

fieldIndex - the offset of the field in the object

Returns:

whether the field has been modified.

isDirty

public boolean isDirty(String field)

Description copied from interface: Persistent

Returns whether the field has been modified.

Specified by:

isDirty in interface Persistent

Parameters:

field - the name of the field

Returns:

whether the field has been modified.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Persistent clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

isFieldEqual

protected boolean isFieldEqual(int index,
                   Object value)

Checks if a field is equal between two objects

Parameters:

index -

value -

Returns: