nl.renarj.jasdb.service

Class LocalStorageServiceImpl

java.lang.Object

nl.renarj.jasdb.service.LocalStorageServiceImpl

All Implemented Interfaces:

StorageService

@Component(value="LocalStorageService")
 @Scope(value="prototype")
public class LocalStorageServiceImpl
extends Object
implements StorageService

Field Summary

Fields

Modifier and Type	Field and Description
static String	BAG_EXTENSION
static String	FORCE_REBUILD_COMMAND

Fields inherited from interface nl.renarj.jasdb.service.StorageService

PARTITION_PROPERTY

Constructor Summary

Constructors

Constructor and Description
LocalStorageServiceImpl(String instanceId, String bagName)

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	setBagInsertOperation(DataOperation bagInsertOperation)
void	setBagRemoveOperation(DataOperation bagRemoveOperation)
void	setBagUpdateOperation(DataOperation bagUpdateOperation)
void	setGenerator(IdGenerator generator)
void	setIndexManagerFactory(IndexManagerFactory indexManagerFactory)
void	setMetadataStore(MetadataStore metadataStore)
void	setPartitionManager(PartitioningManager partitionManager)
void	setRecordWriterFactoryLoader(RecordWriterFactoryLoader recordWriterFactoryLoader)
String	toString()
void	updateEntity(RequestContext context, SimpleEntity entity) This updates the entity in the storage and indexes if needed

Methods inherited from class java.lang.Object

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

Field Detail

BAG_EXTENSION

public static final String BAG_EXTENSION

See Also:

Constant Field Values

FORCE_REBUILD_COMMAND

public static final String FORCE_REBUILD_COMMAND

See Also:

Constant Field Values

Constructor Detail

LocalStorageServiceImpl

public LocalStorageServiceImpl(String instanceId,
                               String bagName)

Method Detail

getBagName

public String getBagName()

Description copied from interface: StorageService

Gets the name of the bag that this storage service represents

Specified by:

getBagName in interface StorageService

Returns:

The name of the bag

getInstanceId

public String getInstanceId()

Description copied from interface: StorageService

Gets the instance this bag belongs to

Specified by:

getInstanceId in interface StorageService

Returns:

The instance id

closeService

public void closeService()
                  throws JasDBStorageException

Description copied from interface: StorageService

Closes the service and all its used resources

Specified by:

closeService in interface StorageService

Throws:

JasDBStorageException - If unable to cleanly close the resources

flush

public void flush()
           throws JasDBStorageException

Description copied from interface: StorageService

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

Specified by:

flush in interface StorageService

Throws:

JasDBStorageException - If unable to flush the changes to the disk

openService

public void openService(Configuration configuration)
                 throws JasDBStorageException

Description copied from interface: StorageService

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

Specified by:

openService in interface StorageService

Parameters:

configuration - The configuration

Throws:

JasDBStorageException - If unable to open the storage service

remove

public void remove()
            throws JasDBStorageException

Description copied from interface: StorageService

Removes the bag and all related resources from the storage location

Specified by:

remove in interface StorageService

Throws:

JasDBStorageException - If unable to remove the bag and related resources

getPartitionManager

public PartitioningManager getPartitionManager()

Specified by:

getPartitionManager in interface StorageService

initializePartitions

public void initializePartitions()
                          throws JasDBStorageException

Specified by:

initializePartitions in interface StorageService

Throws:

JasDBStorageException

insertEntity

public void insertEntity(RequestContext context,
                         SimpleEntity entity)
                  throws JasDBStorageException

Description copied from interface: StorageService

This inserts the entity into the storage and indexes

Specified by:

insertEntity in interface StorageService

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

public void removeEntity(RequestContext context,
                         SimpleEntity entity)
                  throws JasDBStorageException

Description copied from interface: StorageService

This removes and entity from storage and the indexes

Specified by:

removeEntity in interface StorageService

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

public void removeEntity(RequestContext context,
                         String internalId)
                  throws JasDBStorageException

Description copied from interface: StorageService

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

Specified by:

removeEntity in interface StorageService

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

public void updateEntity(RequestContext context,
                         SimpleEntity entity)
                  throws JasDBStorageException

Description copied from interface: StorageService

This updates the entity in the storage and indexes if needed

Specified by:

updateEntity in interface StorageService

Parameters:

context - The request context

entity - The entity to update

Throws:

JasDBStorageException - If unable to update

getSize

public long getSize()
             throws JasDBStorageException

Description copied from interface: StorageService

Gets the amount of items stored

Specified by:

getSize in interface StorageService

Returns:

The amount of stored items

Throws:

JasDBStorageException - If unable to retrieve the amount of stored items

getDiskSize

public long getDiskSize()
                 throws JasDBStorageException

Description copied from interface: StorageService

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

Specified by:

getDiskSize in interface StorageService

Returns:

The disk size

Throws:

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

getEntityById

public SimpleEntity getEntityById(RequestContext requestContext,
                                  String id)
                           throws JasDBStorageException

Description copied from interface: StorageService

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

Specified by:

getEntityById in interface StorageService

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

public QueryResult getEntities(RequestContext context)
                        throws JasDBStorageException

Description copied from interface: StorageService

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

Specified by:

getEntities in interface StorageService

Returns:

The QueryResult for all records in storage

Throws:

JasDBStorageException - If unable to load the iterator over all documents

getEntities

public QueryResult getEntities(RequestContext context,
                               int max)
                        throws JasDBStorageException

Description copied from interface: StorageService

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.

Specified by:

getEntities in interface StorageService

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

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

Description copied from interface: StorageService

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

Specified by:

search in interface StorageService

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

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

Description copied from interface: StorageService

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.

Specified by:

ensureIndex in interface StorageService

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

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

Description copied from interface: StorageService

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.

Specified by:

ensureIndex in interface StorageService

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

public List<String> getIndexNames()
                           throws JasDBStorageException

Description copied from interface: StorageService

Gets a list of all present index names

Specified by:

getIndexNames in interface StorageService

Returns:

The list of index names

Throws:

JasDBStorageException - If unable to retrieve the list of index names

removeIndex

public void removeIndex(String indexName)
                 throws JasDBStorageException

Description copied from interface: StorageService

Removes the index with the given name

Specified by:

removeIndex in interface StorageService

Parameters:

indexName - The name of the index to be removed

Throws:

JasDBStorageException - If unable to remove the index

toString

public String toString()

Overrides:

toString in class Object

setRecordWriterFactoryLoader

public void setRecordWriterFactoryLoader(RecordWriterFactoryLoader recordWriterFactoryLoader)

setPartitionManager

public void setPartitionManager(PartitioningManager partitionManager)

setGenerator

public void setGenerator(IdGenerator generator)

setBagInsertOperation

public void setBagInsertOperation(DataOperation bagInsertOperation)

setBagRemoveOperation

public void setBagRemoveOperation(DataOperation bagRemoveOperation)

setBagUpdateOperation

public void setBagUpdateOperation(DataOperation bagUpdateOperation)

setIndexManagerFactory

public void setIndexManagerFactory(IndexManagerFactory indexManagerFactory)

setMetadataStore

public void setMetadataStore(MetadataStore metadataStore)