org.jpc.engine.prolog

Interface PrologEngine

All Superinterfaces:

PrologDatabase

All Known Implementing Classes:

AbstractPrologEngine, JpcEngine, LogtalkEngine, PrologEngineProxy

public interface PrologEngine
extends PrologDatabase

An abstract interface for a Prolog engine session. Depending on the underlying driver library, multiple sessions can be spawned in the JVM (e.g., InterProlog), or only one (e.g., JPL).

Author:

sergioc

Method Summary

Modifier and Type	Method and Description
boolean	abolish(Term term)
boolean	allSucceed(List<? extends Term> terms)
LogtalkEngine	asLogtalkEngine()
boolean	asserta(List<? extends Term> terms) Assert a list of clauses in the logic database.
boolean	asserta(Term term) Assert a clause in the logic database.
boolean	assertz(List<? extends Term> terms) Assert a list of clauses in the logic database.
boolean	assertz(Term term) Assert a clause in the logic database.
Term	asTerm(String termString)
Term	asTerm(String termString, Jpc context)
List<Term>	asTerms(List<String> termsString)
List<Term>	asTerms(List<String> termsString, Jpc context)
Term	bagof(Term select, Term exp)
Query	bagof(Term select, Term exp, Term all)
Query	basicQuery(Term term, boolean errorHandledQuery, Jpc context)
boolean	cd(String path)
boolean	cd(Term path)
Query	clause(Term head, Term body)
void	close() Close the logic engine and free associated resources.
boolean	command(String command)
boolean	command(String command, Jpc context)
boolean	command(String command, List<?> arguments)
boolean	command(String command, List<?> arguments, Jpc context)
Query	currentOp(Term priority, Term specifier, Term operator)
String	currentPrologFlag(Flag flag)
Query	currentPrologFlag(Flag flag, String flagValue)
Query	currentPrologFlag(Term flag, Term flagValue)
boolean	ensureLoaded(List<? extends Term> terms)
boolean	ensureLoaded(String... resources)
boolean	ensureLoaded(Term... terms)
Term	findall(Term select, Term exp)
Query	findall(Term select, Term exp, Term all)
boolean	flushOutput()
Query	forall(Term generator, Term test)
OperatorsContext	getOperatorsContext()
boolean	isBinaryOperator(String op)
boolean	isCloseable()
boolean	isUnaryOperator(String op)
void	loadJpc()
void	loadJpcForLogtalk()
String	prologDialect()
Query	query(String goalString)
Query	query(String goalString, Jpc context)
Query	query(String goalString, List<?> arguments)
Query	query(String goalString, List<?> arguments, boolean errorHandledQuery, Jpc context)
Query	query(String goalString, List<?> arguments, Jpc context)
Query	query(Term goal)
Query	query(Term goal, Jpc context)
Query	query(Term goal, List<?> arguments, boolean errorHandledQuery, Jpc context)
Query	retract(Term term)
boolean	retractAll(Term term)
Term	setof(Term select, Term exp)
Query	setof(Term select, Term exp, Term all)
boolean	setPrologFlag(Flag flag, String flagValue)
boolean	setPrologFlag(Term flag, Term flagValue)
ThreadModel	threadModel()
Term	unify(List<? extends Term> terms)
Term	unify(Term... terms)
LogtalkEngine	withLogtalk()

Method Detail

close

void close()

Close the logic engine and free associated resources. Once the session is not required it can be closed. However, some drivers do not allow this and will throw an UnsupportedOperationException instead

isCloseable

boolean isCloseable()

Returns:

true if the Prolog engine can be closed (i.e., its resources can be freed). false otherwise.

threadModel

ThreadModel threadModel()

Returns:

the thread model of the Prolog engine. This specifies if the engine can manage or not concurrent requests.

command

boolean command(String command)

command

boolean command(String command,
                List<?> arguments)

command

boolean command(String command,
                Jpc context)

command

boolean command(String command,
                List<?> arguments,
                Jpc context)

query

Query query(String goalString)

query

Query query(String goalString,
            List<?> arguments)

query

Query query(String goalString,
            Jpc context)

query

Query query(String goalString,
            List<?> arguments,
            Jpc context)

query

Query query(String goalString,
            List<?> arguments,
            boolean errorHandledQuery,
            Jpc context)

query

Query query(Term goal)

query

Query query(Term goal,
            Jpc context)

query

Query query(Term goal,
            List<?> arguments,
            boolean errorHandledQuery,
            Jpc context)

basicQuery

Query basicQuery(Term term,
                 boolean errorHandledQuery,
                 Jpc context)

Returns:

a non-instrumented query

asTerm

Term asTerm(String termString)

Parameters:

termString -

Returns:

the term representation of a String. Variable names should be preserved.

asTerm

Term asTerm(String termString,
            Jpc context)

asTerms

List<Term> asTerms(List<String> termsString)

asTerms

List<Term> asTerms(List<String> termsString,
                   Jpc context)

setPrologFlag

boolean setPrologFlag(Term flag,
                      Term flagValue)

setPrologFlag

boolean setPrologFlag(Flag flag,
                      String flagValue)

currentPrologFlag

Query currentPrologFlag(Term flag,
                        Term flagValue)

currentPrologFlag

Query currentPrologFlag(Flag flag,
                        String flagValue)

currentPrologFlag

String currentPrologFlag(Flag flag)

prologDialect

String prologDialect()

getOperatorsContext

OperatorsContext getOperatorsContext()

currentOp

Query currentOp(Term priority,
                Term specifier,
                Term operator)

isBinaryOperator

boolean isBinaryOperator(String op)

isUnaryOperator

boolean isUnaryOperator(String op)

cd

boolean cd(Term path)

cd

boolean cd(String path)

asserta

boolean asserta(Term term)

Description copied from interface: PrologDatabase

Assert a clause in the logic database. Term is asserted as the first fact or rule of the corresponding predicate.

Specified by:

asserta in interface PrologDatabase

Returns:

assertz

boolean assertz(Term term)

Description copied from interface: PrologDatabase

Assert a clause in the logic database. Term is asserted as the last fact or rule of the corresponding predicate.

Specified by:

assertz in interface PrologDatabase

Returns:

retract

Query retract(Term term)

Specified by:

retract in interface PrologDatabase

retractAll

boolean retractAll(Term term)

Specified by:

retractAll in interface PrologDatabase

abolish

boolean abolish(Term term)

Specified by:

abolish in interface PrologDatabase

clause

Query clause(Term head,
             Term body)

Specified by:

clause in interface PrologDatabase

asserta

boolean asserta(List<? extends Term> terms)

Assert a list of clauses in the logic database. Terms are asserted as the first facts or rules of the corresponding predicate.

Parameters:

terms - the terms to assert

Returns:

assertz

boolean assertz(List<? extends Term> terms)

Assert a list of clauses in the logic database. Term are asserted as the last facts or rules of the corresponding predicate.

Parameters:

terms - the terms to assert

Returns:

ensureLoaded

boolean ensureLoaded(List<? extends Term> terms)

ensureLoaded

boolean ensureLoaded(Term... terms)

ensureLoaded

boolean ensureLoaded(String... resources)

bagof

Query bagof(Term select,
            Term exp,
            Term all)

bagof

Term bagof(Term select,
           Term exp)

findall

Query findall(Term select,
              Term exp,
              Term all)

findall

Term findall(Term select,
             Term exp)

setof

Query setof(Term select,
            Term exp,
            Term all)

setof

Term setof(Term select,
           Term exp)

forall

Query forall(Term generator,
             Term test)

flushOutput

boolean flushOutput()

unify

Term unify(Term... terms)

unify

Term unify(List<? extends Term> terms)

allSucceed

boolean allSucceed(List<? extends Term> terms)

withLogtalk

LogtalkEngine withLogtalk()

asLogtalkEngine

LogtalkEngine asLogtalkEngine()

loadJpc

void loadJpc()

loadJpcForLogtalk

void loadJpcForLogtalk()