Package com.semedy.reasoner.symboltable

Class SymbolTableRAM

java.lang.Object

com.semedy.reasoner.symboltable.AbstractSymbolTable

com.semedy.reasoner.symboltable.SymbolTableRAM

All Implemented Interfaces:

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

public class SymbolTableRAM
extends AbstractSymbolTable
implements SymbolTable

provides all functionality for handling a symbol table in main memory

Field Summary

Fields

Modifier and Type	Field	Description
final String	FUNCTIONSFILENAME	file names to store symbol table
final String	SYMBOLSFILENAME

Constructor Summary

Constructors

Constructor	Description
SymbolTableRAM(ExternalDataTypeProvider datatypes, boolean directencoding, int termlength)
SymbolTableRAM(ExternalDataTypeProvider datatypes, boolean directencoding, int termlength, boolean notify)
SymbolTableRAM(ExternalDataTypeProvider datatypes, boolean directencoding, String edbDir, String logDir, int termlength, boolean notify)

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
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 external data types
final long	getFunctionCode(long[] buffer)	get function code
long[]	getFunctionEncoding(long code)	get the encoding of a function code, if it is there
String	getSymbolTableFileName()
final Function	getValueFunction(long code)	Produce a value from the code of an internal constant.
final Object	getValueSymbol(long code)	Produce a value from the code of an internal constant.
boolean	hasIndices()	are there any indices attached to symbol table?
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	loadSymbolTable()	load a symbol table from file system
void	removeAllSymbolTableIndexes()	removes all symbol table indexes.
void	removeNotInternalized(long code)	remove a non internalized term from symbol table
void	removeSymbolTableIndex(SymbolTableIndex index)	removes the given symbol table index.
void	resetTransaction()	reset transaction
void	rollback()	rollback transaction
void	setBulkMode(boolean b)	for loading into an empty symbol table bulk mode should be used
long	size()	returns the number of symbols in the symbol table
void	storeSymbolTable()	store symbol table on disk
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, getValue, 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, toString, 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, getValue, matchArguments, notifySymbolAdded, recreateSymbolTableIndexes, refreshSearchIndexes, substitute, substitute, substituteArguments, unify, unify

Field Details

FUNCTIONSFILENAME

public final String FUNCTIONSFILENAME

file names to store symbol table

See Also:

• Constant Field Values

SYMBOLSFILENAME

public final String SYMBOLSFILENAME

See Also:

• Constant Field Values

Constructor Details

SymbolTableRAM

public SymbolTableRAM(ExternalDataTypeProvider datatypes,
 boolean directencoding,
 String edbDir,
 String logDir,
 int termlength,
 boolean notify)

SymbolTableRAM

public SymbolTableRAM(ExternalDataTypeProvider datatypes,
 boolean directencoding,
 int termlength,
 boolean notify)

SymbolTableRAM

public SymbolTableRAM(ExternalDataTypeProvider datatypes,
 boolean directencoding,
 int termlength)

Method Details

getExternalDataTypes

public ExternalDataTypeProvider getExternalDataTypes()

get the external data types

Specified by:

getExternalDataTypes in interface SymbolTable

Returns:

createFunctionCode

public final long createFunctionCode(long[] buffer,
 Function f)

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

getFunctionCode

public final long getFunctionCode(long[] buffer)

Description copied from class: AbstractSymbolTable

get function code

Specified by:

getFunctionCode in interface SymbolTable

Specified by:

getFunctionCode in class AbstractSymbolTable

Parameters:

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

Returns:

code for whole function

getFunctionEncoding

public long[] getFunctionEncoding(long code)

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

getValueFunction

public final Function getValueFunction(long code)
                                throws SemReasonerException,
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:

getValueFunction in interface SymbolTable

Specified by:

getValueFunction in class AbstractSymbolTable

Parameters:

code - , the code of the internal term

Returns:

Throws:

IOException

SemReasonerException

getValueSymbol

public final Object getValueSymbol(long code)
                            throws SymboltableException

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:

getValueSymbol in interface SymbolTable

Specified by:

getValueSymbol in class AbstractSymbolTable

Parameters:

code - , the code of the internal term

Returns:

Throws:

SymboltableException

storeSymbolTable

public void storeSymbolTable()
                      throws SymboltableException

store symbol table on disk

Throws:

SymboltableException

getSymbolTableFileName

public String getSymbolTableFileName()

loadSymbolTable

public void loadSymbolTable()
                     throws SymboltableException

load a symbol table from file system

Throws:

SymboltableException

clear

public void clear()

Description copied from interface: SymbolTable

remove all symbols

Specified by:

clear in interface SymbolTable

delete

public void delete()

Description copied from interface: SymbolTable

delete all / release files

Specified by:

delete in interface SymbolTable

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

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 SymboltableException,
IOException

Description copied from interface: SymbolTable

commit last changes

Specified by:

transactionCommit in interface SymbolTable

Throws:

IOException

SymboltableException

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

hasIndices

public boolean hasIndices()

Description copied from interface: SymbolTable

are there any indices attached to symbol table?

Specified by:

hasIndices in interface SymbolTable

Returns:

flush

public void flush()
           throws IOException

Description copied from interface: SymbolTable

flushes symbol table.

Specified by:

flush in interface SymbolTable

Throws:

IOException

encodeNotInternalize

public long encodeNotInternalize(Object t)
                          throws IOException,
EDBException,
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

EDBException

removeNotInternalized

public void removeNotInternalized(long code)
                           throws IOException

Description copied from interface: SymbolTable

remove a non internalized term from symbol table

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

checkSanity

public boolean checkSanity(boolean shadow)
                    throws IOException

Description copied from interface: SymbolTable

check sanity

Specified by:

checkSanity in interface SymbolTable

Returns:

Throws:

IOException

lastModificationTime

public long lastModificationTime()

Description copied from interface: SymbolTable

returns the last time a modification took place

Specified by:

lastModificationTime in interface SymbolTable

Returns:

isEmpty

public boolean isEmpty()

Description copied from interface: SymbolTable

is symbol table empty (now symbols stored)

Specified by:

isEmpty in interface SymbolTable

Returns:

setBulkMode

public void setBulkMode(boolean b)
                 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

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

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: