org.apache.gora.persistency

Interface Persistent

All Superinterfaces:

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

All Known Implementing Classes:

MetricDatum, MetricDatum.Tombstone, Pageview, Pageview.Tombstone, PersistentBase, PersistentWSBase

public interface Persistent
extends org.apache.avro.specific.SpecificRecord, Dirtyable

Objects that are persisted by Gora implements this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRTY_BYTES_FIELD_NAME

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.
void	clearDirty(int fieldIndex) Clears the field as dirty.
void	clearDirty(String field) Clears the field as dirty.
Tombstone	getTombstone() Get an object which can be used to mark this field as deleted (rather than state unknown, which is indicated by null).
List<org.apache.avro.Schema.Field>	getUnmanagedFields() Get a list of fields from this persistent object's schema that are not managed by Gora.
boolean	isDirty(int fieldIndex) Returns whether the field has been modified.
boolean	isDirty(String field) Returns whether the field has been modified.
Persistent	newInstance() Constructs a new instance of the object by using appropriate builder.
void	setDirty() Sets all the fields of the object as dirty.
void	setDirty(int fieldIndex) Sets the field as dirty.
void	setDirty(String field) Sets the field as dirty.

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, isDirty

Field Detail

DIRTY_BYTES_FIELD_NAME

static final String DIRTY_BYTES_FIELD_NAME

See Also:

Constant Field Values

Method Detail

clear

void clear()

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.

isDirty

boolean isDirty(int fieldIndex)

Returns whether the field has been modified.

Parameters:

fieldIndex - the offset of the field in the object

Returns:

whether the field has been modified.

isDirty

boolean isDirty(String field)

Returns whether the field has been modified.

Parameters:

field - the name of the field

Returns:

whether the field has been modified.

setDirty

void setDirty()

Sets all the fields of the object as dirty.

setDirty

void setDirty(int fieldIndex)

Sets the field as dirty.

Parameters:

fieldIndex - the offset of the field in the object

setDirty

void setDirty(String field)

Sets the field as dirty.

Parameters:

field - the name of the field

clearDirty

void clearDirty(int fieldIndex)

Clears the field as dirty.

Parameters:

fieldIndex - the offset of the field in the object

clearDirty

void clearDirty(String field)

Clears the field as dirty.

Parameters:

field - the name of the field

getTombstone

Tombstone getTombstone()

Get an object which can be used to mark this field as deleted (rather than state unknown, which is indicated by null).

Returns:

a tombstone.

getUnmanagedFields

List<org.apache.avro.Schema.Field> getUnmanagedFields()

Get a list of fields from this persistent object's schema that are not managed by Gora.

Returns:

the unmanaged fields

newInstance

Persistent newInstance()

Constructs a new instance of the object by using appropriate builder. This method is intended to be used by Gora framework.

Returns:

a new instance of the object