Package com.semedy.reasoner.edb.persistentstore

Class PersistentRelation

java.lang.Object

com.semedy.reasoner.edb.persistentstore.PersistentRelation

All Implemented Interfaces:

BaseRelation, Relation, Closeable, AutoCloseable

public class PersistentRelation
extends Object
implements BaseRelation, Relation, Closeable

Field Summary

Fields

Modifier and Type	Field	Description
static int	NODESIZE	the node size

Constructor Summary

Constructors

Constructor	Description
PersistentRelation(FileName filename, String workdir, String edbdir, String logDir, boolean compress)
PersistentRelation(FileName filename, String workdir, String edbdir, String logDir, boolean temporary, boolean compress)
PersistentRelation(FileName filename, String workdir, String edbdir, String logDir, boolean compress, long[] grounds)
PersistentRelation(FileName filename, String workdir, String edbdir, String logDir, TupleStore tupleStore, boolean temporary, boolean compress)

Method Summary

Modifier and Type	Method	Description
void	addIndex(PersistentSecondarySortedIndex I)
boolean	addTuple(int tuple)	add a tuple to the relation
boolean	addTuple(long[] tuple)	add a tuple to the relation
boolean	addTuple(TupleBuffer tuple)	add a tuple to the relation
void	blockClosingNDeleting()
void	bugLogMessage(String message)
void	checkNumbers(String message)
boolean	checkSanity(String message, boolean shadow)	check sanity of persistent relation
void	clear()	remove all tuples
void	close()	Close the relation.
void	closeBulkLoad(BulkLoadConsumer consume)
boolean	containsTuple(int tuple)	Is tuple contained in relation?
boolean	containsTuple(long[] tuple)	Is tuple contained in relation?
boolean	containsTuple(TupleBuffer tpl)	Is tuple contained in relation?
long	count()
void	create()
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
void	delete()	remove all tuples and release files
void	deSelect()	release ressources because relation is currently not used
TupleEnumerator	elements()	returns an enumerator for all tuples
TupleEnumerator	elements(long[] filter)	returns an filteres enumerator for all tuples
void	flush()	Flush the relation.
void	forceClose()	Force closing (instead of closing is blocked)
void	forceDelete()	Force deleting (instead of deleting is blocked)
int	getArity()	returns the arity of the relation
BulkLoadConsumer	getBulkLoadConsumer()
CacheInfo	getCacheInfo()	get the caching info
String	getDataFilePath()	get standard path for binary file
int	getDirectEncodedType(int i)	get the type of the direct encoded argument
String	getFilename()	returns the file name for the relation
FileName	getFileName()
long[]	getGrounds()	get ground arguments, which are ground in all tuples
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
com.semedy.reasoner.edb.persistentstore.PersistentRelation.IterativeLoadConsumer	getIterativeLoadConsumer()
long	getMaxValue(int argument)	returns the maximal value at that argument position
long	getMinValue(int argument)	returns the minimal value at that argument position
String	getName()	get a unique name of the relation
long	getNumberOfDifferentValues(int position)	Returns the number of different values at the argument positions.
long	getNumberOfDifferentValues(int position, long value)	Returns the number of values occurring at the argument positions Used for statistics
long	getNumberOfMatchingTuples(int[] arguments, long[] values)
long	getNumberOfTuples(int position, long term)
String	getPredicateSymbol()	returns the predicate symbol for the relation
BPlusTree<long[],TupleBuffer>	getPrimaryKey()
SortedIndex	getSortedIndex(int[] indexedpositions)	Get a sorted index given by the argument positions in indexed positions (if it already exists).
String	getTreeFilePath()
Object	getUniqueKey()
boolean	hasDuplicates()	may relation contain duplicates?
boolean	hasIndices()
boolean	hasSortedIndex(int[] indexedPositions)
boolean	isDirectEncoded(int i)	are all values at argument i direct encoded
boolean	isEmpty()	Is the relation empty?
long[]	isOverwrittenByTuple(long[] tuple)	returns tuple which is 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?
void	open()
long[]	overwriteTuple(long[] tuple)	Overwrite last argument of tuple.
TupleBuffer	overwriteTuple(TupleBuffer tuple)	Overwrite last argument of tuple.
void	readBinaryFromBackup(String filepath)	read tuples from a binary backup file
void	readBinaryRewrite(String datafilepath)	read binary tuple file into empty!
void	readTupleFile(String datafilepath)	read tuples from a file in binary form
void	registerListener(RelationListener listener)	register a listener for adding, removing, modifying tuples
boolean	removeTuple(int tuple)	remove a tuple from the relation
boolean	removeTuple(long[] tuple)	remove a tuple from the relation
boolean	removeTuple(TupleBuffer tuple)	remove a tuple from the relation
boolean	searchForRecord(long record)
void	select()	initialize
long	size()	returns the number of tuples in relation
long	sizeInBytes()	return number of bytes used in main memory.
void	subtractRelation(Relation R)
String	toString()
void	transactionBegin()	begin transaction
void	transactionCommit()	commit last changes
void	transactionRollback()	rbort last changes
void	union(BaseRelation R)	add all tuples of R to this
void	unionRelation(Relation R)
void	writeBinary()
void	writeBinary(String filepath)	write tuples in binary form to file
void	writeBinaryToBackup(String filepath)	write tuples to a binary backup file
void	writeBinaryWithGrounds(String filepath)	write complete tuples to a binary file

Methods inherited from class java.lang.Object

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

Field Details

NODESIZE

public static int NODESIZE

the node size

Constructor Details

PersistentRelation

public PersistentRelation(FileName filename,
 String workdir,
 String edbdir,
 String logDir,
 boolean compress,
 long[] grounds)

PersistentRelation

public PersistentRelation(FileName filename,
 String workdir,
 String edbdir,
 String logDir,
 boolean compress)

PersistentRelation

public PersistentRelation(FileName filename,
 String workdir,
 String edbdir,
 String logDir,
 boolean temporary,
 boolean compress)

PersistentRelation

public PersistentRelation(FileName filename,
 String workdir,
 String edbdir,
 String logDir,
 TupleStore tupleStore,
 boolean temporary,
 boolean compress)

Method Details

getName

public String getName()

Description copied from interface: Relation

get a unique name of the relation

Specified by:

getName in interface Relation

Returns:

getGrounds

public long[] getGrounds()

get ground arguments, which are ground in all tuples

Specified by:

getGrounds in interface Relation

Returns:

checkSanity

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

check sanity of persistent relation

Specified by:

checkSanity in interface Relation

shadow - , check in shadow tree

Returns:

Throws:

IOException

EDBException

count

public long count()
           throws IOException,
EDBException

Throws:

IOException

EDBException

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

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

getDataFilePath

public String getDataFilePath()

Description copied from interface: Relation

get standard path for binary file

Specified by:

getDataFilePath in interface Relation

Returns:

getTreeFilePath

public String getTreeFilePath()

getPrimaryKey

public BPlusTree<long[],TupleBuffer> getPrimaryKey()

getPredicateSymbol

public String getPredicateSymbol()

Description copied from interface: Relation

returns the predicate symbol for the relation

Specified by:

getPredicateSymbol in interface Relation

Returns:

getFilename

public String getFilename()

Description copied from interface: Relation

returns the file name for the relation

Specified by:

getFilename in interface Relation

Returns:

getFileName

public FileName getFileName()

create

public void create()
            throws IOException,
EDBException

Throws:

IOException

EDBException

open

public void open()
          throws IOException,
EDBException

Throws:

IOException

EDBException

readBinaryRewrite

public void readBinaryRewrite(String datafilepath)
                       throws IOException,
EDBException

read binary tuple file into empty! relation.
Rewrite tuple file to eliminate duplicates

Parameters:

datafilepath -

Throws:

IOException

EDBException

readTupleFile

public void readTupleFile(String datafilepath)
                   throws IOException,
EDBException

Description copied from interface: BaseRelation

read tuples from a file in binary form

Specified by:

readTupleFile in interface BaseRelation

Specified by:

readTupleFile in interface Relation

Parameters:

datafilepath - , the file path to read from

Throws:

IOException

EDBException

getBulkLoadConsumer

public BulkLoadConsumer getBulkLoadConsumer()
                                     throws IOException,
EDBException

Throws:

IOException

EDBException

closeBulkLoad

public void closeBulkLoad(BulkLoadConsumer consume)
                   throws IOException,
EDBException

Throws:

IOException

EDBException

getIterativeLoadConsumer

public com.semedy.reasoner.edb.persistentstore.PersistentRelation.IterativeLoadConsumer getIterativeLoadConsumer()
                                                                                                          throws EDBException,
IOException

Throws:

EDBException

IOException

close

public void close()
           throws IOException

Description copied from interface: BaseRelation

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BaseRelation

Specified by:

close in interface Closeable

Throws:

IOException

flush

public void flush()
           throws IOException,
EDBException

Description copied from interface: BaseRelation

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

Specified by:

flush in interface BaseRelation

Throws:

IOException

EDBException

delete

public void delete()
            throws IOException

Description copied from interface: Relation

remove all tuples and release files

Specified by:

delete in interface Relation

Throws:

IOException

forceClose

public void forceClose()
                throws IOException,
EDBException

Force closing (instead of closing is blocked)

Throws:

IOException

EDBException

forceDelete

public void forceDelete()
                 throws IOException

Force deleting (instead of deleting is blocked)

Throws:

IOException

blockClosingNDeleting

public void blockClosingNDeleting()

clear

public void clear()
           throws IOException,
EDBException

Description copied from interface: BaseRelation

remove all tuples

Specified by:

clear in interface BaseRelation

Throws:

IOException

EDBException

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

Specified by:

writeBinary in interface Relation

Throws:

IOException

EDBException

writeBinaryWithGrounds

public void writeBinaryWithGrounds(String filepath)
                            throws IOException,
EDBException

Description copied from interface: Relation

write complete tuples to a binary file

Specified by:

writeBinaryWithGrounds in interface Relation

Throws:

IOException

EDBException

writeBinaryToBackup

public void writeBinaryToBackup(String filepath)
                         throws IOException,
EDBException

Description copied from interface: Relation

write tuples to a binary backup file

Specified by:

writeBinaryToBackup in interface Relation

Throws:

IOException

EDBException

readBinaryFromBackup

public void readBinaryFromBackup(String filepath)
                          throws IOException,
EDBException

Description copied from interface: Relation

read tuples from a binary backup file

Specified by:

readBinaryFromBackup in interface Relation

Throws:

IOException

EDBException

addIndex

public void addIndex(PersistentSecondarySortedIndex I)

writeBinary

public void writeBinary()
                 throws IOException,
EDBException

Throws:

IOException

EDBException

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

checkNumbers

public void checkNumbers(String message)
                  throws EDBException,
IOException

Throws:

EDBException

IOException

transactionBegin

public void transactionBegin()
                      throws IOException,
EDBException

Description copied from interface: Relation

begin transaction

Specified by:

transactionBegin in interface Relation

Throws:

EDBException

IOException

transactionCommit

public void transactionCommit()
                       throws IOException,
EDBException

Description copied from interface: Relation

commit last changes

Specified by:

transactionCommit in interface Relation

Throws:

EDBException

IOException

transactionRollback

public void transactionRollback()
                         throws IOException,
EDBException

Description copied from interface: Relation

rbort last changes

Specified by:

transactionRollback in interface Relation

Throws:

EDBException

IOException

hasSortedIndex

public boolean hasSortedIndex(int[] indexedPositions)

getUniqueKey

public Object getUniqueKey()

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

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

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

getNumberOfDifferentValues

public long getNumberOfDifferentValues(int position)
                                throws IOException,
EDBException

Description copied from interface: Relation

Returns the number of different values at the argument positions.
Used for statistics.

Specified by:

getNumberOfDifferentValues in interface Relation

Parameters:

position - , argument position

Returns:

Throws:

EDBException

IOException

getNumberOfDifferentValues

public long getNumberOfDifferentValues(int position,
 long value)
                                throws IOException,
EDBException

Description copied from interface: Relation

Returns the number of values occurring at the argument positions
Used for statistics

Specified by:

getNumberOfDifferentValues in interface Relation

Parameters:

position - , argument position

value - , the concrete value

Returns:

Throws:

EDBException

IOException

getNumberOfMatchingTuples

public long getNumberOfMatchingTuples(int[] arguments,
 long[] values)
                               throws IOException,
EDBException

Throws:

IOException

EDBException

getNumberOfTuples

public long getNumberOfTuples(int position,
 long term)
                       throws IOException,
EDBException

Throws:

IOException

EDBException

removeTuple

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

Description copied from interface: BaseRelation

remove a tuple from the relation

Specified by:

removeTuple in interface BaseRelation

Parameters:

tuple - , tuple to be removed

Returns:

true, if tuple has been removed

Throws:

IOException

EDBException

overwriteTuple

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

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 -

Returns:

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

returns tuple which is overwritten by tuple

Specified by:

isOverwrittenByTuple in interface BaseRelation

Returns:

Throws:

IOException

removeTuple

public boolean removeTuple(TupleBuffer tuple)
                    throws IOException,
EDBException

Description copied from interface: BaseRelation

remove a tuple from the relation

Specified by:

removeTuple in interface BaseRelation

Parameters:

tuple - , tuple to be removed

Returns:

true, if tuple has been removed

Throws:

IOException

EDBException

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

containsTuple

public boolean containsTuple(TupleBuffer tpl)
                      throws IOException

Description copied from interface: BaseRelation

Is tuple contained in relation?

Specified by:

containsTuple in interface BaseRelation

Parameters:

tpl - to be checked

Returns:

tuple is contained

Throws:

IOException

searchForRecord

public boolean searchForRecord(long record)
                        throws IOException

Throws:

IOException

bugLogMessage

public void bugLogMessage(String message)
                   throws EDBException,
IOException

Throws:

EDBException

IOException

addTuple

public boolean addTuple(long[] tuple)
                 throws IOException,
EDBException

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

EDBException

addTuple

public boolean addTuple(TupleBuffer tuple)
                 throws IOException,
EDBException

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

EDBException

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

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(int tuple)
                 throws IOException,
EDBException

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

EDBException

removeTuple

public boolean removeTuple(int tuple)
                    throws IOException,
EDBException

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

Throws:

IOException

EDBException

toString

public String toString()

Overrides:

toString in class Object

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

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

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

select

public void select()
            throws IOException

Description copied from interface: BaseRelation

initialize

Specified by:

select in interface BaseRelation

Specified by:

select in interface Relation

Throws:

IOException

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

unionRelation

public void unionRelation(Relation R)
                   throws IOException,
EDBException

Throws:

IOException

EDBException

subtractRelation

public void subtractRelation(Relation R)
                      throws IOException,
EDBException

Throws:

IOException

EDBException

deSelect

public void deSelect()
              throws IOException

Description copied from interface: Relation

release ressources because relation is currently not used

Specified by:

deSelect in interface Relation

Throws:

IOException

lastModificationTime

public long lastModificationTime()

Description copied from interface: BaseRelation

returns the time of last modification

Specified by:

lastModificationTime in interface BaseRelation

Specified by:

lastModificationTime in interface Relation

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:

hasIndices

public boolean hasIndices()

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

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

hasDuplicates

public boolean hasDuplicates()

Description copied from interface: BaseRelation

may relation contain duplicates?

Specified by:

hasDuplicates in interface BaseRelation

Returns:

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