PersistentBase (Apache Gora 0.2 API)

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.gora.persistency.impl
Class PersistentBase

java.lang.Object
  org.apache.gora.persistency.impl.PersistentBase

All Implemented Interfaces:: Cloneable, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord, Persistent

Direct Known Subclasses:: Employee, Metadata, MetricDatum, Pageview, TokenDatum, WebPage

public abstract class PersistentBase
extends Object
implements Persistent
extends Object
implements Persistent

Base classs implementing common functionality for Persistent classes.

Field Summary

protected static PersistentDatumReader<Persistent> datumReader


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


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


Constructor Summary

protected PersistentBase()


protected PersistentBase(StateManager stateManager)


Method Summary

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.

void clearNew()
          Clears the new state

void clearReadable()
          Clears the readable state.

void clearReadable(int fieldIndex)
          Clears the field as readable.

void clearReadable(String field)
          Sets the field as readable.

Persistent clone()


boolean equals(Object o)


String getField(int index)
          Returns the field name with the given index

int getFieldIndex(String field)
          Returns the index of the field with the given name

String[] getFields()
          Returns sorted field names of the object

StateManager getStateManager()
          Returns the StateManager which manages the persistent state of the object.

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)


boolean isNew()
          Returns whether the object is newly constructed.

boolean isReadable(int fieldIndex)
          Returns whether the field has been loaded from the datastore.

boolean isReadable(String field)
          Returns whether the field has been loaded from the datastore.

protected static void registerFields(Class<?> clazz, String... fields)
          Subclasses should call this function for all the persistable fields in the class to register them.

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.

void setNew()
          Sets the state of the object as new for persistency

void setReadable(int fieldIndex)
          Sets the field as readable.

void setReadable(String field)
          Sets the field as readable.

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

newInstance

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

get, put

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

getSchema

Field Summary
`protected static PersistentDatumReader<Persistent>`	`datumReader`
`protected static Map<Class<?>,Map<String,Integer>>`	`FIELD_MAP`
`protected static Map<Class<?>,String[]>`	`FIELDS`

Constructor Summary
`protected`	`PersistentBase()`
`protected`	`PersistentBase(StateManager stateManager)`

Method Summary
`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.
`void`	`clearNew()` Clears the new state
`void`	`clearReadable()` Clears the readable state.
`void`	`clearReadable(int fieldIndex)` Clears the field as readable.
`void`	`clearReadable(String field)` Sets the field as readable.
`Persistent`	`clone()`
`boolean`	`equals(Object o)`
`String`	`getField(int index)` Returns the field name with the given index
`int`	`getFieldIndex(String field)` Returns the index of the field with the given name
`String[]`	`getFields()` Returns sorted field names of the object
`StateManager`	`getStateManager()` Returns the StateManager which manages the persistent state of the object.
`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)`
`boolean`	`isNew()` Returns whether the object is newly constructed.
`boolean`	`isReadable(int fieldIndex)` Returns whether the field has been loaded from the datastore.
`boolean`	`isReadable(String field)` Returns whether the field has been loaded from the datastore.
`protected static void`	`registerFields(Class<?> clazz, String... fields)` Subclasses should call this function for all the persistable fields in the class to register them.
`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.
`void`	`setNew()` Sets the state of the object as new for persistency
`void`	`setReadable(int fieldIndex)` Sets the field as readable.
`void`	`setReadable(String field)` Sets the field as readable.
`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
`newInstance`

Methods inherited from interface org.apache.avro.generic.IndexedRecord
`get, put`

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

Field Detail

FIELD_MAP

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

FIELDS

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

datumReader

protected static final PersistentDatumReader<Persistent> datumReader

Constructor Detail

PersistentBase

protected PersistentBase()

PersistentBase

protected PersistentBase(StateManager stateManager)

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