jTrolog.lib

Class Library

java.lang.Object

jTrolog.lib.Library

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BasicLibrary, BuiltIn, DCGLibrary, IOLibrary, ISOLibrary

public abstract class Library
extends Object
implements Serializable

This abstract class is the base class for developing built-in libraries, which can be dynamically loaded by prolog objects.

Each library can expose to engine:

• a theory (as a string assigned to theory field)
• primitives: methods whose signature is boolean|void|Term name_arity(BindingsTable bt, Term arg0, Term arg1, ...) is considered a built-in primitive provided by the library
• synonyms for primitives

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Prolog	engine prolog core which loaded the library

Constructor Summary

Constructors

Constructor and Description
Library()

Method Summary

Modifier and Type	Method and Description
void	dismiss() method invoked by prolog engine when library is going to be removed
String	getName()
String[]	getSynonym(String primitiveName) Defines a map for synonyms for primitives.
String	getTheory()
void	onSolveBegin(Term goal) method invoked when the engine is going to demonstrate a goal
void	onSolveEnd() method invoked when the engine has finished a demostration
void	setEngine(Prolog en)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

engine

protected Prolog engine

prolog core which loaded the library

Constructor Detail

Library

public Library()

Method Detail

getName

public String getName()

Returns:

the library name (Library class name is default)

getTheory

public String getTheory()

Returns:

the theory provided with the library (an empty theory is default).

getSynonym

public String[] getSynonym(String primitiveName)

Defines a map for synonyms for primitives. String primitive name = String[]{synonym name, another synonym name, ..}.

setEngine

public void setEngine(Prolog en)

dismiss

public void dismiss()

method invoked by prolog engine when library is going to be removed

onSolveBegin

public void onSolveBegin(Term goal)

method invoked when the engine is going to demonstrate a goal

onSolveEnd

public void onSolveEnd()

method invoked when the engine has finished a demostration