nl.renarj.jasdb.index

Interface Index

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BTreeIndex

public interface Index
extends AutoCloseable

This is the index interface, any Index implementation will require this interface to be implemented. Any index will support search, insert, update and remove operations on the index. The index will work on a given Key object which can be used for any operation on the index. Any index supplies a KeyInfo object which can be used to determine information about the Index.

Author:

Renze de Vries

Field Summary

Fields

Modifier and Type	Field and Description
static SearchLimit	NO_SEARCH_LIMIT

Method Summary

Modifier and Type	Method and Description
void	close() Close the index and all its used resources
void	configure(Configuration configuration) Configure the index with configuration settings found in global configuration
long	count() Returns the amount of keys in the index
void	flushIndex() This persists the changes to the disk backing of the index
IndexIterator	getIndexIterator() This gets an iterator which allows iterating over the full index collection
int	getIndexType()
KeyInfo	getKeyInfo() This returns all global key information being stored in this index
MemoryAware	getMemoryManager() This is the memory manager of the index, this is used to determine vital memory parameters.
String	getName()
int	getPageSize()
IndexState	getState() Returns the state of the index
boolean	hasUniqueConstraint()
void	insertIntoIndex(Key key) Inserts the given key into the index, the key is to expected to conform to the index key specification as determined in the keyinfo.
int	match(Set<String> fields) Determines how close the gives fields match the index descriptor.
void	openIndex() Opens the index and its resources
void	rebuildIndex(Iterator<IndexableItem> indexableItems) Do a full rebuild of the index and fully populate it based on provided item iterator
void	removeFromIndex(Key key) Remove the given key and its values from the index.
void	removeIndex() Removes the index and all used resources
IndexScanReport	scan(ScanIntent intent, Iterator<IndexableItem> scanItems) This performs a scan of the index and reports on the integrity.
IndexSearchResultIteratorCollection	searchIndex(SearchCondition searchCondition, SearchLimit searchLimit) Do a search operation of the index given the searchcondition.
void	updateKey(Key oldKey, Key newKey) Update the key payload inside the index, the key is to expected to conform to the index key specification as determined in the keyinfo.

Field Detail

NO_SEARCH_LIMIT

static final SearchLimit NO_SEARCH_LIMIT

Method Detail

configure

void configure(Configuration configuration)
        throws ConfigurationException

Configure the index with configuration settings found in global configuration

Parameters:

configuration - The configuration object

Throws:

ConfigurationException - If unable to configure the index

getKeyInfo

KeyInfo getKeyInfo()

This returns all global key information being stored in this index

Returns:

The key information of the index

getName

String getName()

getPageSize

int getPageSize()

getIndexType

int getIndexType()

count

long count()

Returns the amount of keys in the index

Returns:

The amount of keys in the index

hasUniqueConstraint

boolean hasUniqueConstraint()

match

int match(Set<String> fields)

Determines how close the gives fields match the index descriptor. The scale is on 0-200. This would reach 200 in case all value fields and index fields are a 100% match. The calculation is N (number of matching fields) / field.size + (N / fields.size) * included matching columns.

Parameters:

fields - The fields being requested

Returns:

The match ratio from 0-200

searchIndex

IndexSearchResultIteratorCollection searchIndex(SearchCondition searchCondition,
                                                SearchLimit searchLimit)
                                         throws JasDBStorageException

Do a search operation of the index given the searchcondition. The searchCondition is based on a specific search in this index and only applies to the given index. The searchlimit determines the maximum results to be retrieved.

Parameters:

searchCondition - The searchcondition to apply to only this index

searchLimit - The searchlimit to apply whilst searching

Returns:

An iterator that will be able to iterate over results and is mergable

Throws:

JasDBStorageException - If unable to complete the search in the index

getIndexIterator

IndexIterator getIndexIterator()
                        throws JasDBStorageException

This gets an iterator which allows iterating over the full index collection

Returns:

The index iterator

Throws:

JasDBStorageException - If unable to open the index iterator

insertIntoIndex

void insertIntoIndex(Key key)
              throws JasDBStorageException

Inserts the given key into the index, the key is to expected to conform to the index key specification as determined in the keyinfo.

Parameters:

key - The key to be persisted to the index

Throws:

JasDBStorageException - If unable to persist the key in the index

removeFromIndex

void removeFromIndex(Key key)
              throws JasDBStorageException

Remove the given key and its values from the index. The key only requires the key part to be populated, value fields are not required to be populated.

Parameters:

key - The key to be removed from the index

Throws:

JasDBStorageException - If unable to remove the key from the index

updateKey

void updateKey(Key oldKey,
               Key newKey)
        throws JasDBStorageException

Update the key payload inside the index, the key is to expected to conform to the index key specification as determined in the keyinfo.

Parameters:

oldKey - The previous key present in the index

newKey - The new key value to be used instead

Throws:

JasDBStorageException - If unable to update the key in the index

openIndex

void openIndex()
        throws JasDBStorageException

Opens the index and its resources

Throws:

JasDBStorageException

close

void close()
    throws JasDBStorageException

Close the index and all its used resources

Specified by:

close in interface AutoCloseable

Throws:

JasDBStorageException - If unable to cleanly close the index

removeIndex

void removeIndex()
          throws JasDBStorageException

Removes the index and all used resources

Throws:

JasDBStorageException - If unable to delete the index

flushIndex

void flushIndex()
         throws JasDBStorageException

This persists the changes to the disk backing of the index

Throws:

JasDBStorageException - If unable to flush the changes

scan

IndexScanReport scan(ScanIntent intent,
                     Iterator<IndexableItem> scanItems)
              throws JasDBStorageException

This performs a scan of the index and reports on the integrity. The scan is done with an intent indicating a rescan is requested or just a report. In case of a report it returns the last scan result if present, if not present scan will be performed and returned. The scan operation will modify the index state according to scan report, if scan reveals invalid index it will set state to invalid, etc.

Parameters:

intent - The scanning intent, rescan or report

scanItems - The list of items to scan for in the index

Returns:

The scan report indicating index state

Throws:

JasDBStorageException - If unable to perform or complete index scan

getState

IndexState getState()

Returns the state of the index

Returns:

The state of index

rebuildIndex

void rebuildIndex(Iterator<IndexableItem> indexableItems)
           throws JasDBStorageException

Do a full rebuild of the index and fully populate it based on provided item iterator

Parameters:

indexableItems - The items to be indexed

Throws:

JasDBStorageException - If unable to rebuild the index

getMemoryManager

MemoryAware getMemoryManager()
                      throws JasDBStorageException

This is the memory manager of the index, this is used to determine vital memory parameters.

Returns:

THe memory manager used by this index

Throws:

JasDBStorageException