org.apache.gora.persistency.impl

Class PersistentBase

java.lang.Object

org.apache.avro.specific.SpecificRecordBase

org.apache.gora.persistency.impl.PersistentBase

All Implemented Interfaces:

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

Direct Known Subclasses:

MetricDatum, Pageview

public abstract class PersistentBase
extends org.apache.avro.specific.SpecificRecordBase
implements Persistent

Base classs implementing common functionality for Persistent classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistentBase.PersistentData

Field Summary

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

DIRTY_BYTES_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
PersistentBase()

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() Clears the dirty state.
void	clearDirty(int fieldIndex) Clears the field as dirty.
void	clearDirty(String field) Clears the field as dirty.
boolean	equals(Object that)
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() 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 fieldName) Returns whether the field has been modified.
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 class org.apache.avro.specific.SpecificRecordBase

compareTo, get, getSchema, hashCode, put, toString

Methods inherited from class java.lang.Object

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

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

getTombstone, newInstance

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

get, put

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

getSchema

Constructor Detail

PersistentBase

public PersistentBase()

Method Detail

clearDirty

public void clearDirty()

Description copied from interface: Dirtyable

Clears the dirty state.

Specified by:

clearDirty in interface Dirtyable

clearDirty

public void clearDirty(int fieldIndex)

Description copied from interface: Persistent

Clears the field as dirty.

Specified by:

clearDirty in interface Persistent

Parameters:

fieldIndex - the offset of the field in the object

clearDirty

public void clearDirty(String field)

Description copied from interface: Persistent

Clears the field as dirty.

Specified by:

clearDirty in interface Persistent

Parameters:

field - the name of the field

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 fieldName)

Description copied from interface: Persistent

Returns whether the field has been modified.

Specified by:

isDirty in interface Persistent

Parameters:

fieldName - the name of the field

Returns:

whether the field has been modified.

setDirty

public void setDirty()

Description copied from interface: Persistent

Sets all the fields of the object as dirty.

Specified by:

setDirty in interface Persistent

setDirty

public void setDirty(int fieldIndex)

Description copied from interface: Persistent

Sets the field as dirty.

Specified by:

setDirty in interface Persistent

Parameters:

fieldIndex - the offset of the field in the object

setDirty

public void setDirty(String field)

Description copied from interface: Persistent

Sets the field as dirty.

Specified by:

setDirty in interface Persistent

Parameters:

field - the name of the field

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

equals

public boolean equals(Object that)

Overrides:

equals in class org.apache.avro.specific.SpecificRecordBase

getUnmanagedFields

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

Description copied from interface: Persistent

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

Specified by:

getUnmanagedFields in interface Persistent

Returns:

the unmanaged fields