Package com.semedy.reasoner.api.edb

Interface Relation

All Superinterfaces:

BaseRelation

All Known Implementing Classes:

MainMemoryRelation, MainMemorySubRelation, MixedRelation, PersistentRelation, ReasoningMonitorRelation, RelationAdapter

public interface Relation
extends BaseRelation

A relation is a container for a set of tuples with same arity.
Tuples are tuples of longs, which are links into the symbol table.

Author:

angele

Method Summary

Modifier and Type	Method	Description
boolean	checkSanity(String message, boolean shadow)	check the sanity of a relation
void	delete()	remove all tuples and release files
void	deSelect()	release ressources because relation is currently not used
String	getDataFilePath()	get standard path for binary file
String	getFilename()	returns the file name for the relation
long[]	getGrounds()	get the grounds
String	getName()	get a unique name of the relation
long	getNumberOfDifferentValues(int argument)	Returns the number of different values at the argument positions.
long	getNumberOfDifferentValues(int argument, long value)	Returns the number of values occurring at the argument positions Used for statistics
String	getPredicateSymbol()	returns the predicate symbol for the relation
long	lastModificationTime()	last modification time
void	readBinaryFromBackup(String filepath)	read tuples from a binary backup file
void	readTupleFile(String filepath)	read tuples from a (compressed) binary file
void	select()	initialize it before using it
void	transactionBegin()	begin transaction
void	transactionCommit()	commit last changes
void	transactionRollback()	rbort last changes
void	writeBinary(String filepath)	write tuples to a binary 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 interface com.semedy.reasoner.api.edb.BaseRelation

addTuple, addTuple, addTuple, clear, close, containsTuple, containsTuple, containsTuple, createIndex, createSortedIndex, elements, elements, flush, getArity, getCacheInfo, getDirectEncodedType, getIdentifier, getIndex, getInputBuffer, getInternalArity, getMaxValue, getMinValue, getSortedIndex, hasDuplicates, isDirectEncoded, isEmpty, isOverwrittenByTuple, isPersistent, isTemporary, mayContainDuplicates, overwriteTuple, overwriteTuple, registerListener, removeTuple, removeTuple, removeTuple, size, sizeInBytes, union

Method Details

getName

String getName()

get a unique name of the relation

Returns:

getNumberOfDifferentValues

long getNumberOfDifferentValues(int argument)
                         throws IOException,
EDBException

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

Parameters:

argument - , argument position

Returns:

Throws:

EDBException

IOException

getNumberOfDifferentValues

long getNumberOfDifferentValues(int argument,
 long value)
                         throws IOException,
EDBException

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

Parameters:

argument - , argument position

value - , the concrete value

Returns:

Throws:

EDBException

IOException

delete

void delete()
     throws IOException

remove all tuples and release files

Throws:

IOException

writeBinary

void writeBinary(String filepath)
          throws IOException,
EDBException

write tuples to a binary file

Specified by:

writeBinary in interface BaseRelation

Parameters:

filepath -

Throws:

IOException

EDBException

writeBinaryWithGrounds

void writeBinaryWithGrounds(String filepath)
                     throws IOException,
EDBException

write complete tuples to a binary file

Parameters:

filepath -

Throws:

IOException

EDBException

writeBinaryToBackup

void writeBinaryToBackup(String filepath)
                  throws IOException,
EDBException

write tuples to a binary backup file

Parameters:

filepath -

Throws:

IOException

EDBException

readBinaryFromBackup

void readBinaryFromBackup(String filepath)
                   throws IOException,
EDBException

read tuples from a binary backup file

Parameters:

filepath -

Throws:

IOException

EDBException

readTupleFile

void readTupleFile(String filepath)
            throws IOException,
EDBException

read tuples from a (compressed) binary file

Specified by:

readTupleFile in interface BaseRelation

Parameters:

filepath -

Throws:

IOException

EDBException

getDataFilePath

String getDataFilePath()

get standard path for binary file

Returns:

select

void select()
     throws IOException,
EDBException

initialize it before using it

Specified by:

select in interface BaseRelation

Throws:

EDBException

IOException

deSelect

void deSelect()
       throws IOException

release ressources because relation is currently not used

Throws:

IOException

getPredicateSymbol

String getPredicateSymbol()

returns the predicate symbol for the relation

Returns:

getFilename

String getFilename()

returns the file name for the relation

Returns:

transactionRollback

void transactionRollback()
                  throws IOException,
EDBException

rbort last changes

Throws:

EDBException

IOException

transactionCommit

void transactionCommit()
                throws IOException,
EDBException

commit last changes

Throws:

EDBException

IOException

transactionBegin

void transactionBegin()
               throws IOException,
EDBException

begin transaction

Throws:

EDBException

IOException

lastModificationTime

long lastModificationTime()

last modification time

Specified by:

lastModificationTime in interface BaseRelation

Returns:

time of last modification

checkSanity

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

check the sanity of a relation

Parameters:

message -

shadow - , check in shadow tree

Throws:

IOException

EDBException

getGrounds

long[] getGrounds()

get the grounds

Returns: