nl.renarj.jasdb.service

Interface StorageService

All Known Implementing Classes:

LocalStorageServiceImpl

public interface StorageService

The storage serivce is the main storage interface in JasDB, it handles all interactions against a bag and related resources like indexes. All operations like create, read, update, delete and querying go through this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARTITION_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	closeService() Closes the service and all its used resources
void	ensureIndex(CompositeIndexField indexField, boolean isUnique, IndexField... valueFields) Ensures an index with a composite key (multiple fields) is present.
void	ensureIndex(IndexField indexField, boolean isUnique, IndexField... valueFields) Ensures an index with the given field is present.
void	flush() An operation that can be called to guarantee all changes are flushed to the disk.
String	getBagName() Gets the name of the bag that this storage service represents
long	getDiskSize() Gets the size on the disk (if the flushing strategy is async could misrepresent the real number)
QueryResult	getEntities(RequestContext context) This retrieves all items from storage with an iterator, the documents are only loaded once the iterator is used.
QueryResult	getEntities(RequestContext context, int max) This retrieves all items from storage with an iterator, the documents are only loaded once the iterator is used.
SimpleEntity	getEntityById(RequestContext requestContext, String id) Retrieve a specific entity from storage by the given unique document id
List<String>	getIndexNames() Gets a list of all present index names
String	getInstanceId() Gets the instance this bag belongs to
PartitioningManager	getPartitionManager()
long	getSize() Gets the amount of items stored
void	initializePartitions()
void	insertEntity(RequestContext context, SimpleEntity entity) This inserts the entity into the storage and indexes
void	openService(Configuration configuration) Opens the service and all the resources required.
void	remove() Removes the bag and all related resources from the storage location
void	removeEntity(RequestContext context, SimpleEntity entity) This removes and entity from storage and the indexes
void	removeEntity(RequestContext context, String internalId) This removes the entity based on the internal id of the entity
void	removeIndex(String indexName) Removes the index with the given name
QueryResult	search(RequestContext context, BlockOperation blockOperation, SearchLimit limit, List<SortParameter> params) This is the query entrypoint, all API queries are translated into a Query Object Model which can be executed on the indexes and be sorted after all index queries have been resolved
void	updateEntity(RequestContext context, SimpleEntity entity) This updates the entity in the storage and indexes if needed

Field Detail

PARTITION_PROPERTY

static final String PARTITION_PROPERTY

See Also:

Constant Field Values

Method Detail

getBagName

String getBagName()

Gets the name of the bag that this storage service represents

Returns:

The name of the bag

getInstanceId

String getInstanceId()

Gets the instance this bag belongs to

Returns:

The instance id

openService

void openService(Configuration configuration)
          throws JasDBStorageException

Opens the service and all the resources required. This is guaranteed to be called before any operations on the service are called.

Parameters:

configuration - The configuration

Throws:

JasDBStorageException - If unable to open the storage service

closeService

void closeService()
           throws JasDBStorageException

Closes the service and all its used resources

Throws:

JasDBStorageException - If unable to cleanly close the resources

flush

void flush()
    throws JasDBStorageException

An operation that can be called to guarantee all changes are flushed to the disk.

Throws:

JasDBStorageException - If unable to flush the changes to the disk

remove

void remove()
     throws JasDBStorageException

Removes the bag and all related resources from the storage location

Throws:

JasDBStorageException - If unable to remove the bag and related resources

initializePartitions

void initializePartitions()
                   throws JasDBStorageException

Throws:

JasDBStorageException

getPartitionManager

PartitioningManager getPartitionManager()

insertEntity

void insertEntity(RequestContext context,
                  SimpleEntity entity)
           throws JasDBStorageException

This inserts the entity into the storage and indexes

Parameters:

context - The request context

entity - The entity to store in the storage and which is used to populate the indexes

Throws:

JasDBStorageException - If unable to insert the entity or the indexes

removeEntity

void removeEntity(RequestContext context,
                  SimpleEntity entity)
           throws JasDBStorageException

This removes and entity from storage and the indexes

Parameters:

context - The request context

entity - The entity to remove from the storage and the indexes

Throws:

JasDBStorageException - If unable to remove the entity from the indexes or storage

removeEntity

void removeEntity(RequestContext context,
                  String internalId)
           throws JasDBStorageException

This removes the entity based on the internal id of the entity

Parameters:

context - The request context

internalId - The entity to remove the storage and indexes

Throws:

JasDBStorageException - If unable to remove the entity from the indexes or storage

updateEntity

void updateEntity(RequestContext context,
                  SimpleEntity entity)
           throws JasDBStorageException

This updates the entity in the storage and indexes if needed

Parameters:

context - The request context

entity - The entity to update

Throws:

JasDBStorageException - If unable to update

getSize

long getSize()
      throws JasDBStorageException

Gets the amount of items stored

Returns:

The amount of stored items

Throws:

JasDBStorageException - If unable to retrieve the amount of stored items

getDiskSize

long getDiskSize()
          throws JasDBStorageException

Gets the size on the disk (if the flushing strategy is async could misrepresent the real number)

Returns:

The disk size

Throws:

JasDBStorageException - If unable to return the amount of used disk space

getEntityById

SimpleEntity getEntityById(RequestContext requestContext,
                           String id)
                    throws JasDBStorageException

Retrieve a specific entity from storage by the given unique document id

Parameters:

requestContext - The request context

id - The unique documentId of the item

Returns:

The entity loaded from storage

Throws:

JasDBStorageException - If unable to retrieve the item from storage

getEntities

QueryResult getEntities(RequestContext context)
                 throws JasDBStorageException

This retrieves all items from storage with an iterator, the documents are only loaded once the iterator is used.

Returns:

The QueryResult for all records in storage

Throws:

JasDBStorageException - If unable to load the iterator over all documents

getEntities

QueryResult getEntities(RequestContext context,
                        int max)
                 throws JasDBStorageException

This retrieves all items from storage with an iterator, the documents are only loaded once the iterator is used. The iterator will only return a limited set of result based on the max specified.

Parameters:

max - The maximum amount of records to retrieve

Returns:

The QueryResult for all records in storage

Throws:

JasDBStorageException - If unable to load the iterator over all documents

search

QueryResult search(RequestContext context,
                   BlockOperation blockOperation,
                   SearchLimit limit,
                   List<SortParameter> params)
            throws JasDBStorageException

This is the query entrypoint, all API queries are translated into a Query Object Model which can be executed on the indexes and be sorted after all index queries have been resolved

Parameters:

context - THe request context

blockOperation - The main blockoperation, the parent item in the Query Object Model.

limit - The limits of the given query

params - The sorting paramaters to be applied to the resultset

Returns:

A Query ResultSet which can be iterated over, the records are only loaded when iterating.

Throws:

JasDBStorageException - If unable to execute the search query

ensureIndex

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

Ensures an index with the given field is present. If the index is not present it will be created. If the index is created it will block until index creation is completed.

Parameters:

indexField - The field to be indexed

isUnique - True If the field needs to have a unique constraint, False if not

valueFields - The value fields to be added to the index, can be used to improve sorting performance or secondary queries

Throws:

JasDBStorageException - If unable to ensure the index exists

ensureIndex

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

Ensures an index with a composite key (multiple fields) is present. If the index is not present it will be created. If the index is created it will block until index creation is completed.

Parameters:

indexField - The indexed composite fields

isUnique - True If the field needs to have a unique constraint, False if not

valueFields - The value fields to be added to the index, can be used to improve sorting performance or secondary queries

Throws:

JasDBStorageException - If unable to ensure the index exists

getIndexNames

List<String> getIndexNames()
                    throws JasDBStorageException

Gets a list of all present index names

Returns:

The list of index names

Throws:

JasDBStorageException - If unable to retrieve the list of index names

removeIndex

void removeIndex(String indexName)
          throws JasDBStorageException

Removes the index with the given name

Parameters:

indexName - The name of the index to be removed

Throws:

JasDBStorageException - If unable to remove the index