nl.renarj.jasdb.index.btreeplus

Class BTreeIndex

java.lang.Object

nl.renarj.jasdb.index.btreeplus.BTreeIndex

All Implemented Interfaces:

AutoCloseable, Index

public class BTreeIndex
extends Object
implements Index

Author:

Renze de Vries

Field Summary

Fields inherited from interface nl.renarj.jasdb.index.Index

NO_SEARCH_LIMIT

Constructor Summary

Constructors

Constructor and Description
BTreeIndex(File indexLocation, KeyInfo keyInfo)

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
protected LockManager	getLockManager()
MemoryAware	getMemoryManager() This is the memory manager of the index, this is used to determine vital memory parameters.
String	getName()
int	getPageSize()
protected BlockPersister	getPersister()
protected RootBlock	getRootBlock()
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
void	resetIndex()
IndexScanReport	scan(ScanIntent intent, Iterator<IndexableItem> indexableItems) 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.
String	toString()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BTreeIndex

public BTreeIndex(File indexLocation,
                  KeyInfo keyInfo)

Method Detail

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Description copied from interface: Index

Configure the index with configuration settings found in global configuration

Specified by:

configure in interface Index

Parameters:

configuration - The configuration object

Throws:

ConfigurationException - If unable to configure the index

hasUniqueConstraint

public boolean hasUniqueConstraint()

Specified by:

hasUniqueConstraint in interface Index

getRootBlock

protected RootBlock getRootBlock()
                          throws JasDBStorageException

Throws:

JasDBStorageException

getPersister

protected BlockPersister getPersister()
                               throws JasDBStorageException

Throws:

JasDBStorageException

getLockManager

protected LockManager getLockManager()
                              throws JasDBStorageException

Throws:

JasDBStorageException

getKeyInfo

public KeyInfo getKeyInfo()

Description copied from interface: Index

This returns all global key information being stored in this index

Specified by:

getKeyInfo in interface Index

Returns:

The key information of the index

getName

public String getName()

Specified by:

getName in interface Index

count

public long count()

Description copied from interface: Index

Returns the amount of keys in the index

Specified by:

count in interface Index

Returns:

The amount of keys in the index

getPageSize

public int getPageSize()

Specified by:

getPageSize in interface Index

getIndexType

public int getIndexType()

Specified by:

getIndexType in interface Index

match

public int match(Set<String> fields)

Description copied from interface: Index

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.

Specified by:

match in interface Index

Parameters:

fields - The fields being requested

Returns:

The match ratio from 0-200

searchIndex

public IndexSearchResultIteratorCollection searchIndex(SearchCondition searchCondition,
                                                       SearchLimit searchLimit)
                                                throws JasDBStorageException

Description copied from interface: Index

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.

Specified by:

searchIndex in interface Index

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

public IndexIterator getIndexIterator()
                               throws JasDBStorageException

Description copied from interface: Index

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

Specified by:

getIndexIterator in interface Index

Returns:

The index iterator

Throws:

JasDBStorageException - If unable to open the index iterator

insertIntoIndex

public void insertIntoIndex(Key key)
                     throws JasDBStorageException

Description copied from interface: Index

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

Specified by:

insertIntoIndex in interface Index

Parameters:

key - The key to be persisted to the index

Throws:

JasDBStorageException - If unable to persist the key in the index

removeFromIndex

public void removeFromIndex(Key key)
                     throws JasDBStorageException

Description copied from interface: Index

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.

Specified by:

removeFromIndex in interface Index

Parameters:

key - The key to be removed from the index

Throws:

JasDBStorageException - If unable to remove the key from the index

updateKey

public void updateKey(Key oldKey,
                      Key newKey)
               throws JasDBStorageException

Description copied from interface: Index

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

Specified by:

updateKey in interface Index

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

public void openIndex()
               throws JasDBStorageException

Description copied from interface: Index

Opens the index and its resources

Specified by:

openIndex in interface Index

Throws:

JasDBStorageException

close

public void close()
           throws JasDBStorageException

Description copied from interface: Index

Close the index and all its used resources

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Index

Throws:

JasDBStorageException - If unable to cleanly close the index

removeIndex

public void removeIndex()
                 throws JasDBStorageException

Description copied from interface: Index

Removes the index and all used resources

Specified by:

removeIndex in interface Index

Throws:

JasDBStorageException - If unable to delete the index

flushIndex

public void flushIndex()
                throws JasDBStorageException

Description copied from interface: Index

This persists the changes to the disk backing of the index

Specified by:

flushIndex in interface Index

Throws:

JasDBStorageException - If unable to flush the changes

scan

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

Description copied from interface: Index

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.

Specified by:

scan in interface Index

Parameters:

intent - The scanning intent, rescan or report

indexableItems - 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

rebuildIndex

public void rebuildIndex(Iterator<IndexableItem> indexableItems)
                  throws JasDBStorageException

Description copied from interface: Index

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

Specified by:

rebuildIndex in interface Index

Parameters:

indexableItems - The items to be indexed

Throws:

JasDBStorageException - If unable to rebuild the index

resetIndex

public void resetIndex()
                throws JasDBStorageException

Throws:

JasDBStorageException

getMemoryManager

public MemoryAware getMemoryManager()
                             throws JasDBStorageException

Description copied from interface: Index

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

Specified by:

getMemoryManager in interface Index

Returns:

THe memory manager used by this index

Throws:

JasDBStorageException

getState

public IndexState getState()

Description copied from interface: Index

Returns the state of the index

Specified by:

getState in interface Index

Returns:

The state of index

toString

public String toString()

Overrides:

toString in class Object