Package com.semedy.reasoner.edb.ramstore

Class MainMemoryBaseRelation

java.lang.Object

com.semedy.reasoner.edb.ramstore.MainMemoryBaseRelation

All Implemented Interfaces:

BaseRelation

public class MainMemoryBaseRelation
extends Object
implements BaseRelation

Constructor Summary

Constructors

Constructor	Description
MainMemoryBaseRelation(int arity, TupleStore tupleStore)
MainMemoryBaseRelation(int arity, TupleStore tupleStore, boolean duplicates, ReasoningMonitor monitor)
MainMemoryBaseRelation(int arity, TupleStore tupleStore, boolean duplicates, ReasoningMonitor monitor, boolean sorted)
MainMemoryBaseRelation(int arity, TupleStore tupleStore, MainMemoryIndex primarykey, ReasoningMonitor monitor)

Method Summary

Modifier and Type	Method	Description
boolean	addTuple(int tuple)	add a tuple to the relation
boolean	addTuple(long[] t)	add a tuple to the relation
boolean	addTuple(TupleBuffer terms)	add a tuple to the relation
void	clear()	remove all tuples
void	close()	Close the relation.
boolean	containsTuple(int tuple)	Is tuple contained in relation?
boolean	containsTuple(long[] tuple)	Is tuple contained in relation?
boolean	containsTuple(TupleBuffer tuple)	Is tuple contained in relation?
Index	createIndex(int[] indexedPositions)	Get or create a simple (not sorted index) by the argument positions in indexed positions.
SortedIndex	createSortedIndex(int[] indexedPositions)	ret or create a sorted index given by the argument positions in indexed positions
TupleEnumerator	elements()	returns an enumerator for all tuples
TupleEnumerator	elements(long[] filter)	returns an filteres enumerator for all tuples
void	flush()	Flush the relation.
int	getArity()	returns the arity of the relation
CacheInfo	getCacheInfo()	get the caching info
BigInteger	getChecksum()	get checksum of 0th argument
int	getDirectEncodedType(int i)	get the type of the direct encoded argument
String	getIdentifier()	returns a unique identifier for the relation
Index	getIndex(int[] indexedPositions)	Get an index given by the argument positions in indexed positions (if it already exists).
TupleStore	getInputBuffer()	get an input buffer for relation
int	getInternalArity()	returns the internal arity of tuples
long	getMaxValue(int argument)	returns the maximal value at that argument position
long	getMinValue(int argument)	returns the minimal value at that argument position
SortedIndex	getSortedIndex(int[] indexedPositions)	Get a sorted index given by the argument positions in indexed positions (if it already exists).
boolean	hasDuplicates()	may relation contain duplicates?
boolean	hasIndices()
boolean	isDirectEncoded(int i)	are all values at argument i direct encoded
boolean	isEmpty()	Is the relation empty?
long[]	isOverwrittenByTuple(long[] tuple)	returns the tuple which will be overwritten by tuple.
boolean	isPersistent()	Is the relation persistent?
boolean	isTemporary()	Is the relation temporary only?
long	lastModificationTime()	returns the time of last modification
boolean	mayContainDuplicates()	Might there be duplicates?
long[]	overwriteTuple(long[] tuple)	Overwrite last argument of tuple.
TupleBuffer	overwriteTuple(TupleBuffer tuple)	Overwrite last argument of tuple.
void	readTupleFile(String filepath)	read tuples from a file in binary form
void	registerListener(RelationListener listener)	register a listener for adding, removing, modifying tuples
void	removeAllIndices()
boolean	removeTuple(int tuple)	remove a tuple from the relation
boolean	removeTuple(long[] terms)	remove a tuple from the relation
boolean	removeTuple(TupleBuffer terms)	remove a tuple from the relation
void	select()	initialize
long	size()	returns the number of tuples in relation
long	sizeInBytes()	return number of bytes used in main memory.
String	toString()
void	union(BaseRelation R)	add all tuples of R to this
void	writeBinary(String filepath)	write tuples in binary form to file

Methods inherited from class java.lang.Object

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

Constructor Details

MainMemoryBaseRelation

public MainMemoryBaseRelation(int arity,
 TupleStore tupleStore,
 boolean duplicates,
 ReasoningMonitor monitor)

MainMemoryBaseRelation

public MainMemoryBaseRelation(int arity,
 TupleStore tupleStore)

MainMemoryBaseRelation

public MainMemoryBaseRelation(int arity,
 TupleStore tupleStore,
 boolean duplicates,
 ReasoningMonitor monitor,
 boolean sorted)

MainMemoryBaseRelation

public MainMemoryBaseRelation(int arity,
 TupleStore tupleStore,
 MainMemoryIndex primarykey,
 ReasoningMonitor monitor)

Method Details

getChecksum

public BigInteger getChecksum()

get checksum of 0th argument

Returns:

sizeInBytes

public long sizeInBytes()

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

Specified by:

sizeInBytes in interface BaseRelation

Returns:

approximate number of size in bytes

getMinValue

public long getMinValue(int argument)
                 throws IOException

Description copied from interface: BaseRelation

returns the minimal value at that argument position

Specified by:

getMinValue in interface BaseRelation

Parameters:

argument - , argument position @return, minimal value

Throws:

IOException

getMaxValue

public long getMaxValue(int argument)
                 throws IOException

Description copied from interface: BaseRelation

returns the maximal value at that argument position

Specified by:

getMaxValue in interface BaseRelation

Parameters:

argument - , argument position

Returns:

max value at argument position

Throws:

IOException

hasDuplicates

public boolean hasDuplicates()

Description copied from interface: BaseRelation

may relation contain duplicates?

Specified by:

hasDuplicates in interface BaseRelation

Returns:

getArity

public int getArity()

Description copied from interface: BaseRelation

returns the arity of the relation

Specified by:

getArity in interface BaseRelation

Returns:

arity of relation

elements

public TupleEnumerator elements()
                         throws IOException

Description copied from interface: BaseRelation

returns an enumerator for all tuples

Specified by:

elements in interface BaseRelation

Returns:

returns enumerator for tuples

Throws:

IOException

writeBinary

public void writeBinary(String filepath)
                 throws IOException,
EDBException

Description copied from interface: BaseRelation

write tuples in binary form to file

Specified by:

writeBinary in interface BaseRelation

Throws:

IOException

EDBException

readTupleFile

public void readTupleFile(String filepath)
                   throws IOException,
EDBException

Description copied from interface: BaseRelation

read tuples from a file in binary form

Specified by:

readTupleFile in interface BaseRelation

Parameters:

filepath - , the file path to read from

Throws:

IOException

EDBException

size

public long size()

Description copied from interface: BaseRelation

returns the number of tuples in relation

Specified by:

size in interface BaseRelation

Returns:

number of tuples in relation

createSortedIndex

public SortedIndex createSortedIndex(int[] indexedPositions)
                              throws IOException,
EDBException

Description copied from interface: BaseRelation

ret or create a sorted index given by the argument positions in indexed positions

Specified by:

createSortedIndex in interface BaseRelation

Returns:

Throws:

IOException

EDBException

createIndex

public Index createIndex(int[] indexedPositions)
                  throws IOException,
EDBException

Description copied from interface: BaseRelation

Get or create a simple (not sorted index) by the argument positions in indexed positions.

Specified by:

createIndex in interface BaseRelation

Parameters:

indexedPositions - , positions which are indexed

Returns:

index

Throws:

IOException

EDBException

getIndex

public Index getIndex(int[] indexedPositions)

Description copied from interface: BaseRelation

Get an index given by the argument positions in indexed positions (if it already exists).
Returns null if it does not exist.

Specified by:

getIndex in interface BaseRelation

Parameters:

indexedPositions - the indexed positions

Returns:

the corresponding index or null if none is available

getSortedIndex

public SortedIndex getSortedIndex(int[] indexedPositions)

Description copied from interface: BaseRelation

Get a sorted index given by the argument positions in indexed positions (if it already exists).
Returns null if it does not exist.

Specified by:

getSortedIndex in interface BaseRelation

Parameters:

indexedPositions - the indexed positions

Returns:

the corresponding index or null if none is available

addTuple

public boolean addTuple(long[] t)
                 throws IOException

Description copied from interface: BaseRelation

add a tuple to the relation

Specified by:

addTuple in interface BaseRelation

Parameters:

t - the tuple to add

Returns:

tuple has been added

Throws:

IOException

addTuple

public boolean addTuple(TupleBuffer terms)
                 throws IOException

Description copied from interface: BaseRelation

add a tuple to the relation

Specified by:

addTuple in interface BaseRelation

Parameters:

terms - the tuple to add

Returns:

tuple has been added

Throws:

IOException

union

public void union(BaseRelation R)
           throws IOException,
EDBException

Description copied from interface: BaseRelation

add all tuples of R to this

Specified by:

union in interface BaseRelation

Throws:

IOException

EDBException

overwriteTuple

public long[] overwriteTuple(long[] tuple)
                      throws IOException,
EDBException

Description copied from interface: BaseRelation

Overwrite last argument of tuple.
First arguments are unique keys for tuple
Especially useful for triples [subject,predicate,object]
and object is changed

Specified by:

overwriteTuple in interface BaseRelation

Parameters:

tuple - , overwrite tuple

Returns:

the overwritten tuple

Throws:

IOException

EDBException

overwriteTuple

public TupleBuffer overwriteTuple(TupleBuffer tuple)
                           throws IOException,
EDBException

Description copied from interface: BaseRelation

Overwrite last argument of tuple.
First arguments are unique keys for tuple
Especially useful for triples [subject,predicate,object]
and object is changed

Specified by:

overwriteTuple in interface BaseRelation

Parameters:

tuple - , overwrite tuple

Returns:

the overwritten tuple

Throws:

IOException

EDBException

isOverwrittenByTuple

public long[] isOverwrittenByTuple(long[] tuple)
                            throws IOException,
EDBException

Description copied from interface: BaseRelation

returns the tuple which will be overwritten by tuple.

Specified by:

isOverwrittenByTuple in interface BaseRelation

Returns:

Throws:

IOException

EDBException

removeTuple

public boolean removeTuple(TupleBuffer terms)
                    throws IOException

Description copied from interface: BaseRelation

remove a tuple from the relation

Specified by:

removeTuple in interface BaseRelation

Parameters:

terms - , tuple to be removed

Returns:

true, if tuple has been removed

Throws:

IOException

removeTuple

public boolean removeTuple(long[] terms)
                    throws IOException

Description copied from interface: BaseRelation

remove a tuple from the relation

Specified by:

removeTuple in interface BaseRelation

Parameters:

terms - , tuple to be removed

Returns:

true, if tuple has been removed

Throws:

IOException

removeTuple

public boolean removeTuple(int tuple)

Description copied from interface: BaseRelation

remove a tuple from the relation

Specified by:

removeTuple in interface BaseRelation

Parameters:

tuple - , address of tuple in tuple store

Returns:

true, if tuple has been removed

addTuple

public boolean addTuple(int tuple)
                 throws IOException

Description copied from interface: BaseRelation

add a tuple to the relation

Specified by:

addTuple in interface BaseRelation

Parameters:

tuple - the tuple to add

Returns:

tuple has been added

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()
           throws IOException,
EDBException

Description copied from interface: BaseRelation

remove all tuples

Specified by:

clear in interface BaseRelation

Throws:

IOException

EDBException

isEmpty

public boolean isEmpty()
                throws IOException

Description copied from interface: BaseRelation

Is the relation empty?

Specified by:

isEmpty in interface BaseRelation

Returns:

relation is empty

Throws:

IOException

isPersistent

public boolean isPersistent()

Description copied from interface: BaseRelation

Is the relation persistent?

Specified by:

isPersistent in interface BaseRelation

Returns:

is the relation persistent

getCacheInfo

public CacheInfo getCacheInfo()

Description copied from interface: BaseRelation

get the caching info

Specified by:

getCacheInfo in interface BaseRelation

Returns:

object containing caching info

getInputBuffer

public TupleStore getInputBuffer()

Description copied from interface: BaseRelation

get an input buffer for relation

Specified by:

getInputBuffer in interface BaseRelation

Returns:

a tuple store which serves as buffer for input tuples

close

public void close()

Description copied from interface: BaseRelation

Close the relation. Must be called to finalize the relation correctly

Specified by:

close in interface BaseRelation

getIdentifier

public String getIdentifier()

Description copied from interface: BaseRelation

returns a unique identifier for the relation

Specified by:

getIdentifier in interface BaseRelation

Returns:

unique identifier for relation

lastModificationTime

public long lastModificationTime()

Description copied from interface: BaseRelation

returns the time of last modification

Specified by:

lastModificationTime in interface BaseRelation

Returns:

time of last modification

mayContainDuplicates

public boolean mayContainDuplicates()

Description copied from interface: BaseRelation

Might there be duplicates?

Specified by:

mayContainDuplicates in interface BaseRelation

Returns:

, might there be duplicates in relation

isDirectEncoded

public boolean isDirectEncoded(int i)

Description copied from interface: BaseRelation

are all values at argument i direct encoded

Specified by:

isDirectEncoded in interface BaseRelation

Parameters:

i - , argument index

Returns:

getDirectEncodedType

public int getDirectEncodedType(int i)

Description copied from interface: BaseRelation

get the type of the direct encoded argument

Specified by:

getDirectEncodedType in interface BaseRelation

Returns:

isTemporary

public boolean isTemporary()

Description copied from interface: BaseRelation

Is the relation temporary only?

Specified by:

isTemporary in interface BaseRelation

Returns:

is the relation persistent

containsTuple

public boolean containsTuple(TupleBuffer tuple)
                      throws IOException

Description copied from interface: BaseRelation

Is tuple contained in relation?

Specified by:

containsTuple in interface BaseRelation

Parameters:

tuple - to be checked

Returns:

tuple is contained

Throws:

IOException

containsTuple

public boolean containsTuple(long[] tuple)
                      throws IOException

Description copied from interface: BaseRelation

Is tuple contained in relation?

Specified by:

containsTuple in interface BaseRelation

Parameters:

tuple - to be checked

Returns:

tuple is contained

Throws:

IOException

containsTuple

public boolean containsTuple(int tuple)
                      throws IOException

Description copied from interface: BaseRelation

Is tuple contained in relation?

Specified by:

containsTuple in interface BaseRelation

Parameters:

tuple - to be checked

Returns:

tuple is contained

Throws:

IOException

flush

public void flush()

Description copied from interface: BaseRelation

Flush the relation. Must be called to finalize the relation correctly

Specified by:

flush in interface BaseRelation

hasIndices

public boolean hasIndices()

removeAllIndices

public void removeAllIndices()

registerListener

public void registerListener(RelationListener listener)

Description copied from interface: BaseRelation

register a listener for adding, removing, modifying tuples

Specified by:

registerListener in interface BaseRelation

getInternalArity

public int getInternalArity()

Description copied from interface: BaseRelation

returns the internal arity of tuples

Specified by:

getInternalArity in interface BaseRelation

Returns:

elements

public TupleEnumerator elements(long[] filter)
                         throws IOException,
EDBException

Description copied from interface: BaseRelation

returns an filteres enumerator for all tuples

Specified by:

elements in interface BaseRelation

Returns:

returns enumerator for tuples

Throws:

IOException

EDBException

select

public void select()

Description copied from interface: BaseRelation

initialize

Specified by:

select in interface BaseRelation