nl.renarj.jasdb.storage.entities

Class EntityBagImpl

java.lang.Object

nl.renarj.jasdb.storage.entities.EntityBagImpl

All Implemented Interfaces:

EntityBag

Direct Known Subclasses:

AndroidEntityBag

public class EntityBagImpl
extends Object
implements EntityBag

Constructor Summary

Constructors

Modifier	Constructor and Description
	EntityBagImpl(String instanceId, String name)
protected	EntityBagImpl(String instanceId, String name, StorageService storageService)
	EntityBagImpl(String instanceId, String name, UserSession userSession)

Method Summary

Modifier and Type	Method and Description
SimpleEntity	addEntity(SimpleEntity entity) Adds an entity to the bag of entities
void	ensureIndex(CompositeIndexField indexField, boolean isUnique, IndexField... valueFields) Ensures there is an index present on a given amount of fields in this bag, will create if not existent, will do nothing if index already exists.
void	ensureIndex(IndexField indexField, boolean isUnique, IndexField... valueFields) Ensures there is an index present on a given field in this bag, will create if not existent, will do nothing if index already exists.
QueryExecutor	find(CompositeQueryField queryFields, SortParameter... params) Builds a query for document in the storage for multiple queryfields with optional sorting parameters
QueryExecutor	find(QueryBuilder queryBuilder) Builds a query for document in the storage using the QueryBuilder which has a fluent query building mechanism.
QueryExecutor	find(QueryField queryField, SortParameter... params) Builds a query for document in the storage for a specific queryfield with optional sorting parameters
void	flush() Forcibly flushes all the data in the bag to the storage
long	getDiskSize() Returns the size on the disk of the entities
QueryResult	getEntities() Execute a query returning all records in the bag
QueryResult	getEntities(int max) Execute a query returning all records in the bag with a given max
SimpleEntity	getEntity(String entityId) Retrieves a specific entity from the bag
List<String>	getIndexNames() Gets a list of all the index names on this bag
String	getName() Returns the name of the bag containing all data
long	getSize() Returns the amount of entities in the bag
void	removeEntity(SimpleEntity entity) Remove the entity from the bag
void	removeEntity(String entityId) Removes the entity from the bag using the id
void	removeIndex(String indexKeyName) Removes the index from the bag
SimpleEntity	updateEntity(SimpleEntity entity) Updates an entity in the bag of entities

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityBagImpl

protected EntityBagImpl(String instanceId,
                        String name,
                        StorageService storageService)

EntityBagImpl

public EntityBagImpl(String instanceId,
                     String name,
                     UserSession userSession)
              throws JasDBStorageException

Throws:

JasDBStorageException

EntityBagImpl

public EntityBagImpl(String instanceId,
                     String name)
              throws JasDBStorageException

Throws:

JasDBStorageException

Method Detail

getName

public String getName()

Description copied from interface: EntityBag

Returns the name of the bag containing all data

Specified by:

getName in interface EntityBag

Returns:

The name of the bag containing all data

getSize

public long getSize()
             throws JasDBStorageException

Description copied from interface: EntityBag

Returns the amount of entities in the bag

Specified by:

getSize in interface EntityBag

Returns:

The amount of entities in the bag

Throws:

JasDBStorageException

getDiskSize

public long getDiskSize()
                 throws JasDBStorageException

Description copied from interface: EntityBag

Returns the size on the disk of the entities

Specified by:

getDiskSize in interface EntityBag

Returns:

The size on the disk

Throws:

JasDBStorageException

flush

public void flush()
           throws JasDBStorageException

Description copied from interface: EntityBag

Forcibly flushes all the data in the bag to the storage

Specified by:

flush in interface EntityBag

Throws:

JasDBStorageException - If unable to flush the bag

addEntity

public SimpleEntity addEntity(SimpleEntity entity)
                       throws JasDBStorageException

Description copied from interface: EntityBag

Adds an entity to the bag of entities

Specified by:

addEntity in interface EntityBag

Parameters:

entity - The entity to add to the bag

Returns:

THe persisted entity

Throws:

JasDBStorageException - If unable to persist the entity into the bag

updateEntity

public SimpleEntity updateEntity(SimpleEntity entity)
                          throws JasDBStorageException

Description copied from interface: EntityBag

Updates an entity in the bag of entities

Specified by:

updateEntity in interface EntityBag

Parameters:

entity - The entity to update in the bag

Returns:

The updated entity

Throws:

JasDBStorageException - If unable to update the entity in the bag

removeEntity

public void removeEntity(SimpleEntity entity)
                  throws JasDBStorageException

Description copied from interface: EntityBag

Remove the entity from the bag

Specified by:

removeEntity in interface EntityBag

Parameters:

entity - The entity to be removed

Throws:

JasDBStorageException - If unable to remove the entity from the bag

removeEntity

public void removeEntity(String entityId)
                  throws JasDBStorageException

Description copied from interface: EntityBag

Removes the entity from the bag using the id

Specified by:

removeEntity in interface EntityBag

Parameters:

entityId - The id of the entity to delete

Throws:

JasDBStorageException - If unable to remove the entity from the bag

find

public QueryExecutor find(QueryField queryField,
                          SortParameter... params)
                   throws JasDBStorageException

Description copied from interface: EntityBag

Builds a query for document in the storage for a specific queryfield with optional sorting parameters

Specified by:

find in interface EntityBag

Parameters:

queryField - The field to query

params - The sorting parameters

Returns:

The QueryExecutor which can execute the query

Throws:

JasDBStorageException - If unable to build a document query

find

public QueryExecutor find(CompositeQueryField queryFields,
                          SortParameter... params)
                   throws JasDBStorageException

Description copied from interface: EntityBag

Builds a query for document in the storage for multiple queryfields with optional sorting parameters

Specified by:

find in interface EntityBag

Parameters:

queryFields - The fields to query

params - The sorting parameters

Returns:

The QueryExecutor which can execute the query

Throws:

JasDBStorageException - If unable to build a document query

find

public QueryExecutor find(QueryBuilder queryBuilder)
                   throws JasDBStorageException

Description copied from interface: EntityBag

Builds a query for document in the storage using the QueryBuilder which has a fluent query building mechanism.

Specified by:

find in interface EntityBag

Parameters:

queryBuilder - The querybuilder to use for building the query

Returns:

The QueryExecutor which can execute the query

Throws:

JasDBStorageException - If unable to build a document query

getEntities

public QueryResult getEntities()
                        throws JasDBStorageException

Description copied from interface: EntityBag

Execute a query returning all records in the bag

Specified by:

getEntities in interface EntityBag

Returns:

The QueryResult iterator for all records in the bag

Throws:

JasDBStorageException - If unable to return a all records iterator for this bag

getEntities

public QueryResult getEntities(int max)
                        throws JasDBStorageException

Description copied from interface: EntityBag

Execute a query returning all records in the bag with a given max

Specified by:

getEntities in interface EntityBag

Parameters:

max - The maximum amount of records to return

Returns:

The QueryResult iterator for all records in the bag

Throws:

JasDBStorageException - If unable to return a all records iterator for this bag

getEntity

public SimpleEntity getEntity(String entityId)
                       throws JasDBStorageException

Description copied from interface: EntityBag

Retrieves a specific entity from the bag

Specified by:

getEntity in interface EntityBag

Parameters:

entityId - The entityId to retrieve the document for

Returns:

The entity found in the bag

Throws:

JasDBStorageException - If unable to find the entity in the bag

ensureIndex

public void ensureIndex(IndexField indexField,
                        boolean isUnique,
                        IndexField... valueFields)
                 throws JasDBStorageException

Description copied from interface: EntityBag

Ensures there is an index present on a given field in this bag, will create if not existent, will do nothing if index already exists.

Specified by:

ensureIndex in interface EntityBag

Parameters:

indexField - The field to index

isUnique - True if the field contains unique values, False if not

valueFields - The valueFields to be stored in the index

Throws:

JasDBStorageException - If unable to ensure the index

ensureIndex

public void ensureIndex(CompositeIndexField indexField,
                        boolean isUnique,
                        IndexField... valueFields)
                 throws JasDBStorageException

Description copied from interface: EntityBag

Ensures there is an index present on a given amount of fields in this bag, will create if not existent, will do nothing if index already exists.

Specified by:

ensureIndex in interface EntityBag

Parameters:

indexField - The fields to persist in the index

isUnique - True if the field contains unique values, False if not

valueFields - The valueFields to be stored in the index

Throws:

JasDBStorageException - If unable to ensure the index

removeIndex

public void removeIndex(String indexKeyName)
                 throws JasDBStorageException

Description copied from interface: EntityBag

Removes the index from the bag

Specified by:

removeIndex in interface EntityBag

Parameters:

indexKeyName - The name of the index

Throws:

JasDBStorageException - If unable to cleanly remove the index

getIndexNames

public List<String> getIndexNames()
                           throws JasDBStorageException

Description copied from interface: EntityBag

Gets a list of all the index names on this bag

Specified by:

getIndexNames in interface EntityBag

Returns:

The list of all the index names

Throws:

JasDBStorageException - If unable to retrieve the indexes