Package com.semedy.reasoner.edb.persistentstore

Class PersistentSecondarySortedIndex

java.lang.Object

com.semedy.reasoner.edb.persistentstore.PersistentSecondarySortedIndex

All Implemented Interfaces:

Index, SortedIndex

public class PersistentSecondarySortedIndex
extends Object
implements SortedIndex

Container for a persistent sorted index

Author:

angele

Field Summary

Fields

Modifier and Type	Field	Description
BplusIndexLongs	_btree	the bplus tree for the index

Constructor Summary

Constructors

Constructor	Description
PersistentSecondarySortedIndex(PersistentRelation persistentTuples, BPlusTree<long[],TupleBuffer> btreelong, FileName name, boolean compress)
PersistentSecondarySortedIndex(PersistentRelation persistentTuples, BPlusTree<long[],TupleBuffer> btreelong, FileName name, int[] indexedpositions, boolean compress)
PersistentSecondarySortedIndex(PersistentRelation persistentTuples, FileName name, boolean compress)
PersistentSecondarySortedIndex(PersistentRelation persistentTuples, FileName filename, String filepath, boolean compress)

Method Summary

Modifier and Type	Method	Description
void	addTuple(long[] buffer)
void	addTuple(TupleBuffer buffer)
boolean	checkSanity(String message, boolean shadow)	check sanity of index
void	clear()	clear index
void	close()	close the index file
boolean	containsTuple(long[] values)	returns true if there exist matching values
boolean	containsTuple(TupleBuffer values)	returns true if there exist matching values
void	createIndex(String logDir)
void	delete()	delete the index file
SelectableIndexEnumerator	elements()
void	flush()	flush the index file
int[]	getIndexedPositions()	Returns the indexed positions
long	getNumberOfMatchingTuples(long[] values)	returns the number of matching tuples
SortedIndexEnumerator	indexedValues()	Return an iterator for index values. Note not tuples are enumerated but index values in sorted order
SortedIndexEnumerator	indexedValues(TupleBufferComparator comp)	Return an iterator for index values.
boolean	isEmptyIndex()
boolean	isFullIndex()	is it a full index, i.e. all arguments are indexed
void	open()
void	removeTuple(long[] tuple)
void	removeTuple(TupleBuffer tuple)
boolean	replaceNotIndexedValues(long[] oldTuple, long[] newTuple)	Modify tuple in index at non indexed positions.
boolean	replaceNotIndexedValues(TupleBuffer oldTuple, TupleBuffer newTuple)	Modify tuple in index at non indexed positions.
boolean	searchForRecord(long record)
TupleEnumerator	selectMatchingTuples(long[] values)	returns an enumerator for matching tuples
TupleEnumerator	selectMatchingTuples(long[] values, TupleEnumerator it)	returns an enumerator for matching tuples reuse tuple enumerator
TupleEnumerator	selectMatchingTuples(TupleBuffer values)	returns an enumerator for matching tuples
void	setPersistentRelation(PersistentRelation tuples)
long	size()	returns the number of indexed tuples
long	sizeInBytes()	return number of bytes used in main memory.
String	toString()
void	transactionBegin()
void	transactionCommit()
void	transactionRollback()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_btree

public BplusIndexLongs _btree

the bplus tree for the index

Constructor Details

PersistentSecondarySortedIndex

public PersistentSecondarySortedIndex(PersistentRelation persistentTuples,
 FileName name,
 boolean compress)

PersistentSecondarySortedIndex

public PersistentSecondarySortedIndex(PersistentRelation persistentTuples,
 BPlusTree<long[],TupleBuffer> btreelong,
 FileName name,
 int[] indexedpositions,
 boolean compress)

PersistentSecondarySortedIndex

public PersistentSecondarySortedIndex(PersistentRelation persistentTuples,
 BPlusTree<long[],TupleBuffer> btreelong,
 FileName name,
 boolean compress)

PersistentSecondarySortedIndex

public PersistentSecondarySortedIndex(PersistentRelation persistentTuples,
 FileName filename,
 String filepath,
 boolean compress)

Method Details

close

public void close()
           throws IOException,
EDBException

close the index file

Throws:

IOException

EDBException

checkSanity

public boolean checkSanity(String message,
 boolean shadow)
                    throws IOException

check sanity of index

Returns:

Throws:

IOException

flush

public void flush()
           throws IOException,
EDBException

flush the index file

Throws:

IOException

EDBException

sizeInBytes

public long sizeInBytes()

return number of bytes used in main memory. Used for cache management

Specified by:

sizeInBytes in interface Index

Returns:

searchForRecord

public boolean searchForRecord(long record)
                        throws IOException

Throws:

IOException

delete

public void delete()
            throws IOException

delete the index file

Throws:

IOException

isFullIndex

public boolean isFullIndex()

is it a full index, i.e. all arguments are indexed

Returns:

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()

clear index

open

public void open()
          throws IOException,
EDBException

Throws:

IOException

EDBException

createIndex

public void createIndex(String logDir)
                 throws IOException,
EDBException

Throws:

IOException

EDBException

transactionCommit

public void transactionCommit()
                       throws IOException,
EDBException

Throws:

IOException

EDBException

transactionRollback

public void transactionRollback()
                         throws IOException

Throws:

IOException

transactionBegin

public void transactionBegin()
                      throws IOException

Throws:

IOException

addTuple

public void addTuple(TupleBuffer buffer)
              throws IOException,
EDBException

Throws:

IOException

EDBException

addTuple

public void addTuple(long[] buffer)
              throws IOException,
EDBException

Throws:

IOException

EDBException

removeTuple

public void removeTuple(TupleBuffer tuple)
                 throws IOException,
EDBException

Throws:

IOException

EDBException

removeTuple

public void removeTuple(long[] tuple)
                 throws IOException,
EDBException

Throws:

IOException

EDBException

replaceNotIndexedValues

public boolean replaceNotIndexedValues(long[] oldTuple,
 long[] newTuple)
                                throws IOException,
EDBException

Modify tuple in index at non indexed positions.
Returns null if there is more than one tuple
matching the index positions.
If there is exactly one tuple it is modified
and the original tuple is returned.
If there is no matching tuple, the
tuple is added and the input tuple is returned.

Parameters:

oldTuple -

newTuple -

Returns:

Throws:

IOException

EDBException

replaceNotIndexedValues

public boolean replaceNotIndexedValues(TupleBuffer oldTuple,
 TupleBuffer newTuple)
                                throws IOException,
EDBException

Modify tuple in index at non indexed positions.
Returns null if there is more than one tuple
matching the index positions.
If there is exactly one tuple it is modified
and the original tuple is returned.
If there is no matching tuple, the
tuple is added and the input tuple is returned.

Parameters:

oldTuple -

newTuple -

Returns:

Throws:

IOException

EDBException

indexedValues

public SortedIndexEnumerator indexedValues()
                                    throws IOException

Description copied from interface: SortedIndex

Return an iterator for index values.
Note not tuples are enumerated but index values in sorted order

Specified by:

indexedValues in interface SortedIndex

Throws:

IOException

selectMatchingTuples

public TupleEnumerator selectMatchingTuples(long[] values)
                                     throws IOException

Description copied from interface: Index

returns an enumerator for matching tuples

Specified by:

selectMatchingTuples in interface Index

Parameters:

values - , values for indexed positions

Returns:

enumerator for matching tuples

Throws:

IOException

selectMatchingTuples

public TupleEnumerator selectMatchingTuples(TupleBuffer values)
                                     throws IOException

Description copied from interface: Index

returns an enumerator for matching tuples

Specified by:

selectMatchingTuples in interface Index

Parameters:

values - , values for indexed positions

Returns:

enumerator for matching tuples

Throws:

IOException

containsTuple

public boolean containsTuple(long[] values)
                      throws IOException

Description copied from interface: Index

returns true if there exist matching values

Specified by:

containsTuple in interface Index

Parameters:

values - , values for indexed positions

Returns:

boolean, true if there exist matching values

Throws:

IOException

containsTuple

public boolean containsTuple(TupleBuffer values)
                      throws IOException

Description copied from interface: Index

returns true if there exist matching values

Specified by:

containsTuple in interface Index

Parameters:

values - , values for indexed positions

Returns:

boolean, true if there exist matching values

Throws:

IOException

selectMatchingTuples

public TupleEnumerator selectMatchingTuples(long[] values,
 TupleEnumerator it)
                                     throws IOException

Description copied from interface: Index

returns an enumerator for matching tuples reuse tuple enumerator

Specified by:

selectMatchingTuples in interface Index

Returns:

Throws:

IOException

getNumberOfMatchingTuples

public long getNumberOfMatchingTuples(long[] values)
                               throws IOException

Description copied from interface: Index

returns the number of matching tuples

Specified by:

getNumberOfMatchingTuples in interface Index

Parameters:

values - , values for indexed positions

Returns:

number of matching tuples

Throws:

IOException

getIndexedPositions

public int[] getIndexedPositions()

Description copied from interface: Index

Returns the indexed positions

Specified by:

getIndexedPositions in interface Index

Returns:

the indexed positions

indexedValues

public SortedIndexEnumerator indexedValues(TupleBufferComparator comp)
                                    throws IOException

Description copied from interface: SortedIndex

Return an iterator for index values.
Note not tuples are enumerated but index values in sorted order

Specified by:

indexedValues in interface SortedIndex

Throws:

IOException

elements

public SelectableIndexEnumerator elements()

size

public long size()

Description copied from interface: Index

returns the number of indexed tuples

Specified by:

size in interface Index

Returns:

setPersistentRelation

public void setPersistentRelation(PersistentRelation tuples)

isEmptyIndex

public boolean isEmptyIndex()