se.sics.jasper

Interface Prolog

All Known Implementing Classes:

SICStus

public interface Prolog

The class SICStus and an inner class in Jasper inherit from this interface. These methods should be used to call SICStus runtime in both multi threaded and single threaded mode. When using the Prolog-Java interface in single thread mode, the methods of this interface are preferred over the old methods of the class SICStus.

Method Summary

Modifier and Type	Method and Description
Term	consFunctor(java.lang.String functor, Term[] args) Creates a term initialized to a compound term.
Term	consList(Term head, Term tail) Creates a term initialized to a list with given head and tail.
se.sics.jasper.Server	getServer() For internal use by Jasper.
Term	listFromString(java.lang.String str) Creates a term initialized to a list of character codes from a Java String.
Term	newObjectTerm(java.lang.Object obj) Creates a term initialized to a *global* reference to a Java object.
Term	newTerm() Creates a null-term (i.e. the empty list, '[]').
Term	newTerm(double d) Creates a term initialized to a Prolog float.
Term	newTerm(float f) Creates a term initialized to a Prolog float.
Term	newTerm(int i) Creates a term initialized to a Prolog integer from a Java int.
Term	newTerm(long j) Creates a term initialized to a Prolog integer from a Java long.
Term	newTerm(java.lang.String a) Creates a term initialized to a Prolog atom.
Term	newTerm(java.lang.String functor, Term[] args) Creates a term initialized to a Prolog compound term.
Term	newTerm(Term t) Creates a term initialized to an existing term.
Term	newVariable() Creates a term initialized to an unbound variable.
Term	numberFromString(java.lang.String str) Creates a term initialized to a Prolog number from a string.
Query	openPrologQuery(java.lang.String string, java.util.Map<java.lang.String,? extends Term> varMap) Opens a query, specified as a string, for obtaining multiple solutions.
Term	prologReadFromString(java.lang.String string, java.util.Map<java.lang.String,? extends Term> varMap) Creates a term by reading from a string.
boolean	query(java.lang.String string, java.util.Map<java.lang.String,? extends Term> varMap) Finds the first solution to a query specified as a string.
boolean	queryCutFail(java.lang.String string, java.util.Map<java.lang.String,? extends Term> varMap) Finds the first solution to a query specified as a string, then cuts away any choice points and fails, i.e. ignores everything but the side-effects during the first solution.

Method Detail

getServer

se.sics.jasper.Server getServer()

For internal use by Jasper.

Returns:

the server

openPrologQuery

Query openPrologQuery(java.lang.String string,
                      java.util.Map<java.lang.String,? extends Term> varMap)
               throws java.lang.NoSuchMethodException,
                      java.lang.InterruptedException,
                      java.lang.Exception

Opens a query, specified as a string, for obtaining multiple solutions. The method itself does not find any solutions; use the method nextSolution to do that. When no more solutions are needed, the query must be closed using methods close or cut on the query-object.

Multiple queries can be open at the same time. See nextSolution for details and restrictions.

Parameters:

string - The goal to use for the query, with terminating period.

varMap - The arguments to the predicate as a map from variable names to Term objects. The map will get entries added for all variables (with names not starting with underscore) in the goal that were not already present as input. May be null.

The passed argument should be a Map<String,Term>. It uses a different type in order to avoid warnings with old client code.

Returns:

The opened query object.

Throws:

java.lang.NoSuchMethodException - Undocumented

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

See Also:

Query.nextSolution(), Query.close(), Query.cut()

query

boolean query(java.lang.String string,
              java.util.Map<java.lang.String,? extends Term> varMap)
       throws java.lang.NoSuchMethodException,
              java.lang.InterruptedException,
              java.lang.Exception

Finds the first solution to a query specified as a string. If you need more than one solution, use openPrologQuery.

Parameters:

string - The goal to use for the query, with terminating period.

varMap - The arguments to the predicate as a map from variable names to Term objects. On success varMap will get entries added for all variables (with names not starting with underscore) in the goal that were not already present as input. May be null.

The passed argument should be a Map<String,Term>. It uses a different type in order to avoid warnings with old client code.

Returns:

True/false corresponding to success/failure of the query.

Throws:

java.lang.NoSuchMethodException - Undocumented

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

See Also:

openPrologQuery(java.lang.String, java.util.Map<java.lang.String, ? extends se.sics.jasper.Term>), queryCutFail(java.lang.String, java.util.Map<java.lang.String, ? extends se.sics.jasper.Term>), Term

queryCutFail

boolean queryCutFail(java.lang.String string,
                     java.util.Map<java.lang.String,? extends Term> varMap)
              throws java.lang.NoSuchMethodException,
                     java.lang.InterruptedException,
                     java.lang.Exception

Finds the first solution to a query specified as a string, then cuts away any choice points and fails, i.e. ignores everything but the side-effects during the first solution.

Parameters:

string - The goal to use for the query, with terminating period.

varMap - The arguments to the predicate as a map from variable names to Term objects. May be null. No bindings are added.

The passed argument should be a Map<String,Term>. It uses a different type in order to avoid warnings with old client code.

Returns:

True/false corresponding to success/failure of the query.

Throws:

java.lang.NoSuchMethodException - Undocumented

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

See Also:

query(java.lang.String, java.util.Map<java.lang.String, ? extends se.sics.jasper.Term>)

newTerm

Term newTerm()
      throws java.lang.InterruptedException,
             java.lang.Exception

Creates a null-term (i.e. the empty list, '[]').

Returns:

an empty list term

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

newTerm

Term newTerm(Term t)
      throws java.lang.InterruptedException,
             java.lang.Exception

Creates a term initialized to an existing term. Modifications to the created Term does not affect the input Term.

Parameters:

t - The Term object whose term to use

Returns:

a new term

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

newTerm

Term newTerm(int i)
      throws java.lang.InterruptedException,
             java.lang.Exception

Creates a term initialized to a Prolog integer from a Java int.

Parameters:

i - Initial value of the integer.

Returns:

a new term representing the argument

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

newTerm

Term newTerm(long j)
      throws java.lang.InterruptedException,
             java.lang.Exception

Creates a term initialized to a Prolog integer from a Java long.

Parameters:

j - Initial value of the integer (long).

Returns:

a new term representing the argument

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

newTerm

Term newTerm(double d)
      throws java.lang.InterruptedException,
             java.lang.Exception

Creates a term initialized to a Prolog float.

Parameters:

d - Initial value of the float.

Returns:

a new term representing the argument

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

newTerm

Term newTerm(float f)
      throws java.lang.InterruptedException,
             java.lang.Exception

Creates a term initialized to a Prolog float.

Parameters:

f - Initial value of the float.

Returns:

a new term representing the argument

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

newTerm

Term newTerm(java.lang.String a)
      throws java.lang.InterruptedException,
             java.lang.Exception

Creates a term initialized to a Prolog atom.

Parameters:

a - String describing the initial value of the atom.

Returns:

a new term representing the argument

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

newTerm

Term newTerm(java.lang.String functor,
             Term[] args)
      throws java.lang.InterruptedException,
             java.lang.Exception

Creates a term initialized to a Prolog compound term.

Parameters:

functor - The functor of the compound term as a string

args - The arguments as an array of Terms

Returns:

a new term representing the argument

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

prologReadFromString

Term prologReadFromString(java.lang.String string,
                          java.util.Map<java.lang.String,? extends Term> varMap)
                   throws java.lang.InterruptedException,
                          java.lang.Exception

Creates a term by reading from a string.

Parameters:

string - The printed representation of the term, with terminating period.

varMap - Bindings for any variables occurring in the term, as a map from variable names to Term objects. The map will get entries added for all variables (with names not starting with underscore) in the term that were not already present as input. May be null.

The passed argument should be a Map<String,Term>. It uses a different type in order to avoid warnings with old client code.

Returns:

a new term representing the arguments

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

newVariable

Term newVariable()
          throws java.lang.InterruptedException,
                 java.lang.Exception

Creates a term initialized to an unbound variable.

Returns:

a new term representing the argument

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

consFunctor

Term consFunctor(java.lang.String functor,
                 Term[] args)
          throws java.lang.InterruptedException,
                 java.lang.Exception

Creates a term initialized to a compound term.

Parameters:

functor - The term's name as a Java String

args - The arguments of the term

Returns:

a new callable term representing the arguments

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

consList

Term consList(Term head,
              Term tail)
       throws java.lang.InterruptedException,
              java.lang.Exception

Creates a term initialized to a list with given head and tail.

Parameters:

head - The head of the list

tail - The tail of the list

Returns:

a new list cell

Throws:

java.lang.InterruptedException - the thread was interrupted

java.lang.Exception - some other problem happened

newObjectTerm

Term newObjectTerm(java.lang.Object obj)
            throws IllegalTermException,
                   ConversionFailedException,
                   java.lang.Exception

Creates a term initialized to a *global* reference to a Java object.

Parameters:

obj - A reference to a Java object.

Returns:

a new global reference term

Throws:

IllegalTermException - an invalid term was detected

ConversionFailedException - the argument could not be converted to a term

java.lang.Exception - some other problem happened

numberFromString

Term numberFromString(java.lang.String str)
               throws ConversionFailedException,
                      IllegalTermException,
                      java.lang.Exception

Creates a term initialized to a Prolog number from a string.

Parameters:

str - The string containing the printed representation of the number.

Returns:

a term representing the argument

Throws:

ConversionFailedException - the argument could not be converted to a term

IllegalTermException - an invalid term was detected

java.lang.Exception - some other problem happened

listFromString

Term listFromString(java.lang.String str)
             throws ConversionFailedException,
                    IllegalTermException,
                    java.lang.Exception

Creates a term initialized to a list of character codes from a Java String.

Parameters:

str - The string of characters.

Returns:

a term representing the argument

Throws:

ConversionFailedException - the argument could not be converted to a term

IllegalTermException - an invalid term was detected

java.lang.Exception - some other problem happened