Uses of Class
com.sptci.prevayler.PrevalentObject

Packages that use PrevalentObject

com.sptci.prevayler	Core classes for the database engine built around Prevayler.
com.sptci.prevayler.query	Queries defined for the prevalent system.
com.sptci.prevayler.transaction	Note: Users do not normally need to directly use these classes.

Uses of PrevalentObject in com.sptci.prevayler

Classes in com.sptci.prevayler with type parameters of type PrevalentObject

interface	AbstractDatabase<P extends PrevalentObject> A base interface that defines the public interface exposed by the database system.
interface	Database<P extends PrevalentObject> An interface that defines the transactional features exposed by the higher level database API.
class	PrevalentManager<P extends PrevalentObject> A facade around the prevalent system used to present a more natural programming interface than that provided by prevayler.

Fields in com.sptci.prevayler with type parameters of type PrevalentObject

private Map<Object,PrevalentObject>

PrimaryStorage.storage The map used as the primary storage container.

Methods in com.sptci.prevayler that return PrevalentObject

protected PrevalentObject	PrevalentSystem.add(PrevalentObject object, Date executionTime) Add a new prevalent object to the prevalent system.
protected PrevalentObject	ObjectGraphSystem.compose(PrevalentObject object) Create a clone of the specified prevalent object and reconstitute object references to other prevalent objects.
protected PrevalentObject	ObjectGraphSystem.decompose(PrevalentObject object, Date executionTime) Clone the specified object and decouple references to other prevalent object to make suitable for storage in the prevalent system.
PrevalentObject	PrevalentSystem.delete(PrevalentObject object, Date executionTime) Delete the specified prevalent object from the prevalent system.
PrevalentObject	DatabaseSystem.delete(PrevalentObject object, Date executionTime) Delete the specified prevalent object from the prevalent system.
PrevalentObject	PrevalentSystem.fetch(Class cls, Object oid) Fetch the prevalent object of the specified type with the specified object id from the prevalent system.
PrevalentObject	PrimaryStorage.get(Object oid) Return the prevalent object identified by its object id from the store.
PrevalentObject	PrevalentSystem.save(PrevalentObject object, Date executionTime) Save the specified prevalent object to the prevalent system.
PrevalentObject	DatabaseSystem.save(PrevalentObject object, Date executionTime) Save the specified prevalent object to the prevalent system.
protected PrevalentObject	PrevalentSystem.update(PrevalentObject object, Date executionTime) Update the specified prevalent object in the prevalent system.

Methods in com.sptci.prevayler that return types with arguments of type PrevalentObject

Collection<PrevalentObject>	PrevalentSystem.fetch(Class cls, long start, long end) Fetch the prevalent objects in the specified range of data.
Collection<PrevalentObject>	PrevalentSystem.fetch(Class cls, String field, Object object) Fetch the prevalent object(s) of the specified cls type which has the specified object as the value of the specified field.
Collection<PrevalentObject>	PrevalentSystem.fetchIntersection(Class cls, Map<String,?> parameters) Fetch the prevalent object(s) of the specified cls type which has the specified indexed field values.
Collection<PrevalentObject>	PrevalentSystem.fetchUnion(Class cls, Map<String,?> parameters) Fetch the prevalent object(s) of the specified cls type which has the specified indexed field values.
Collection<PrevalentObject>	PrimaryStorage.get(long start, long end) Fetch the prevalent objects in the specified range of data.
protected Collection<PrevalentObject>	StorageSystem.getTaskQueue() Return the task queue used when persisting objects by reachability.
protected Collection<PrevalentObject>	StorageSystem.TaskQueue.initialValue()
Collection<PrevalentObject>	PrevalentSystem.search(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, int count, org.apache.lucene.search.Sort sort) Execute the specified lucene query and return the collection of matching prevalent objects.

Methods in com.sptci.prevayler with parameters of type PrevalentObject

private void	IndexStorage.FieldStorage.add(Object index, PrevalentObject object) Add the specified index and corresponding prevalent object to the store.
void	PrimaryStorage.add(PrevalentObject object) Add the specified prevalent object to the primary storage.
protected PrevalentObject	PrevalentSystem.add(PrevalentObject object, Date executionTime) Add a new prevalent object to the prevalent system.
void	RelationStorage.add(PrevalentObject object, String field, ForeignKey.DeleteAction action) A a new relationship to the store for the specified prevalent object.
void	ReferenceStorage.add(PrevalentObject object, String name, Object oid) Add the specified reference information for the prevalent object to the store.
void	IndexStorage.add(String[] fields, Collection index, PrevalentObject object) Add a new index for the specified fields to the store.
void	IndexStorage.add(String field, Object index, PrevalentObject object) Add a new index for the specified field to the store.
private void	ConstraintSystem.addReference(PrevalentObject object, ForeignKey key, String name) Maintain the reference relationships between the specified prevalent object and any other prevalent object the object references.
private void	ConstraintSystem.cascadeDelete(String className, String field, PrevalentObject object, Date executionTime) Cascade delete all objects that hold a reference to the specified prevalent object.
protected void	IndexSystem.checkFields(PrevalentObject object) Check all the fields in the prevalent object for Index annotation and check for unique constraint violations.
protected void	ConstraintSystem.checkFields(PrevalentObject object) Over-ridden to check for ForeignKey annotation and check for unique constraint violations.
private void	ConstraintSystem.checkForeignKey(ForeignKey key, PrevalentObject object) Check the ForeignKey annotation and check for unique constraint violations.
private void	ConstraintSystem.checkForeignKeys(PrevalentObject object) Check the ForeignKeys annotation for the prevalent class and perform actions as necessary.
private void	IndexSystem.checkIndex(Index index, PrevalentObject object) Check the index specified at the class level on the prevalent object.
private void	IndexSystem.checkIndices(PrevalentObject object) Check the Indices annotations on the specified prevalent object and check unique constraints.
private void	ConstraintSystem.checkNull(PrevalentObject object) Check the NotNull annotation on the prevalent object and its fields and throw exceptions if necessary.
private void	ConstraintSystem.checkNull(String member, PrevalentObject object) Check the value of the member identified by the name specified in the prevalent object for null value.
private void	ConstraintSystem.checkNullFields(PrevalentObject object) Check all the fields in the prevalent object to see if they have been annotated with the NotNull annotation.
protected void	ConstraintSystem.checkUnique(Field field, PrevalentObject parent, PrevalentObject child) Check the specified child prevalent object to see if a unique constraint is defined on the parent object.
protected void	ConstraintSystem.checkUnique(Field field, PrevalentObject parent, PrevalentObject child) Check the specified child prevalent object to see if a unique constraint is defined on the parent object.
protected void	IndexSystem.checkUnique(PrevalentObject object) Check all unique constraints (including object id) for the specified prevalent object.
protected void	ConstraintSystem.checkUnique(PrevalentObject object) Over-ridden to process any ForeignKeys and ForeignKey annotations.
int	PrevalentObject.compareTo(PrevalentObject prevalentObject) Compare the specified prevalent object with this instance for ordering.
protected PrevalentObject	ObjectGraphSystem.compose(PrevalentObject object) Create a clone of the specified prevalent object and reconstitute object references to other prevalent objects.
private org.apache.lucene.document.Document	SearchSystem.createDocument(PrevalentObject object) Create a document to store the full-text indices for the specified object.
protected PrevalentObject	ObjectGraphSystem.decompose(PrevalentObject object, Date executionTime) Clone the specified object and decouple references to other prevalent object to make suitable for storage in the prevalent system.
private void	ObjectGraphSystem.decomposeCollection(PrevalentObject object, Field field, Date executionTime) Decompose a collection or references to other prevalent objects in the prevalent object being managed.
private void	ObjectGraphSystem.decomposeObject(PrevalentObject object, Field field, Date executionTime) Decompose a direct reference represented by the specified field in the prevalent object.
PrevalentObject	PrevalentSystem.delete(PrevalentObject object, Date executionTime) Delete the specified prevalent object from the prevalent system.
PrevalentObject	DatabaseSystem.delete(PrevalentObject object, Date executionTime) Delete the specified prevalent object from the prevalent system.
protected Object	StorageSystem.generateOid(PrevalentObject object) Generate the oid to assign to the specified prevalent object.
private String	SearchSystem.getDocumentId(PrevalentObject object) Return the unique document id for the index document representing the specified prevalent object.
Collection<String>	ReferenceStorage.getFields(PrevalentObject object) Return a collection of field names that represent the references to other prevalent objects in the store for the specified prevalent object.
Object	ReferenceStorage.getValue(PrevalentObject object, String name) Return the value associated with the specified prevalent object and reference field name.
private boolean	SearchSystem.hasIndices(PrevalentObject object) Determine whether the prevalent object has any full-text search indices specified.
protected void	SearchSystem.index(PrevalentObject object) Over-ridden to process search annotations for the object.
protected void	IndexSystem.index(PrevalentObject object) Manage additional maps required to support qeries on the prevalent object.
protected void	IndexSystem.indexClass(PrevalentObject object) Process the index annotations on the prevalent object and manage the StorageSystem.indexMap as appropriate.
protected void	ConstraintSystem.indexClass(PrevalentObject object) Over-ridden to process the foreign key annotations on the prevalent object and manage the @link StorageSystsem#indexMap} as appropriate.
private void	SearchSystem.indexClass(PrevalentObject object, org.apache.lucene.document.Document doc) Add full-text search indices for composite indices defined at the class level.
protected void	IndexSystem.indexFields(PrevalentObject object) Process Index annotations on the fields of the specified prevalent object and manage the StorageSystem.indexMap as appropriate.
protected void	ConstraintSystem.indexFields(PrevalentObject object) Over-ridden to process ForeignKey annotations on the fields of the specified prevalent object and manage the StorageSystem.indexMap as appropriate.
private void	SearchSystem.indexFields(PrevalentObject object, org.apache.lucene.document.Document doc) Add full=text search indices for any fields annotated as searchable in the prevalent object.
private void	SearchSystem.indexSearchable(PrevalentObject object, org.apache.lucene.document.Document doc, Searchable index) Process the Searchable annotation for the specified prevalent object class.
private void	SearchSystem.indexSearchables(PrevalentObject object, org.apache.lucene.document.Document doc) Process the Searchables annotation for the specified prevalent object class.
boolean	PrimaryStorage.isStored(PrevalentObject object) Check to see if the specified object exists in storage.
private void	ConstraintSystem.nullReference(String className, String field, PrevalentObject object) Set the field in className that refers to object to null.
private void	ObjectGraphSystem.populateReference(PrevalentObject object) Populate the references to other prevalent objects in the specified prevalent object.
protected void	ConstraintSystem.preAdd(PrevalentObject object) Check the prevalent object specified to ensure that it may be safely added to the prevalent system.
protected void	ConstraintSystem.preDelete(PrevalentObject object, Date executionTime) Process any delete constraints configured for the specified prevalent object.
protected void	ConstraintSystem.preDelete(String className, PrevalentObject object, Date executionTime) Check the foreign key relationship from instances of the specified class to the prevalent object specified and process as necessary.
private void	ConstraintSystem.processForeignKey(ForeignKey key, PrevalentObject object) Process the foreign key annotation for a field declared at the prevalent class level and manage the StorageSystem.indexMap as appropriate.
private void	ConstraintSystem.processForeignKeys(PrevalentObject object) Process the foreign keys annotation for the prevalent class.
private void	IndexSystem.processIndex(Index index, PrevalentObject object) Process the Index annotation at the class level of the specified prevalent object.
private void	IndexSystem.processIndices(PrevalentObject object) Process the Indices annotation and manage the StorageSystem.indexMap as appropriate.
private void	IndexStorage.FieldStorage.remove(Object key, PrevalentObject object)
protected void	SearchSystem.remove(PrevalentObject object) Over-ridden to remove the search index for the specified prevalent object.
void	ReferenceStorage.remove(PrevalentObject object) Remove the specified prevalent object from the store.
void	PrimaryStorage.remove(PrevalentObject object) Remove the specified prevalent object from the primary storage.
protected void	IndexSystem.remove(PrevalentObject object) Remove the index for the specified prevalent object.
void	IndexStorage.remove(PrevalentObject object) Remove the indices for the specified prevalent object from the store.
private void	IndexStorage.FieldStorage.remove(PrevalentObject object) Remove the specified prevalent object from the store.
protected void	ConstraintSystem.remove(PrevalentObject object) Over-ridden to remove the references to the prevalent object being removed from the system from the reference storage container.
void	ReferenceStorage.remove(PrevalentObject object, String field) Remove the reference(s) for the specified field in the specified prevalent object.
void	ReferenceStorage.remove(PrevalentObject object, String field, Object objectId) Remove the reference for the specified prevalent object from the specified field.
void	IndexStorage.remove(String field, Object key, PrevalentObject value) Remove the index entry for the specified reference object that is refernced by the specified parent prevalent object.
PrevalentObject	PrevalentSystem.save(PrevalentObject object, Date executionTime) Save the specified prevalent object to the prevalent system.
PrevalentObject	DatabaseSystem.save(PrevalentObject object, Date executionTime) Save the specified prevalent object to the prevalent system.
private void	SearchSystem.save(PrevalentObject object, org.apache.lucene.document.Document document) Save the specified document to the index writer.
protected void	PrevalentSystem.setOid(PrevalentObject object) Set the objectId field to a new value if not already set.
protected void	ObjectGraphSystem.update(Field field, PrevalentObject object, Date executionTime) Replace the prevalent object in the field specified from the specified object prevalent object to the po object that exists in the system.
protected PrevalentObject	PrevalentSystem.update(PrevalentObject object, Date executionTime) Update the specified prevalent object in the prevalent system.
protected void	PrevalentSystem.updateOrdinaryField(PrevalentObject prevalentObject, Field field, Object source, Object destination) Update an ordinary field (non prevalent object or collection).

Method parameters in com.sptci.prevayler with type arguments of type PrevalentObject

protected void

SearchSystem.search(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, int count, org.apache.lucene.search.Sort sort, Collection<PrevalentObject> collection) Search the search indices and retrieve all the objects (regardless of type) that match the specified query and return up to the specified number of results.

Constructors in com.sptci.prevayler with parameters of type PrevalentObject

ConstraintException(PrevalentObject object)
Create a new instance of the exception using ConstraintException.OID_PATTERN to display the message for the unique object id constraint being violated.

ConstraintException(PrevalentObject object, String fields)
Create a new instance of the exception using ConstraintException.FIELD_PATTERN to display the message for unique constraint on specified fields being violated.

DeleteException(PrevalentObject object)
Create a new instance of the exception for attempting to delete the specified prevalent object.

NullException(PrevalentObject object, String field)
Create a new instance of the exception using NullException.FIELD_PATTERN to display the message for unique constraint on specified fields being violated.

Uses of PrevalentObject in com.sptci.prevayler.query

Classes in com.sptci.prevayler.query with type parameters of type PrevalentObject

class	Fetch<P extends PrevalentObject,S extends PrevalentSystem> The query for retrieving a prevalent object from the system identified by its objectId field.
class	FetchByIndex<P extends Collection<PrevalentObject>,S extends PrevalentSystem> A query used to fetch prevalent objects that are indexed by the specified field.
class	FetchByIndices<P extends Collection<PrevalentObject>,S extends PrevalentSystem> A query used to fetch prevalent instances by the specified indexed fields.
class	FetchRange<P extends PrevalentObject,S extends PrevalentSystem> The query used to retrieve prevalent objects of the specified type in the range specified.
class	Search<P extends Collection<PrevalentObject>,S extends PrevalentSystem> The query for retrieving a collection of prevalent objects that match the specified query and optional filter.

Uses of PrevalentObject in com.sptci.prevayler.transaction

Classes in com.sptci.prevayler.transaction with type parameters of type PrevalentObject

class	Delete<P extends PrevalentObject> The transaction object for deleting a prevalent object from the prevalent system.
class	Save<P extends PrevalentObject> A transaction for adding a new prevalent object instance to the prevalent system.