Prolog (prolobjectlink-jpi-jtrolog 1.2-SNAPSHOT API)

java.lang.Object
- jTrolog.engine.Prolog

All Implemented Interfaces:

Serializable
```
public class Prolog
extends Object
implements Serializable
```
The class representing a jTrolog Prolog machine.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Prolog`	`defaultMachine`
`static int`	`FX`
`static int`	`FY`
`static int`	`OP_HIGH`
`static int`	`OP_LOW`
`static String`	`VERSION`
`static int`	`XF`
`static int`	`XFX`
`static int`	`XFY`
`static int`	`YF`
`static int`	`YFX`

Constructor Summary

Constructors
Constructor and Description
`Prolog()` Builds a prolog engine with default libraries: BasicLibrary, ISOLibrary, IOLibrary
`Prolog(String extraLib)` Builds a prolog engine with default libraries: BasicLibrary, ISOLibrary, IOLibrary + the extraLib
`Prolog(String[] libNames)` Builds a prolog engine using _only_ the specified libraries as parameters

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abolish(String predicateIndicator)`
`void`	`addTheory(String theory)`
`void`	`assertA(Clause toBeAsserted)`
`void`	`assertZ(Clause toBeAsserted)` The Rule and Fact Database System The Library System
`void`	`clearTheory()` removes all dynamic predicates
`void`	`defineFlag(String name, Struct valueList, Term defValue, boolean modifiable)`
`Iterator`	`dynamicPredicateIndicators()`
`static boolean`	`evalPrimitive(jTrolog.engine.PrimitiveInfo prim, Object[] primitive_args)`
`List`	`find(String predIndicator)`
`List`	`getAndResetWarnings()`
`Iterator`	`getCurrentLibraries()`
`Iterator`	`getCurrentOperators()` Gets the list of the operators currently defined
`Flag`	`getFlag(String name)`
`Term`	`getFlagValue(String name)`
`String`	`getLastConsultedTheory()`
`Library`	`getLibrary(String name)`
`int`	`getOperatorPriority(String name, int type)`
`PrintStream`	`getPrintStream()`
`Term`	`getPrologFlagList()`
`String`	`getTheory()`
`boolean`	`hasOpenAlternatives()` Asks for the presence of open alternatives to be explored in current demostration process.
`boolean`	`hasPrimitive(String predicateIndiciator)`
`boolean`	`hasPrimitiveExp(String predicateIndiciator)`
`Library`	`loadLibrary(Library lib)` Loads a specific instance of a library If a library of the same class is already present, a warning event is notified.
`Library`	`loadLibrary(String className)` Loads a library.
`static void`	`main(String[] args)` Starts a command line interface with jTrolog Prolog engine.
`static boolean`	`match(Term t0, Term t1)` Matches the structure of the two original terms.
`void`	`onSolveBegin(Term g)`
`void`	`onSolveEnd()`
`void`	`opNew(String name, int type, int i)`
`void`	`opNew(String name, String type, int i)`
`void`	`resetWarningList()`
`Struct`	`retract(Struct sarg0)`
`void`	`setDynamicPredicateIndicator(String predicateIndicator)`
`void`	`setPrintStream(PrintStream ps)`
`void`	`setTheory(String newTheory)` Deprecated. use clearTheory() + addTheory(newTheory) instead
`Solution`	`solve(String st)` Solves a query
`Solution`	`solve(Struct g)` Solves a query
`Solution`	`solveNext()` Gets next solution
`void`	`unloadLibrary(String name)`
`void`	`warn(String m)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION
```
public static final String VERSION
```
    See Also:
    
    Constant Field Values
  - OP_LOW
```
public static final int OP_LOW
```
    See Also:
    
    Constant Field Values
  - OP_HIGH
```
public static final int OP_HIGH
```
    See Also:
    
    Constant Field Values
  - defaultMachine
```
public static final Prolog defaultMachine
```
  - FX
```
public static final int FX
```
    See Also:
    
    Constant Field Values
  - FY
```
public static final int FY
```
    See Also:
    
    Constant Field Values
  - XFX
```
public static final int XFX
```
    See Also:
    
    Constant Field Values
  - XFY
```
public static final int XFY
```
    See Also:
    
    Constant Field Values
  - YFX
```
public static final int YFX
```
    See Also:
    
    Constant Field Values
  - XF
```
public static final int XF
```
    See Also:
    
    Constant Field Values
  - YF
```
public static final int YF
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Prolog
```
public Prolog()
```
    Builds a prolog engine with default libraries: BasicLibrary, ISOLibrary, IOLibrary
  - Prolog
```
public Prolog(String extraLib)
```
    Builds a prolog engine with default libraries: BasicLibrary, ISOLibrary, IOLibrary + the extraLib
    
    Parameters:
    
    extraLib - additional library to be loaded
  - Prolog
```
public Prolog(String[] libNames)
```
    Builds a prolog engine using _only_ the specified libraries as parameters
    
    Parameters:
    
    libNames - the (class) names of the libraries to be loaded
- Method Detail
  - main
```
public static void main(String[] args)
                 throws IOException
```
    Starts a command line interface with jTrolog Prolog engine. Builtin-, Basic-, ISO- and IO-Libraries are loaded. In the future, args could be made to look for URLs with theories?
    
    Throws:
    
    IOException
  - assertZ
```
public void assertZ(Clause toBeAsserted)
             throws PrologException
```
    The Rule and Fact Database System The Library System
    
    Throws:
    
    PrologException
  - assertA
```
public void assertA(Clause toBeAsserted)
             throws PrologException
```
    Throws:
    
    PrologException
  - retract
```
public Struct retract(Struct sarg0)
               throws PrologException
```
    Throws:
    
    PrologException
  - abolish
```
public void abolish(String predicateIndicator)
             throws PrologException
```
    Throws:
    
    PrologException
  - setDynamicPredicateIndicator
```
public void setDynamicPredicateIndicator(String predicateIndicator)
                                  throws PrologException
```
    Throws:
    
    PrologException
  - find
```
public List find(String predIndicator)
          throws PrologException
```
    Throws:
    
    PrologException
  - dynamicPredicateIndicators
```
public Iterator dynamicPredicateIndicators()
```
  - setTheory
```
public void setTheory(String newTheory)
               throws PrologException
```
    Deprecated. use clearTheory() + addTheory(newTheory) instead
    
    clears all dynamic predicates and sets the new newTheory
    
    Parameters:
    
    newTheory - to be set
    
    Throws:
    
    PrologException - if newTheory is not valid
  - clearTheory
```
public void clearTheory()
```
    removes all dynamic predicates
  - addTheory
```
public void addTheory(String theory)
               throws PrologException
```
    Parameters:
    
    theory - to be added to the existing set of theories in the database.
    
    Throws:
    
    PrologException - if the new theory is not valid
  - getTheory
```
public String getTheory()
```
    Returns:
    
    the current theory in the Prolog machine (only dynamic)
  - getLastConsultedTheory
```
public String getLastConsultedTheory()
```
    Returns:
    
    the last theory to be consulted or attempted consulted as text
  - loadLibrary
```
public Library loadLibrary(String className)
                    throws InvalidLibraryException
```
    Loads a library. If a library with the same name is already present, a warning event is notified. Then, the current instance of that library is discarded, and the new instance gets loaded.
    
    Parameters:
    
    className - of the Java class containing the Library to be loaded
    
    Returns:
    
    the reference to the Library just loaded
    
    Throws:
    
    InvalidLibraryException - if name is not a valid library
  - loadLibrary
```
public Library loadLibrary(Library lib)
                    throws InvalidLibraryException
```
    Loads a specific instance of a library If a library of the same class is already present, a warning event is notified. Then, the current instance of that library is discarded, and the new instance gets loaded.
    
    Parameters:
    
    lib - the (Java class) name of the library to be loaded
    
    Throws:
    
    InvalidLibraryException - if name is not a valid library
  - unloadLibrary
```
public void unloadLibrary(String name)
                   throws InvalidLibraryException
```
    Parameters:
    
    name - of the library to be unloaded
    
    Throws:
    
    InvalidLibraryException - if no loaded Library has the given name
  - getLibrary
```
public Library getLibrary(String name)
```
  - getCurrentLibraries
```
public Iterator getCurrentLibraries()
```
    Returns:
    
    the names of the libraries currently loaded
  - setPrintStream
```
public void setPrintStream(PrintStream ps)
```
    Parameters:
    
    ps - the engine printstream.
  - getPrintStream
```
public PrintStream getPrintStream()
```
    Returns:
    
    the engine printstream.
  - getCurrentOperators
```
public Iterator getCurrentOperators()
```
    Gets the list of the operators currently defined
    
    Returns:
    
    the list of the operators
  - getOperatorPriority
```
public int getOperatorPriority(String name,
                               int type)
```
  - opNew
```
public void opNew(String name,
                  int type,
                  int i)
```
  - opNew
```
public void opNew(String name,
                  String type,
                  int i)
```
  - solve
```
public Solution solve(String st)
               throws Throwable
```
    Solves a query
    
    Parameters:
    
    st - the string representing the goal to be demonstrated
    
    Returns:
    
    the result of the demonstration
    
    Throws:
    
    Throwable
    
    See Also:
    
    SolutionManager
  - solve
```
public Solution solve(Struct g)
               throws Throwable
```
    Solves a query
    
    Parameters:
    
    g - the term representing the goal to be demonstrated
    
    Returns:
    
    the result of the demonstration
    
    Throws:
    
    Throwable
    
    See Also:
    
    SolutionManager
  - solveNext
```
public Solution solveNext()
                   throws Throwable
```
    Gets next solution
    
    Returns:
    
    the result of the demonstration
    
    Throws:
    
    NoMorePrologSolutions - if no more solutions are present
    
    Throwable
    
    See Also:
    
    SolutionManager
  - onSolveBegin
```
public void onSolveBegin(Term g)
```
  - onSolveEnd
```
public void onSolveEnd()
```
  - hasOpenAlternatives
```
public boolean hasOpenAlternatives()
                            throws Throwable
```
    Asks for the presence of open alternatives to be explored in current demostration process.
    
    Returns:
    
    true if open alternatives are present
    
    Throws:
    
    Throwable
  - match
```
public static boolean match(Term t0,
                            Term t1)
```
    Matches the structure of the two original terms. OBS: Variables in the original terms are not resolved. If this is desired, then the terms passed in should be clonedAndResolved first. OBS2: no unification of variables is made.
    
    Parameters:
    
    t0 - first term to be matched
    
    t1 - second term to be matched
    
    Returns:
    
    true if the structure of the two terms match
  - hasPrimitive
```
public boolean hasPrimitive(String predicateIndiciator)
```
  - hasPrimitiveExp
```
public boolean hasPrimitiveExp(String predicateIndiciator)
```
  - resetWarningList
```
public void resetWarningList()
```
  - getAndResetWarnings
```
public List getAndResetWarnings()
```
  - warn
```
public void warn(String m)
```
    Parameters:
    
    m - adds the warning message to the warnings list
  - defineFlag
```
public void defineFlag(String name,
                       Struct valueList,
                       Term defValue,
                       boolean modifiable)
```
  - getFlag
```
public Flag getFlag(String name)
```
  - getFlagValue
```
public Term getFlagValue(String name)
```
  - getPrologFlagList
```
public Term getPrologFlagList()
```
  - evalPrimitive
```
public static boolean evalPrimitive(jTrolog.engine.PrimitiveInfo prim,
                                    Object[] primitive_args)
                             throws Throwable
```
    Throws:
    
    Throwable

Class Prolog

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

OP_LOW

OP_HIGH

defaultMachine

FX

FY

XFX

XFY

YFX

XF

YF

Constructor Detail

Prolog

Prolog

Prolog

Method Detail

main

assertZ

assertA

retract

abolish

setDynamicPredicateIndicator

find

dynamicPredicateIndicators

setTheory

clearTheory

addTheory

getTheory

getLastConsultedTheory

loadLibrary

loadLibrary

unloadLibrary

getLibrary

getCurrentLibraries

setPrintStream

getPrintStream

getCurrentOperators

getOperatorPriority

opNew

opNew

solve

solve

solveNext

onSolveBegin

onSolveEnd

hasOpenAlternatives

match

hasPrimitive

hasPrimitiveExp

resetWarningList

getAndResetWarnings

warn

defineFlag

getFlag

getFlagValue

getPrologFlagList

evalPrimitive