org.compass.core
Interface CompassOperations

All Known Subinterfaces:

CompassSession, InternalCompassSession

All Known Implementing Classes:

CompassTemplate, DefaultCompassSession

public interface CompassOperations

A interface describing all the available operations allowed by compass.

Author:

kimchy

Method Summary

void	create(Object obj) Creates a NEW object in Compass.
void	create(String alias, Object obj) Creates a NEW object in Compass that shares mapping alais with multiple objects.
void	delete(Class clazz, Object... ids) Deletes an object from Compass that match the mapping specified for the defined class based on its ids.
void	delete(Class clazz, Object obj) Deletes an object from Compass that match the mapping specified for the defined class.
void	delete(CompassQuery query) Deletes all entries in the index that match the given query.
void	delete(Object obj) Deletes an object from Compass.
void	delete(Resource resource) Deletes a resource with the specified alias.
void	delete(String alias, Object... ids) Deletes an object from Compass with multiple alias's based on its ids.
void	delete(String alias, Object obj) Deletes an object from Compass with multiple alias's.
void	evict(Object obj) Evicts the given object from the first level cache (transaction scoped cache).
void	evict(Resource resource) Evicts the given resource from the first level cache (transaction scoped cache).
void	evict(String alias, Object id) Evicts the given object from the first level cache (transaction scoped cache).
void	evictAll() Evicts all the objects and the resources from the first level cache.
CompassHits	find(String query) Finds a list of objects that match the specified query.
<T> T	get(Class<T> clazz, Object... ids) Returns an object that match the mapping specified for the defined class, and matches the specified ids.
<T> T	get(Class<T> clazz, Object id) Returns an object that match the mapping specified for the defined class, and matches the specified id.
Object	get(String alias, Object... ids) Returns an object that match the mapping specified for the defined alias, and matches the specified ids.
Object	get(String alias, Object id) Returns an object that match the mapping specified for the defined alias, and matches the specified id.
Resource	getResource(Class clazz, Object... ids) Returns a Resource that match the mapping specified for the defined class type, and specified ids.
Resource	getResource(Class clazz, Object id) Returns a Resource that match the mapping specified for the defined class type, and specified id.
Resource	getResource(String alias, Object... ids) Returns a Resource that match the mapping specified for the defined alias (possibley different object types), and matches the specified ids.
Resource	getResource(String alias, Object id) Returns a Resource that match the mapping specified for the defined alias (possibley different object types), and matches the specified id.
<T> T	load(Class<T> clazz, Object... ids) Loads and returns an object that match the mapping specified for the defined class, and matches the specified ids.
<T> T	load(Class<T> clazz, Object id) Loads and returns an object that match the mapping specified for the defined class, and matches the specified id.
Object	load(String alias, Object... ids) Loads and returns an object that match the mapping specified for the defined class, and matches the specified ids.
Object	load(String alias, Object id) Loads and returns an object that match the mapping specified for the defined class, and matches the specified id.
Resource	loadResource(Class clazz, Object... ids) Loads and returns a Resource that match the mapping specified for the defined class, and matches the specified ids.
Resource	loadResource(Class clazz, Object id) Loads and returns a Resource that match the mapping specified for the defined class, and matches the specified id.
Resource	loadResource(String alias, Object... ids) Loads and returns a Resource that match the mapping specified for the defined alias, and matches the specified ids.
Resource	loadResource(String alias, Object id) Loads and returns a Resource that match the mapping specified for the defined alias, and matches the specified id.
void	save(Object obj) Saves an object in Compass.
void	save(String alias, Object obj) Saves an object in Compass that shares mapping alais with multiple objects.

Method Detail

delete

void delete(Resource resource)
            throws CompassException

Deletes a resource with the specified alias. Note that the resource must have the defined ids in the mapping files set and an alias set.

Parameters:

resource - The resource to be deleted.

Throws:

CompassException

getResource

Resource getResource(Class clazz,
                     Object id)
                     throws CompassException

Returns a Resource that match the mapping specified for the defined class type, and specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Returns null if the object is not found.

Parameters:

clazz - The class that represents the required mapping

id - The id that identifies the resource

Returns:

The resource, returns null if not found

Throws:

CompassException

getResource

Resource getResource(Class clazz,
                     Object... ids)
                     throws CompassException

Returns a Resource that match the mapping specified for the defined class type, and specified ids.

Parameters:

clazz - The class that represents the required mapping

ids - The ids that identifies the resource

Returns:

The resource, returns null if not found

Throws:

CompassException

getResource

Resource getResource(String alias,
                     Object id)
                     throws CompassException

Returns a Resource that match the mapping specified for the defined alias (possibley different object types), and matches the specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Returns null if the object is not found.

Parameters:

alias - The alias that represents the required mapping

id - The id that identifies the resource

Returns:

The resource

Throws:

CompassException

getResource

Resource getResource(String alias,
                     Object... ids)
                     throws CompassException

Returns a Resource that match the mapping specified for the defined alias (possibley different object types), and matches the specified ids. Returns null if the object is not found.

Parameters:

alias - The alias that represents the required mapping

ids - The ids that identifies the resource

Returns:

The resource

Throws:

CompassException

loadResource

Resource loadResource(Class clazz,
                      Object id)
                      throws CompassException

Loads and returns a Resource that match the mapping specified for the defined class, and matches the specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Throws an exception if the resource is not found.

Parameters:

clazz - The class that represents the required mapping

id - The id that identifies the resource

Returns:

The resource

Throws:

CompassException

loadResource

Resource loadResource(Class clazz,
                      Object... ids)
                      throws CompassException

Loads and returns a Resource that match the mapping specified for the defined class, and matches the specified ids. Throws an exception if the resource is not found.

Parameters:

clazz - The class that represents the required mapping

ids - The ids that identifies the resource

Returns:

The resource

Throws:

CompassException

loadResource

Resource loadResource(String alias,
                      Object id)
                      throws CompassException

Loads and returns a Resource that match the mapping specified for the defined alias, and matches the specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Throws an exception if the resource is not found.

Parameters:

alias - The alias that represents the required mapping

id - The id that identifies the resource

Returns:

The resource

Throws:

CompassException

loadResource

Resource loadResource(String alias,
                      Object... ids)
                      throws CompassException

Loads and returns a Resource that match the mapping specified for the defined alias, and matches the specified ids. Throws an exception if the resource is not found.

Parameters:

alias - The alias that represents the required mapping

ids - The ids that identifies the resource

Returns:

The resource

Throws:

CompassException

delete

void delete(Object obj)
            throws CompassException

Deletes an object from Compass. The object must have been either loaded by Compass or it's ids must be set if already known.

Parameters:

obj - The object to delete

Throws:

CompassException

delete

void delete(String alias,
            Object obj)
            throws CompassException

Deletes an object from Compass with multiple alias's. The object can either be the id (or an array of ids), or the actual data object with it's property ids set.

Parameters:

alias - The alias that the objects maps under

obj - The object to delete

Throws:

CompassException

delete

void delete(String alias,
            Object... ids)
            throws CompassException

Deletes an object from Compass with multiple alias's based on its ids.

Parameters:

alias - The alias that the objects maps under

ids - The ids of the object to delete

Throws:

CompassException

delete

void delete(Class clazz,
            Object obj)
            throws CompassException

Deletes an object from Compass that match the mapping specified for the defined class. The object can either be the id (or an array of ids), or the actual data object with it's property ids set.

Parameters:

clazz - The class that represtents the required mapping

obj - The object to delete

Throws:

CompassException

delete

void delete(Class clazz,
            Object... ids)
            throws CompassException

Deletes an object from Compass that match the mapping specified for the defined class based on its ids.

Parameters:

clazz - The class that represtents the required mapping

ids - The object ids to delete

Throws:

CompassException

get

<T> T get(Class<T> clazz,
          Object id)
      throws CompassException

Returns an object that match the mapping specified for the defined class, and matches the specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Returns null if the object is not found.

Parameters:

clazz - The class that represents the required mapping

id - The id that identifies the resource

Returns:

The object, returns null if not found

Throws:

CompassException

get

<T> T get(Class<T> clazz,
          Object... ids)
      throws CompassException

Returns an object that match the mapping specified for the defined class, and matches the specified ids. Returns null if the object is not found.

Parameters:

clazz - The class that represents the required mapping

ids - The ids that identifies the resource

Returns:

The object, returns null if not found

Throws:

CompassException

get

Object get(String alias,
           Object id)
           throws CompassException

Returns an object that match the mapping specified for the defined alias, and matches the specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Returns null if the object is not found.

Parameters:

alias - The alias that represents the required mapping

id - The id that identifies the resource

Returns:

The object, returns null if not found

Throws:

CompassException

get

Object get(String alias,
           Object... ids)
           throws CompassException

Returns an object that match the mapping specified for the defined alias, and matches the specified ids. Returns null if the object is not found.

Parameters:

alias - The alias that represents the required mapping

ids - The ids that identifies the resource

Returns:

The object, returns null if not found

Throws:

CompassException

load

<T> T load(Class<T> clazz,
           Object id)
       throws CompassException

Loads and returns an object that match the mapping specified for the defined class, and matches the specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Throws an exception if the resource is not found.

Parameters:

clazz - The class that represents the required mapping

id - The id that identifies the resource

Returns:

The object

Throws:

CompassException

load

<T> T load(Class<T> clazz,
           Object... ids)
       throws CompassException

Loads and returns an object that match the mapping specified for the defined class, and matches the specified ids.

Parameters:

clazz - The class that represents the required mapping

ids - The ids that identifies the resource

Returns:

The object

Throws:

CompassException

load

Object load(String alias,
            Object id)
            throws CompassException

Loads and returns an object that match the mapping specified for the defined class, and matches the specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Throws an exception if the resource is not found.

Parameters:

alias - The alias that represents the required mapping

id - The id that identifies the resource

Returns:

The object

Throws:

CompassException

load

Object load(String alias,
            Object... ids)
            throws CompassException

Loads and returns an object that match the mapping specified for the defined class, and matches the specified ids.

Parameters:

alias - The alias that represents the required mapping

ids - The ids that identifies the resource

Returns:

The object

Throws:

CompassException

delete

void delete(CompassQuery query)
            throws CompassException

Deletes all entries in the index that match the given query.

Parameters:

query - The query to delete by

Throws:

CompassException

find

CompassHits find(String query)
                 throws CompassException

Finds a list of objects that match the specified query. The query syntax is a search engine format query. For detailed description of the query syntax please visit the site.

Several examples are:

• A set of words - i.e. "Jack London". Compass will search the default property (usually ALL properties, specified in CompassEnvironment).
• A set of words prefixed by meta data name - i.e. author:"Jack London". Compass will search only meta data name author matching keywords Jack London.
• Multiple meta data names - i.e. author:"Jack London" AND book:Fang*. Compass will search both meta data name author matching keywords Jack London and meta data name book matching wildcard Fang*

Note that the list may contains several object types (classes) with no relation between them (except for the semantic relation).

Parameters:

query - The query string to search by

Returns:

A hits of objects that matches the query string

Throws:

CompassException

create

void create(Object obj)
            throws CompassException

Creates a NEW object in Compass. All the meta data defined in the Compass mapping files will be indexed and saved for later searching. Note that if the same object (same alias and same id's) already exists in the index, it won't be deleted.

Parameters:

obj - The object to save.

Throws:

CompassException

create

void create(String alias,
            Object obj)
            throws CompassException

Creates a NEW object in Compass that shares mapping alais with multiple objects. All the meta data defined in Compass mapping files will be indexed and saved for later searching. Note that if the same object (same alias and same id's) already exists in the index, it won't be deleted.

Parameters:

alias - The alias that match the object mappings

obj - The object to save

Throws:

CompassException

save

void save(Object obj)
          throws CompassException

Saves an object in Compass. All the meta data defined in the Compass mapping files will be indexed and saved for later searching.

Parameters:

obj - The object to save.

Throws:

CompassException

save

void save(String alias,
          Object obj)
          throws CompassException

Saves an object in Compass that shares mapping alais with multiple objects. All the meta data defined in Compass mapping files will be indexed and saved for later searching.

Parameters:

alias - The alias that match the object mappings

obj - The object to save

Throws:

CompassException

evict

void evict(Object obj)

Evicts the given object from the first level cache (transaction scoped cache).

Parameters:

obj - The objects to evict.

evict

void evict(String alias,
           Object id)

Evicts the given object from the first level cache (transaction scoped cache). The object can either be the id (or an array of ids), or the actual data object with it's property ids set.

Parameters:

alias - The alias of the object/entry to evict.

id - The id of the object/entry to evict.

evict

void evict(Resource resource)

Evicts the given resource from the first level cache (transaction scoped cache).

Parameters:

resource - The resource to evict.

evictAll

void evictAll()

Evicts all the objects and the resources from the first level cache.