Package com.semedy.reasoner.symboltable

Class SymbolTableBplus

java.lang.Object

com.semedy.reasoner.symboltable.AbstractSymbolTable

com.semedy.reasoner.symboltable.SymbolTableBplus

All Implemented Interfaces:

SymbolTable, ReasoningSymbolTable, Closeable, AutoCloseable, Iterable<Object>

public class SymbolTableBplus
extends AbstractSymbolTable
implements SymbolTable, Closeable

Implements a persistent symbol table based on b+ trees

Author:

angele

Constructor Summary

Constructors

Constructor	Description
SymbolTableBplus(int index, ExternalDataTypeProvider dataTypes, boolean directencoding, String edbDir, String logDir, int termlength, boolean transactionLog, boolean compress)
SymbolTableBplus(ExternalDataTypeProvider dataTypes, boolean directencoding, String edbDir, String logDir, int termlength, boolean transactionLog, boolean compress)

Method Summary

Modifier and Type	Method	Description
void	addSymbolTableIndex(SymbolTableIndex index)	Adds an index to the symbol table.
boolean	checkSanity(boolean shadow)	check sanity
void	clear()	remove all symbols
void	close()	Close symbol table.
void	commit()	commit transaction
final long	createFunctionCode(long[] buffer, Function f)	create function code
final long	createFunctionCodeNotInternalize(long[] buffer, Function f)	create function code not internalized
void	delete()	delete all / release files
long	encodeNotInternalize(Object t)	Returns a code for an object but does not internalize the object.
long	encodeWOEncoding(Object t)	Internalize a value.
void	flush()	flushes symbol table.
ExternalDataTypeProvider	getExternalDataTypes()	get the provider for external data types
long	getFunctionCode(long[] t)	get function code
long[]	getFunctionEncoding(long code)	get the encoding of a function code, if it is there
SymbolCache	getFunctionsCache()
SymbolCache	getSymbolsCache()
Object	getValue(long code)	Produce a value from the code of an internal constant.
Function	getValueFunction(long code)	get function for symbol code
Object	getValueSymbol(long code)	get object for symbol code
boolean	hasIndices()	are there indices like text index, geo index
boolean	inTransaction()	is symbol table within a transaction
boolean	isBulkMode()	is symbol table in bulk mode
boolean	isCreatedDuringReasoning(long code)	indicated for a code, that the corresponding symbol has been created during reasoning
boolean	isEmpty()	is symbol table empty (now symbols stored)
SymbolTableIterator	iterator()	get an iterator for all symbols
long	lastModificationTime()	returns the last time a modification took place
void	removeAllSymbolTableIndexes()	removes all symbol table indexes.
void	removeNotInternalized(long code)	remove a non internalized term
void	removeSymbolTableIndex(SymbolTableIndex index)	removes the given symbol table index.
void	resetTransaction()	reset transaction
void	restore(String edbdir, String workdir, ExternalDataTypeProvider datatypes, boolean compress, int maxTermLength)
void	rollback()	rollback transaction
void	setBulkMode(boolean bulk)	for loading into an empty symbol table bulk mode should be used
long	size()	returns the number of symbols in the symbol table
String	toString()
void	transactionBegin()	begin a transaction.
void	transactionCommit()	commit last changes
void	transactionRollback()	abort last changes

Methods inherited from class com.semedy.reasoner.symboltable.AbstractSymbolTable

createNonGroundFunction, decodeNonGroundFunction, encode, getCode, getGeoIndex, getTextIndex, match, matchArguments, matchArguments, notifySymbolAdded, recreateSymbolTableIndexes, refreshSearchIndexes, semiSubstitute, substitute, substitute, substitute, substituteArguments, substituteArguments, substituteFunction, unifiable, unify, unify

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.semedy.reasoner.api.symboltable.SymbolTable

decodeNonGroundFunction, encode, getCode, getGeoIndex, getTextIndex, matchArguments, notifySymbolAdded, recreateSymbolTableIndexes, refreshSearchIndexes, substitute, substitute, substituteArguments, unify, unify

Constructor Details

SymbolTableBplus

public SymbolTableBplus(ExternalDataTypeProvider dataTypes,
 boolean directencoding,
 String edbDir,
 String logDir,
 int termlength,
 boolean transactionLog,
 boolean compress)
                 throws IOException,
EDBException

Throws:

IOException

EDBException

SymbolTableBplus

public SymbolTableBplus(int index,
 ExternalDataTypeProvider dataTypes,
 boolean directencoding,
 String edbDir,
 String logDir,
 int termlength,
 boolean transactionLog,
 boolean compress)
                 throws IOException,
EDBException

Throws:

IOException

EDBException

Method Details

lastModificationTime

public long lastModificationTime()

Description copied from interface: SymbolTable

returns the last time a modification took place

Specified by:

lastModificationTime in interface SymbolTable

Returns:

isBulkMode

public boolean isBulkMode()

Description copied from interface: SymbolTable

is symbol table in bulk mode

Specified by:

isBulkMode in interface SymbolTable

Returns:

resetTransaction

public void resetTransaction()

Description copied from interface: SymbolTable

reset transaction

Specified by:

resetTransaction in interface SymbolTable

inTransaction

public boolean inTransaction()

Description copied from interface: SymbolTable

is symbol table within a transaction

Specified by:

inTransaction in interface SymbolTable

Returns:

checkSanity

public boolean checkSanity(boolean shadow)
                    throws IOException

Description copied from interface: SymbolTable

check sanity

Specified by:

checkSanity in interface SymbolTable

Returns:

Throws:

IOException

getSymbolsCache

public SymbolCache getSymbolsCache()

getFunctionsCache

public SymbolCache getFunctionsCache()

getExternalDataTypes

public ExternalDataTypeProvider getExternalDataTypes()

Description copied from interface: SymbolTable

get the provider for external data types

Specified by:

getExternalDataTypes in interface SymbolTable

Returns:

encodeWOEncoding

public long encodeWOEncoding(Object t)
                      throws SemReasonerException,
IOException,
EDBException

Description copied from interface: SymbolTable

Internalize a value. All values are internalized,
i.e. for every different value there exists exactly one instance and thus
also exactly one code
Encoding is done without encoding characters in strings

Specified by:

encodeWOEncoding in interface SymbolTable

Parameters:

t - , the user term to be internalized

Returns:

code, the code of the term

Throws:

EDBException

IOException

SemReasonerException

encodeNotInternalize

public long encodeNotInternalize(Object t)
                          throws IOException,
SemReasonerException

Description copied from interface: SymbolTable

Returns a code for an object but does not internalize the object.
This means that there might be different codes
for the same object.

Specified by:

encodeNotInternalize in interface SymbolTable

Specified by:

encodeNotInternalize in class AbstractSymbolTable

Returns:

Throws:

IOException

SemReasonerException

createFunctionCode

public final long createFunctionCode(long[] buffer,
 Function f)
                              throws SymboltableException,
IOException,
EDBException

Description copied from class: AbstractSymbolTable

create function code

Specified by:

createFunctionCode in interface SymbolTable

Specified by:

createFunctionCode in class AbstractSymbolTable

Parameters:

buffer - , t[0] code of function symbol, t[1]..t[n] codes for n arguments

Returns:

code for whole function

Throws:

IOException

EDBException

SymboltableException

createFunctionCodeNotInternalize

public final long createFunctionCodeNotInternalize(long[] buffer,
 Function f)
                                            throws SymboltableException,
IOException

create function code not internalized

Parameters:

buffer -

f -

Returns:

Throws:

SymboltableException

IOException

getFunctionCode

public long getFunctionCode(long[] t)
                     throws SymboltableException,
IOException

Description copied from class: AbstractSymbolTable

get function code

Specified by:

getFunctionCode in interface SymbolTable

Specified by:

getFunctionCode in class AbstractSymbolTable

Parameters:

t - , t[0] code of function symbol, t[1]..t[n] codes for n arguments

Returns:

code for whole function

Throws:

IOException

SymboltableException

getFunctionEncoding

public long[] getFunctionEncoding(long code)
                           throws SymboltableException,
IOException

Description copied from class: AbstractSymbolTable

get the encoding of a function code, if it is there

Specified by:

getFunctionEncoding in interface SymbolTable

Specified by:

getFunctionEncoding in class AbstractSymbolTable

Parameters:

code - , the code of the function

Returns:

t[0] code of function symbol, t[1]..t[n] codes for n arguments

Throws:

IOException

SymboltableException

setBulkMode

public void setBulkMode(boolean bulk)
                 throws IOException,
EDBException

Description copied from interface: SymbolTable

for loading into an empty symbol table bulk mode should be used

Specified by:

setBulkMode in interface SymbolTable

Throws:

IOException

EDBException

clear

public void clear()
           throws SymboltableException,
IOException,
EDBException

Description copied from interface: SymbolTable

remove all symbols

Specified by:

clear in interface SymbolTable

Throws:

IOException

EDBException

SymboltableException

delete

public void delete()
            throws SymboltableException,
IOException

Description copied from interface: SymbolTable

delete all / release files

Specified by:

delete in interface SymbolTable

Throws:

IOException

SymboltableException

close

public void close()
           throws IOException

Description copied from interface: SymbolTable

Close symbol table. Must be called to correctly finalize symbol table

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SymbolTable

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from interface: SymbolTable

flushes symbol table.

Specified by:

flush in interface SymbolTable

Throws:

IOException

transactionBegin

public void transactionBegin()
                      throws SymboltableException,
IOException

Description copied from interface: SymbolTable

begin a transaction.

Specified by:

transactionBegin in interface SymbolTable

Throws:

IOException

SymboltableException

transactionRollback

public void transactionRollback()
                         throws SymboltableException,
IOException

Description copied from interface: SymbolTable

abort last changes

Specified by:

transactionRollback in interface SymbolTable

Throws:

IOException

SymboltableException

transactionCommit

public void transactionCommit()
                       throws SemReasonerException,
IOException

Description copied from interface: SymbolTable

commit last changes

Specified by:

transactionCommit in interface SymbolTable

Throws:

SemReasonerException - if an error occurs

IOException

restore

public void restore(String edbdir,
 String workdir,
 ExternalDataTypeProvider datatypes,
 boolean compress,
 int maxTermLength)
             throws SemReasonerException,
InterruptedException

Throws:

SemReasonerException

InterruptedException

isCreatedDuringReasoning

public boolean isCreatedDuringReasoning(long code)

Description copied from interface: ReasoningSymbolTable

indicated for a code, that the corresponding symbol has been created during reasoning

Specified by:

isCreatedDuringReasoning in interface ReasoningSymbolTable

Returns:

size

public long size()

Description copied from interface: SymbolTable

returns the number of symbols in the symbol table

Specified by:

size in interface SymbolTable

Returns:

iterator

public SymbolTableIterator iterator()

Description copied from interface: SymbolTable

get an iterator for all symbols

Specified by:

iterator in interface Iterable<Object>

Specified by:

iterator in interface SymbolTable

Returns:

an iterator over all symbols in this symbol table

addSymbolTableIndex

public void addSymbolTableIndex(SymbolTableIndex index)

Description copied from interface: SymbolTable

Adds an index to the symbol table.
Examples are the text index and the geo index.

Specified by:

addSymbolTableIndex in interface SymbolTable

Specified by:

addSymbolTableIndex in class AbstractSymbolTable

Parameters:

index - the index

removeSymbolTableIndex

public void removeSymbolTableIndex(SymbolTableIndex index)

Description copied from interface: SymbolTable

removes the given symbol table index.

Specified by:

removeSymbolTableIndex in interface SymbolTable

Specified by:

removeSymbolTableIndex in class AbstractSymbolTable

Parameters:

index - the index

removeAllSymbolTableIndexes

public void removeAllSymbolTableIndexes()

Description copied from interface: SymbolTable

removes all symbol table indexes.

Specified by:

removeAllSymbolTableIndexes in interface SymbolTable

Overrides:

removeAllSymbolTableIndexes in class AbstractSymbolTable

toString

public String toString()

Overrides:

toString in class Object

hasIndices

public boolean hasIndices()

are there indices like text index, geo index

Specified by:

hasIndices in interface SymbolTable

Returns:

removeNotInternalized

public void removeNotInternalized(long code)
                           throws IOException

remove a non internalized term

Specified by:

removeNotInternalized in interface SymbolTable

Throws:

IOException

commit

public void commit()
            throws EDBException,
IOException

Description copied from interface: SymbolTable

commit transaction

Specified by:

commit in interface SymbolTable

Throws:

EDBException

IOException

rollback

public void rollback()

Description copied from interface: SymbolTable

rollback transaction

Specified by:

rollback in interface SymbolTable

isEmpty

public boolean isEmpty()

Description copied from interface: SymbolTable

is symbol table empty (now symbols stored)

Specified by:

isEmpty in interface SymbolTable

Returns:

getValueSymbol

public Object getValueSymbol(long code)
                      throws SemReasonerException,
IOException

Description copied from class: AbstractSymbolTable

get object for symbol code

Specified by:

getValueSymbol in interface SymbolTable

Specified by:

getValueSymbol in class AbstractSymbolTable

Parameters:

code - , symbol code

Returns:

code for whole function

Throws:

IOException

SemReasonerException

getValueFunction

public Function getValueFunction(long code)
                          throws SemReasonerException,
IOException

Description copied from class: AbstractSymbolTable

get function for symbol code

Specified by:

getValueFunction in interface SymbolTable

Specified by:

getValueFunction in class AbstractSymbolTable

Parameters:

code - , symbol code

Returns:

code for whole function

Throws:

IOException

SemReasonerException

getValue

public Object getValue(long code)
                throws SymboltableException,
IOException

Produce a value from the code of an internal constant.
Should be used only for the call of builtins and for the final answer

Specified by:

getValue in interface SymbolTable

Overrides:

getValue in class AbstractSymbolTable

Parameters:

code - , the code of the internal term

Returns:

Throws:

SymboltableException

IOException