com.adeptia.indigo.storage
Interface EntityManager


public interface EntityManager

Storable entity manager interface

Version:
CVS $Revision: 1.9 $

Method Summary
 void activateEntityVersion(com.adeptia.indigo.storage.Entity entity)
           
 void createEntity(com.adeptia.indigo.storage.Entity entity)
          Creates new entity object with specified attributes.
 void createEntity(com.adeptia.indigo.storage.Entity entity, java.util.Map map)
          Creates new entity object with specified comments stored in the map.
 boolean entityContainsIdentity(com.adeptia.indigo.storage.Entity entity)
          Checks the entity for the existence of initialized identity fields
 boolean entityExists(com.adeptia.indigo.storage.Entity entity)
          Check whether a specified entity exists.
 java.util.List getEntityIdentity(com.adeptia.indigo.storage.Entity entity)
          Retrieve the primary keys values.
 void initialize(java.lang.Class entityType, javax.security.auth.Subject subject)
          Initialize the entity manager
 void removeEntity(com.adeptia.indigo.storage.Entity entity)
          Removes an entity from the storage.
 void removeEntity(com.adeptia.indigo.storage.Entity entity, java.util.Map map)
          Removes an entity from the storage with specified comments stored in the map.
 void removeEntityVersion(com.adeptia.indigo.storage.Entity entity)
           
 java.util.Iterator retrieve()
          Retrieve all the entities from persistent storage.
 java.util.Iterator retrieve(com.adeptia.indigo.storage.Criteria criteria)
          Retrieve a set of entities from persistent storage using the specified criteria.
 com.adeptia.indigo.storage.Entity retrieve(com.adeptia.indigo.storage.Entity entity)
          Retrieve a entity from persistent storage.
 com.adeptia.indigo.storage.Entity retrieve(TypedEntityId typedId)
           
 int retrieveEntitiesCount()
           
 java.util.Iterator retrieveOrderBy(java.lang.String orderByFields)
          Retrieve all the entities from persistent storage with Order By clause.
 java.util.Iterator retrieveOrderBy(java.lang.String orderByFields, boolean useVersion, java.lang.String id)
           
 java.util.Iterator retrieveOrderBy(java.lang.String orderByClause, com.adeptia.indigo.storage.Criteria criteria)
           
 java.util.Iterator retrieveOrderBy(java.lang.String orderByClause, com.adeptia.indigo.storage.Criteria criteria, boolean useVersion, java.lang.String id)
           
 java.util.Iterator retrieveOrderBy(java.lang.String orderByFields, java.lang.String sortOrder)
          Retrieve all the entities from persistent storage with Order By and sort order clause.
 java.util.Iterator retrieveOrderBy(java.lang.String orderByFields, java.lang.String sortOrder, boolean useVersion, java.lang.String id)
           
 void update(com.adeptia.indigo.storage.Entity entity)
          Save an entity to the persistent storage.
 void update(com.adeptia.indigo.storage.Entity entity, java.util.Map values)
          Update an entity with the values from the map.
 void update(com.adeptia.indigo.storage.Entity entity, java.lang.String flag)
          Save an entity to the persistent storage.
 

Method Detail

initialize

void initialize(java.lang.Class entityType,
                javax.security.auth.Subject subject)
                throws com.adeptia.indigo.storage.StorageException
Initialize the entity manager

Parameters:
entityType -
subject -
Throws:
com.adeptia.indigo.storage.StorageException

entityExists

boolean entityExists(com.adeptia.indigo.storage.Entity entity)
                     throws com.adeptia.indigo.storage.StorageException,
                            com.adeptia.indigo.utils.IndigoException
Check whether a specified entity exists.

Parameters:
entity - The entity to be checked.
Returns:
true if the specified entity exists
Throws:
com.adeptia.indigo.storage.StorageException - if there was an error accessing the data backend.
com.adeptia.indigo.utils.IndigoException

retrieve

com.adeptia.indigo.storage.Entity retrieve(com.adeptia.indigo.storage.Entity entity)
                                           throws com.adeptia.indigo.storage.UnknownEntityException,
                                                  com.adeptia.indigo.storage.StorageException,
                                                  com.adeptia.indigo.utils.IndigoException
Retrieve a entity from persistent storage. The primary key fields must be initialized as they will be used to lookup the entity

Parameters:
entity -
Returns:
Object
Throws:
com.adeptia.indigo.storage.UnknownEntityException
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.utils.IndigoException

retrieve

com.adeptia.indigo.storage.Entity retrieve(TypedEntityId typedId)
                                           throws com.adeptia.indigo.storage.UnknownEntityException,
                                                  com.adeptia.indigo.storage.StorageException,
                                                  com.adeptia.indigo.utils.IndigoException
Throws:
com.adeptia.indigo.storage.UnknownEntityException
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.utils.IndigoException

retrieve

java.util.Iterator retrieve(com.adeptia.indigo.storage.Criteria criteria)
                            throws com.adeptia.indigo.storage.UnknownEntityException,
                                   com.adeptia.indigo.storage.StorageException,
                                   com.adeptia.indigo.utils.IndigoException
Retrieve a set of entities from persistent storage using the specified criteria. The criteria must be a valid OQL clause;

Parameters:
criteria - OQL criteria to be used
Returns:
a Iterator of entities meeting the given criteria
Throws:
com.adeptia.indigo.storage.UnknownEntityException - if the entity's record does not exist in the database.
com.adeptia.indigo.storage.StorageException - if there is a problem accessing the storage.
com.adeptia.indigo.utils.IndigoException

retrieve

java.util.Iterator retrieve()
                            throws com.adeptia.indigo.storage.StorageException,
                                   com.adeptia.indigo.utils.IndigoException
Retrieve all the entities from persistent storage.

Use with extreme care

Returns:
a Iterator of entities exist in the database.
Throws:
com.adeptia.indigo.storage.StorageException - if there is a problem accessing the storage.
com.adeptia.indigo.utils.IndigoException

retrieveEntitiesCount

int retrieveEntitiesCount()
                          throws com.adeptia.indigo.storage.StorageException,
                                 com.adeptia.indigo.utils.IndigoException
Throws:
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.utils.IndigoException

update

void update(com.adeptia.indigo.storage.Entity entity)
            throws com.adeptia.indigo.storage.UnknownEntityException,
                   com.adeptia.indigo.storage.StorageException,
                   com.adeptia.indigo.utils.IndigoException
Save an entity to the persistent storage. Object's record is required to exist in the storage.

Parameters:
entity - an object to store.
Throws:
com.adeptia.indigo.storage.UnknownEntityException - if the entity's record does not exist in the database.
com.adeptia.indigo.storage.StorageException - if there is a problem accessing the storage.
com.adeptia.indigo.utils.IndigoException

update

void update(com.adeptia.indigo.storage.Entity entity,
            java.lang.String flag)
            throws com.adeptia.indigo.storage.UnknownEntityException,
                   com.adeptia.indigo.storage.StorageException,
                   com.adeptia.indigo.utils.IndigoException
Save an entity to the persistent storage. escaping checks while updating

Throws:
com.adeptia.indigo.storage.UnknownEntityException
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.utils.IndigoException

update

void update(com.adeptia.indigo.storage.Entity entity,
            java.util.Map values)
            throws com.adeptia.indigo.storage.UnknownEntityException,
                   com.adeptia.indigo.storage.StorageException,
                   com.adeptia.indigo.utils.IndigoException
Update an entity with the values from the map.

Parameters:
entity -
values -
Throws:
com.adeptia.indigo.storage.UnknownEntityException
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.utils.IndigoException

createEntity

void createEntity(com.adeptia.indigo.storage.Entity entity)
                  throws com.adeptia.indigo.storage.StorageException,
                         com.adeptia.indigo.storage.EntityExistsException,
                         com.adeptia.indigo.utils.IndigoException
Creates new entity object with specified attributes.

Parameters:
entity - the object describing entity to be created.
Throws:
com.adeptia.indigo.storage.StorageException - if there was an error accessing the data backend.
com.adeptia.indigo.storage.EntityExistsException - if the entity entity already exists.
com.adeptia.indigo.utils.IndigoException

createEntity

void createEntity(com.adeptia.indigo.storage.Entity entity,
                  java.util.Map map)
                  throws com.adeptia.indigo.storage.StorageException,
                         com.adeptia.indigo.storage.EntityExistsException,
                         com.adeptia.indigo.utils.IndigoException
Creates new entity object with specified comments stored in the map.

Parameters:
entity - the object describing entity to be created.
map - containing activity comments.
Throws:
com.adeptia.indigo.storage.StorageException - if there was an error accessing the data backend.
com.adeptia.indigo.storage.EntityExistsException - if the entity entity already exists.
com.adeptia.indigo.utils.IndigoException

removeEntity

void removeEntity(com.adeptia.indigo.storage.Entity entity)
                  throws com.adeptia.indigo.storage.UnknownEntityException,
                         com.adeptia.indigo.storage.StorageException,
                         com.adeptia.indigo.utils.IndigoException
Removes an entity from the storage.

Parameters:
entity - the object describing the entity to be removed.
Throws:
com.adeptia.indigo.storage.StorageException - if there was an error accessing the data backend.
com.adeptia.indigo.storage.UnknownEntityException - if the entity entity is not present.
com.adeptia.indigo.utils.IndigoException

removeEntity

void removeEntity(com.adeptia.indigo.storage.Entity entity,
                  java.util.Map map)
                  throws com.adeptia.indigo.storage.UnknownEntityException,
                         com.adeptia.indigo.storage.StorageException,
                         com.adeptia.indigo.utils.IndigoException
Removes an entity from the storage with specified comments stored in the map.

Parameters:
entity - the object describing the entity to be removed.
map - containing activity comments.
Throws:
com.adeptia.indigo.storage.StorageException - if there was an error accessing the data backend.
com.adeptia.indigo.storage.UnknownEntityException - if the entity entity is not present.
com.adeptia.indigo.utils.IndigoException

entityContainsIdentity

boolean entityContainsIdentity(com.adeptia.indigo.storage.Entity entity)
                               throws java.lang.IllegalAccessException,
                                      java.lang.reflect.InvocationTargetException,
                                      java.lang.NoSuchMethodException
Checks the entity for the existence of initialized identity fields

Parameters:
entity -
Returns:
Throws:
java.lang.IllegalAccessException
java.lang.reflect.InvocationTargetException
java.lang.NoSuchMethodException

getEntityIdentity

java.util.List getEntityIdentity(com.adeptia.indigo.storage.Entity entity)
Retrieve the primary keys values.

Parameters:
entity -
Returns:

retrieveOrderBy

java.util.Iterator retrieveOrderBy(java.lang.String orderByFields)
                                   throws com.adeptia.indigo.storage.StorageException,
                                          com.adeptia.indigo.utils.IndigoException
Retrieve all the entities from persistent storage with Order By clause.

Use with extreme care

Parameters:
orderByField -
Returns:
a Iterator of entities exist in the database.
Throws:
com.adeptia.indigo.storage.StorageException - if there is a problem accessing the storage.
com.adeptia.indigo.utils.IndigoException

retrieveOrderBy

java.util.Iterator retrieveOrderBy(java.lang.String orderByFields,
                                   java.lang.String sortOrder)
                                   throws com.adeptia.indigo.storage.StorageException,
                                          com.adeptia.indigo.utils.IndigoException
Retrieve all the entities from persistent storage with Order By and sort order clause.

Use with extreme care

Parameters:
orderByField -
Returns:
a Iterator of entities exist in the database.
Throws:
com.adeptia.indigo.storage.StorageException - if there is a problem accessing the storage.
com.adeptia.indigo.utils.IndigoException

retrieveOrderBy

java.util.Iterator retrieveOrderBy(java.lang.String orderByClause,
                                   com.adeptia.indigo.storage.Criteria criteria)
                                   throws com.adeptia.indigo.storage.StorageException,
                                          com.adeptia.indigo.storage.UnknownEntityException,
                                          com.adeptia.indigo.utils.IndigoException
Throws:
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.storage.UnknownEntityException
com.adeptia.indigo.utils.IndigoException

retrieveOrderBy

java.util.Iterator retrieveOrderBy(java.lang.String orderByFields,
                                   boolean useVersion,
                                   java.lang.String id)
                                   throws com.adeptia.indigo.storage.StorageException,
                                          com.adeptia.indigo.utils.IndigoException
Throws:
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.utils.IndigoException

retrieveOrderBy

java.util.Iterator retrieveOrderBy(java.lang.String orderByFields,
                                   java.lang.String sortOrder,
                                   boolean useVersion,
                                   java.lang.String id)
                                   throws com.adeptia.indigo.storage.StorageException,
                                          com.adeptia.indigo.utils.IndigoException
Throws:
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.utils.IndigoException

retrieveOrderBy

java.util.Iterator retrieveOrderBy(java.lang.String orderByClause,
                                   com.adeptia.indigo.storage.Criteria criteria,
                                   boolean useVersion,
                                   java.lang.String id)
                                   throws com.adeptia.indigo.storage.StorageException,
                                          com.adeptia.indigo.storage.UnknownEntityException,
                                          com.adeptia.indigo.utils.IndigoException
Throws:
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.storage.UnknownEntityException
com.adeptia.indigo.utils.IndigoException

removeEntityVersion

void removeEntityVersion(com.adeptia.indigo.storage.Entity entity)
                         throws com.adeptia.indigo.storage.UnknownEntityException,
                                com.adeptia.indigo.storage.StorageException,
                                com.adeptia.indigo.utils.IndigoException
Throws:
com.adeptia.indigo.storage.UnknownEntityException
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.utils.IndigoException

activateEntityVersion

void activateEntityVersion(com.adeptia.indigo.storage.Entity entity)
                           throws com.adeptia.indigo.storage.UnknownEntityException,
                                  com.adeptia.indigo.storage.StorageException,
                                  com.adeptia.indigo.utils.IndigoException
Throws:
com.adeptia.indigo.storage.UnknownEntityException
com.adeptia.indigo.storage.StorageException
com.adeptia.indigo.utils.IndigoException