Package com.semedy.reasoner.reasoning.processes

Class ReasoningSymbolTableNotInternalize

java.lang.Object

com.semedy.reasoner.reasoning.processes.ReasoningSymbolTableNotInternalize

All Implemented Interfaces:

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

public class ReasoningSymbolTableNotInternalize
extends Object
implements ReasoningSymbolTable

Wrapper around a reasoning symbol table which does not internalize terms

Author:

angele

Constructor Summary

Constructors

Constructor	Description
ReasoningSymbolTableNotInternalize(ReasoningSymbolTable symbols)

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
long	createFunctionCode(long[] t, Function f)	create function code
Function	createNonGroundFunction(Function t)	Compile a non-ground user term into a non-ground internal term.
Function	decodeNonGroundFunction(Function t)	decompiles a ground internal function into an external function
void	delete()	delete all / release files
long	encode(Object t)	Internalize a value.
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.
long	getCode(Object t)	searches the code for a value returns 0 if term is not registered
ExternalDataTypeProvider	getExternalDataTypes()	get the provider for external data types
long	getFunctionCode(long[] t)	get function code
long[]	getFunctionEncoding(long code)	Returns the codes of the arguments of a function given by code
GeoIndex	getGeoIndex()	get geo index
TextIndex	getTextIndex()	get text index
Object	getValue(long code)	Produces a value from the code of an internal term.
Function	getValueFunction(long code)	Produces a value from the code of an internal function.
Object	getValueSymbol(long code)	Produces a value from the code of an internal term.
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)
Iterator<Object>	iterator()	get an iterator for all symbols
long	lastModificationTime()	returns the last time a modification took place
boolean	match(Object t, long groundterm, long[] substitutions)	Match returns for each variable v in t the symbol s v has to be substituted by.
boolean	matchArguments(Object t, long[] groundtermarguments, long[] substitutions)	Match returns for each variable v in t the symbol s v has to be substituted by to match the arguments of t with groundtermarguments.
boolean	matchArguments(Object t, TupleBuffer groundtermarguments, long[] substitutions)
void	notifySymbolAdded(Object symbol, long code)	add symbol to text indices
void	recreateSymbolTableIndexes()	recreates all symbol table indexes from scratch.
void	refreshSearchIndexes(boolean waitForPendingTasks)	refreshes the search indices, i.e. waits until they are up-to-date.
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	renameTerm(Object oldterm, Object newterm)
void	reOpen()
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
long	substitute(Object t, long[] substitutions)	substitutes the variables in an internal term by the codes found in substitutions, internalizes the resulting term and returns the code of the term Attention: do not use this method with same object t in several threads in parallel, it is NOT threadsafe!
Object	substitute(Object t, Object[] substitutions)	Substitutes the variables in a compound by the terms (non-ground) found in substitutions, internalizes the resulting terms and returns either the code of the term or a non-ground term.
Object	substitute(Object t, Map<Variable,Object> substitutions)
long[]	substituteArguments(Object t, long[] substitutions)	substitutes the variables in a compound t by the codes found in substitutions, internalizes the resulting terms and returns the arguments of t.
Object[]	substituteArguments(Object t, Object[] substitutions)	Substitutes the variables in a compound t by the terms (non-ground) in substitutions, internalizes the resulting terms and returns the arguments of t.
void	transactionBegin()	begin a transaction.
void	transactionCommit()	commit last changes
void	transactionRollback()	abort last changes
boolean	unifiable(Object t, Object f)	Unifiable returns whether two structures are unifiable This method is cheaper than unify as it delivers no result substitutions
boolean	unify(Object t, Object f, Map<Variable,Object> substitutions)	Unifies two structures (variables, terms, functions or literals).
boolean	unify(Object t, Object f, Map<Variable,Object> substitutions, Map<Variable,Set<Variable>> equivalentVariables)	Unifies two structures (variables, terms, functions or literals).

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

Constructor Details

ReasoningSymbolTableNotInternalize

public ReasoningSymbolTableNotInternalize(ReasoningSymbolTable symbols)

Method Details

getExternalDataTypes

public ExternalDataTypeProvider getExternalDataTypes()

Description copied from interface: SymbolTable

get the provider for external data types

Specified by:

getExternalDataTypes in interface SymbolTable

Returns:

iterator

public Iterator<Object> 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

encode

public long encode(Object t)
            throws IOException,
SemReasonerException

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

Specified by:

encode in interface SymbolTable

Parameters:

t - , the user term to be internalized

Returns:

code, the code of the term

Throws:

IOException

EDBException

SemReasonerException

getCode

public long getCode(Object t)
             throws IOException,
SemReasonerException

Description copied from interface: SymbolTable

searches the code for a value returns 0 if term is not registered

Specified by:

getCode in interface SymbolTable

Returns:

Throws:

IOException

SemReasonerException

getValue

public Object getValue(long code)
                throws IOException,
SemReasonerException

Description copied from interface: SymbolTable

Produces a value from the code of an internal term.
Should be used only inside of built-ins and for generating the final answer.

Specified by:

getValue in interface SymbolTable

Parameters:

code - , the code of the internal term

Returns:

Throws:

IOException

SemReasonerException

renameTerm

public void renameTerm(Object oldterm,
 Object newterm)

clear

public void clear()
           throws SymboltableException,
IOException

Description copied from interface: SymbolTable

remove all symbols

Specified by:

clear in interface SymbolTable

Throws:

IOException

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

reOpen

public void reOpen()

transactionBegin

public void transactionBegin()
                      throws SymboltableException

Description copied from interface: SymbolTable

begin a transaction.

Specified by:

transactionBegin in interface SymbolTable

Throws:

SymboltableException

transactionRollback

public void transactionRollback()
                         throws SymboltableException

Description copied from interface: SymbolTable

abort last changes

Specified by:

transactionRollback in interface SymbolTable

Throws:

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

decodeNonGroundFunction

public Function decodeNonGroundFunction(Function t)
                                 throws SymboltableException,
IOException

Description copied from interface: SymbolTable

decompiles a ground internal function into an external function

Specified by:

decodeNonGroundFunction in interface SymbolTable

Parameters:

t - , the term

Returns:

Throws:

IOException

SymboltableException

substitute

public Object substitute(Object t,
 Object[] substitutions)
                  throws SymboltableException,
IOException

Description copied from interface: SymbolTable

Substitutes the variables in a compound by the terms (non-ground) found in substitutions,
internalizes the resulting terms and returns either the code of the term
or a non-ground term.
Attention: do not use this method with same object t in several threads in parallel,
it is NOT threadsafe! If you want to do that you have to create a
clone of t for every thread!

Specified by:

substitute in interface SymbolTable

Parameters:

t - , entity (Variable, Function, Long, Literal)

substitutions - , gives for variable with position p the substituted value substitutions[p]

Returns:

Throws:

IOException

SymboltableException

substitute

public Object substitute(Object t,
 Map<Variable,Object> substitutions)
                  throws SymboltableException,
IOException

Specified by:

substitute in interface SymbolTable

Throws:

SymboltableException

IOException

substituteArguments

public Object[] substituteArguments(Object t,
 Object[] substitutions)
                             throws SymboltableException,
IOException

Description copied from interface: SymbolTable

Substitutes the variables in a compound t by the terms (non-ground) in substitutions,
internalizes the resulting terms and returns the arguments of t.
for all variables a ground term has to be given in substitutions.
Attention: do not use this method with same object t in several threads in parallel,
it is NOT threadsafe! If you want to do that you have to create a
clone of t for every thread!

Specified by:

substituteArguments in interface SymbolTable

Parameters:

t - , entity (Variable, Function, Long, Literal)

substitutions - , gives for variable with position p the substituted value substitutions[p]

Returns:

Throws:

IOException

SymboltableException

unify

public boolean unify(Object t,
 Object f,
 Map<Variable,Object> substitutions,
 Map<Variable,Set<Variable>> equivalentVariables)
              throws SymboltableException,
IOException

Description copied from interface: SymbolTable

Unifies two structures (variables, terms, functions or literals). The structures have to be internalized (encoded).
Unify returns for each variable v in t the symbol s v has to be substituted by.
The result (substitutions) provides for each variable the substituted term.
In equivalentVariables the equivalence classes for variables are created
Attention: do not use this method with same objects t,f in several threads in parallel, it is NOT threadsafe!

Specified by:

unify in interface SymbolTable

Parameters:

t - , the first entity (Variable, Function, Long, Literal)

f - , the second entity (Variable, Function, Long, Literal)

substitutions - , substitutions of variables with functions or ground terms

equivalentVariables - , equivalence classes for variables

Returns:

true, if unify operation was successful

Throws:

IOException

SymboltableException

unify

public boolean unify(Object t,
 Object f,
 Map<Variable,Object> substitutions)
              throws SymboltableException,
IOException

Description copied from interface: SymbolTable

Unifies two structures (variables, terms, functions or literals). The structures have to be internalized (encoded).
Unify returns for each variable v in t the symbol s v has to be substituted by.
The result (substitutions) provides for each variable the substituted term.
In equivalentVariables the equivalence classes for variables are created
The equivalent variables are expressed as substitutions as well
Attention: do not use this method with same objects t,f in several threads in parallel, it is NOT threadsafe!

Specified by:

unify in interface SymbolTable

Parameters:

t - , the first entity (Variable, Function, Long, Literal)

f - , the second entity (Variable, Function, Long, Literal)

substitutions - , substitutions of variables with functions or ground terms

Returns:

true, if unify operation was successful

Throws:

IOException

SymboltableException

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:

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

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

Parameters:

index - the index

removeAllSymbolTableIndexes

public void removeAllSymbolTableIndexes()

Description copied from interface: SymbolTable

removes all symbol table indexes.

Specified by:

removeAllSymbolTableIndexes in interface SymbolTable

recreateSymbolTableIndexes

public void recreateSymbolTableIndexes()
                                throws SymboltableException,
IOException

Description copied from interface: SymbolTable

recreates all symbol table indexes from scratch.

Specified by:

recreateSymbolTableIndexes in interface SymbolTable

Throws:

IOException

SymboltableException

refreshSearchIndexes

public void refreshSearchIndexes(boolean waitForPendingTasks)

Description copied from interface: SymbolTable

refreshes the search indices, i.e. waits until they are up-to-date.

Specified by:

refreshSearchIndexes in interface SymbolTable

Parameters:

waitForPendingTasks - Wait until all pending tasks are finished, which may included tasks which are not related to index lookups. To do so might take a lot of time.

createNonGroundFunction

public Function createNonGroundFunction(Function t)
                                 throws SymboltableException,
IOException

Description copied from interface: ReasoningSymbolTable

Compile a non-ground user term into a non-ground internal term. This internal term is hidden. It should be used in the internal operations
created by a rule compiler. It must be used for matching operations and for substitution operations (see methods below)

Specified by:

createNonGroundFunction in interface ReasoningSymbolTable

Specified by:

createNonGroundFunction in interface SymbolTable

Parameters:

t - , the user term

Returns:

term (Function)

Throws:

IOException

SymboltableException

match

public boolean match(Object t,
 long groundterm,
 long[] substitutions)
              throws SymboltableException,
IOException

Description copied from interface: ReasoningSymbolTable

Match returns for each variable v in t the symbol s v has to be substituted by.
The result provides for variable position p the code of s.

Specified by:

match in interface ReasoningSymbolTable

Specified by:

match in interface SymbolTable

Parameters:

t - , the entity (Variable, Function, Long, Literal)

groundterm - , the code of the ground term

substitutions - , the substitutions substitutions[variable position] is substituted term for variable

Returns:

true, if match operation was successful

Throws:

IOException

SymboltableException

matchArguments

public boolean matchArguments(Object t,
 long[] groundtermarguments,
 long[] substitutions)
                       throws SymboltableException,
IOException

Description copied from interface: ReasoningSymbolTable

Match returns for each variable v in t the symbol s v has to be substituted by to match the arguments of t
with groundtermarguments. The result provides for variable position p the code of s

Specified by:

matchArguments in interface ReasoningSymbolTable

Specified by:

matchArguments in interface SymbolTable

Parameters:

t - , the entity (Variable, Function, Long, Literal)

groundtermarguments - , the codes of the arguments of the ground term

substitutions - , the substitutions substitutions[variable position] is substituted term for variable

Returns:

true, if match operation was successful

Throws:

IOException

SymboltableException

substitute

public long substitute(Object t,
 long[] substitutions)
                throws SymboltableException,
IOException

Description copied from interface: ReasoningSymbolTable

substitutes the variables in an internal term by the codes found in substitutions, internalizes the resulting term and returns the code of the term Attention: do not use this method with same object t in several threads in parallel, it is NOT threadsafe! If you want to do that you have to create a clone of t for every thread!

Specified by:

substitute in interface ReasoningSymbolTable

Specified by:

substitute in interface SymbolTable

Parameters:

t - , entity (Variable, Function, Long, Literal)

substitutions - , gives for variable with position p the substituted value substitutions[p]

Returns:

Throws:

IOException

SymboltableException

substituteArguments

public long[] substituteArguments(Object t,
 long[] substitutions)
                           throws SymboltableException,
IOException

Description copied from interface: ReasoningSymbolTable

substitutes the variables in a compound t by the codes found in substitutions, internalizes the resulting terms and returns the arguments of t. Attention: do not use this method with same object t in several threads in parallel, it is NOT threadsafe! If you want to do that you have to create a clone of t for every thread!

Specified by:

substituteArguments in interface ReasoningSymbolTable

Specified by:

substituteArguments in interface SymbolTable

Parameters:

t - , entity (Variable, Function, Long, Literal)

substitutions - , gives for variable with position p the substituted value substitutions[p]

Returns:

Throws:

IOException

SymboltableException

unifiable

public boolean unifiable(Object t,
 Object f)
                  throws SymboltableException,
IOException

Description copied from interface: ReasoningSymbolTable

Unifiable returns whether two structures are unifiable This method is cheaper than unify as it delivers no result substitutions

Specified by:

unifiable in interface ReasoningSymbolTable

Specified by:

unifiable in interface SymbolTable

Parameters:

t - , the first entity (Variable, Function, Long, Literal)

f - , the second entity (Variable, Function, Long, Literal)

Returns:

true, if unifiable operation was successful

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:

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

Returns:

Throws:

IOException

SemReasonerException

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

matchArguments

public boolean matchArguments(Object t,
 TupleBuffer groundtermarguments,
 long[] substitutions)
                       throws SymboltableException,
IOException

Specified by:

matchArguments in interface SymbolTable

Throws:

SymboltableException

IOException

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

notifySymbolAdded

public void notifySymbolAdded(Object symbol,
 long code)

Description copied from interface: SymbolTable

add symbol to text indices

Specified by:

notifySymbolAdded in interface SymbolTable

getFunctionEncoding

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

Description copied from interface: SymbolTable

Returns the codes of the arguments of a function given by code

Specified by:

getFunctionEncoding in interface SymbolTable

Parameters:

code - , the code of the function

Returns:

Throws:

IOException

SemReasonerException

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:

getTextIndex

public TextIndex getTextIndex()

Description copied from interface: SymbolTable

get text index

Specified by:

getTextIndex in interface SymbolTable

Returns:

getGeoIndex

public GeoIndex getGeoIndex()

Description copied from interface: SymbolTable

get geo index

Specified by:

getGeoIndex 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

getFunctionCode

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

Description copied from interface: SymbolTable

get function code

Specified by:

getFunctionCode in interface SymbolTable

Parameters:

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

Returns:

code for whole function

Throws:

SemReasonerException

IOException

createFunctionCode

public long createFunctionCode(long[] t,
 Function f)
                        throws SemReasonerException,
IOException,
EDBException

Description copied from interface: SymbolTable

create function code

Specified by:

createFunctionCode in interface SymbolTable

Parameters:

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

Returns:

code for whole function

Throws:

SemReasonerException

EDBException

IOException

getValueFunction

public Function getValueFunction(long code)
                          throws SemReasonerException,
IOException

Description copied from interface: SymbolTable

Produces a value from the code of an internal function.
Should be used only inside of built-ins and for generating the final answer.

Specified by:

getValueFunction in interface SymbolTable

Parameters:

code - , the code of the internal term

Returns:

Throws:

IOException

SemReasonerException

getValueSymbol

public Object getValueSymbol(long code)
                      throws SemReasonerException,
IOException

Description copied from interface: SymbolTable

Produces a value from the code of an internal term.
Should be used only inside of built-ins and for generating the final answer.

Specified by:

getValueSymbol in interface SymbolTable

Parameters:

code - , the code of the internal term

Returns:

Throws:

IOException

SemReasonerException

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: