FloraSubprocessEngine (InterProlog Java Bridge)

java.lang.Object
- com.declarativa.interprolog.AbstractPrologEngine
- - com.declarativa.interprolog.SubprocessEngine
  - - com.declarativa.interprolog.XSBSubprocessEngine
    - - com.declarativa.interprolog.FloraSubprocessEngine

All Implemented Interfaces:

PrologEngine
```
public class FloraSubprocessEngine
extends XSBSubprocessEngine
```
A PrologEngine encapsulating a XSB Prolog engine, accessed over TCP/IP sockets, and running the Flora2 shell. Note that deterministicGoal and nonDeterministicGoal call Prolog goals, not Flora goals. It also supports Ergo, a proprietary Flora variant from Coherent Knowledge Systems. Unlike Flora2's standard Java API, this class allows both the interactive use of the Flora2/Ergo shell and programmatic usage with the javaMessage/java Prolog predicates and deterministicGoal and related methods. It also allows shifting from the Flora2 shell to Prolog's shell and back.

Nested Class Summary
- Nested classes/interfaces inherited from class com.declarativa.interprolog.SubprocessEngine
  SubprocessEngine.OutputDumper

Field Summary

Fields
Modifier and Type Field and Description

static String ERGO_AUX_BASE

static String ERGOTEXT_EXTENSION

static String FLORA_AUX_BASE
- Fields inherited from class com.declarativa.interprolog.SubprocessEngine
  ctrl_c, ctrlc
- Fields inherited from class com.declarativa.interprolog.AbstractPrologEngine
  firstJavaMessageName, interPrologFileLoaded, nl, prologBinDirectoryOrCommand
- Fields inherited from interface com.declarativa.interprolog.PrologEngine
  MAX_INT_VALUE, MIN_INT_VALUE, version

Fields
Modifier and Type	Field and Description
`static String`	`ERGO_AUX_BASE`
`static String`	`ERGOTEXT_EXTENSION`
`static String`	`FLORA_AUX_BASE`

Constructor Summary

Constructors
Constructor and Description
`FloraSubprocessEngine()`
`FloraSubprocessEngine(boolean debug)`
`FloraSubprocessEngine(String[] prologCommands)`
`FloraSubprocessEngine(String[] prologCommands, boolean debug)`
`FloraSubprocessEngine(String[] prologCommands, boolean debug, boolean loadFromJar)`
`FloraSubprocessEngine(String[] prologCommands, String floraDirectory)`
`FloraSubprocessEngine(String[] prologCommands, String floraDirectory, boolean outAndErrMerged, boolean debug, boolean loadFromJar)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abortEngine()` Assumes the engine is in a break state
`boolean`	`command(String s)` Execute a Prolog "command; returns true if it succeeds"
`boolean`	`consultAbsolute(File f)` \\load a Flora (into main module) or Prolog file
`boolean`	`consultFloraAbsolute(File f, String module)` \\load a Flora file into a specific module.
`String`	`consultFloraFromPackage(String filename, Object requester)`
`String`	`consultFloraFromPackage(String filename, String module, Object requester)`
`String`	`consultFromPackage(String filename, Object requester)` Same as superclass, but also accepts a Flora file, which is loaded into module 'main'
`boolean`	`floraCommand(String s)` Execute a Flora/Ergo "command"
`boolean`	`floraDeterministicGoal(String FG)`
`TermModel`	`floraDeterministicGoal(String FG, String FloraOutputVar)`
`TermModel[]`	`floraDeterministicGoal(String FG, String FloraInputVars, TermModel[] terms, String FloraOutputVars)` Execute Flora goal FG, binding terms to the variables in FloraInputVars, and returning as many TermModels as vars in FloraOutputVars.
`String`	`getFloraBuild()`
`String`	`getFloraDirectory()`
`String`	`getFloraReleaseDate()` Return Flora's release date as YYYY-MM-DD
`String`	`getFloraVersion()` Return Flora's version
`String`	`getLanguage()`
`boolean`	`inFloraShell()` We know the engine to be in the Flora shell, so Prolog goals need a Flora suffix
`boolean`	`inPrologShell()` We know the engine to be in the Prolog shell, so Prolog goals do not need a postfix
`void`	`interrupt()` Interrupt Prolog and make it return to its top level.
`boolean`	`isErgo()` This Flora2 engine happens to also be an Ergo engine.
`static boolean`	`isErgo(String floraDirectory)`
`static boolean`	`isErgoSourceFile(File F)`
`static boolean`	`isErgoSourceFile(String filename)`
`static boolean`	`isErgotextSourceFile(File F)`
`static boolean`	`isErgotextSourceFile(String filename)`
`static boolean`	`isFloraSourceFile(File F)`
`static boolean`	`isFloraSourceFile(String filename)`
`boolean`	`isQuietDeterministicGoals()`
`boolean`	`isVerbose()`
`static void`	`main(String[] args)` Example to create an engine and run a simple query.
`void`	`resumeEngine()` Assumes the engine is in a break state
`void`	`setFloraShell()`
`void`	`setFloraShellStarted()`
`void`	`setPrologShell()`
`void`	`setQuietDeterministicGoals(boolean quietDeterministicGoals)` Determines whether Flora/Ergo standard output (such as "Yes", variable bindings etc) is produced during deterministicGoal
`void`	`setVerbose(boolean verbose)` Sets the Flora/Ergo engines's chatter level

Methods inherited from class com.declarativa.interprolog.AbstractPrologEngine
abortTasks, add_lib_dir, addPrologEngineListener, addSoftwareLibrary, addSoftwareLibrary, assignableType, command, command, consultAbsolute, consultFromPackage, consultRelative, createTempDirectory, currentTimeSecs, deleteAll, deleteTempFiles, deterministicGoal, deterministicGoal, deterministicGoal, deterministicGoal, deterministicGoalJSON, doCallback, endAllTasks, exec, executingOnJavaSide, findConstructor, findMethod, firstJavaMessage, getImplementationPeer, getInterprologPath, getJarDirectory, getJarDirectory, getLoadFromJar, getPrologBaseDirectory, getPrologNumericVersion, getPrologVersion, getRealJavaObject, getRealJavaObject, getRealJavaObject, getThePrologListener, goal, goal, handleCallback, hasPrologExtension, interruptTasks, is64WindowsOS, isAllowSimultaneousThreads, isDebug, isIdle, isLinuxOS, isMacOS, isPaused, isProfiling, isSerializable, isShutingDown, isThreadedCallbacks, isWindowsOS, lastSolutionUndefined, load_dynAbsolute, load_dynRelative, loop, loop2, makeInvisible, printAllStackTraces, printAllStackTraces, printBindings, printStackTrace, profilingMessage, progressMessage, progressMessage, prologBinToBaseDirectory, prologCanWork, prologEnteredBreak, prologResumedComputation, prologReturnedToTopLevel, registerJavaObject, removePrologEngineListener, serverFileSeparatorChar, serverIsWindows, setAllowSimultaneousThreads, setProfiling, setThreadedCallbacks, setTimedCallIntervall, shortClassName, stop, teachMoreObjects, teachMoreObjects, teachMoreObjects, teachOneObject, toString, unescapedFilePath, unregisterJavaObject, unregisterJavaObject, unregisterJavaObjects, waitUntilIdle

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

- Field Detail
  - FLORA_AUX_BASE
```
public static final String FLORA_AUX_BASE
```
    See Also:
    
    Constant Field Values
  - ERGO_AUX_BASE
```
public static final String ERGO_AUX_BASE
```
    See Also:
    
    Constant Field Values
  - ERGOTEXT_EXTENSION
```
public static final String ERGOTEXT_EXTENSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FloraSubprocessEngine
```
public FloraSubprocessEngine(String[] prologCommands,
                             String floraDirectory,
                             boolean outAndErrMerged,
                             boolean debug,
                             boolean loadFromJar)
```
    Parameters:
    
    prologCommands -
    
    floraDirectory -
    
    outAndErrMerged -
    
    debug -
    
    loadFromJar -
    
    See Also:
    
    fj_floraSupported is asserted on the Prolog side
  - FloraSubprocessEngine
```
public FloraSubprocessEngine(String[] prologCommands,
                             boolean debug,
                             boolean loadFromJar)
```
    Parameters:
    
    prologCommands -
    
    debug -
    
    loadFromJar -
  - FloraSubprocessEngine
```
public FloraSubprocessEngine(String[] prologCommands,
                             boolean debug)
```
  - FloraSubprocessEngine
```
public FloraSubprocessEngine(String[] prologCommands,
                             String floraDirectory)
```
  - FloraSubprocessEngine
```
public FloraSubprocessEngine(String[] prologCommands)
```
  - FloraSubprocessEngine
```
public FloraSubprocessEngine(boolean debug)
```
  - FloraSubprocessEngine
```
public FloraSubprocessEngine()
```
    See Also:
    
    AbstractPrologEngine.AbstractPrologEngine(String prologBinDirectoryOrCommand, boolean debug, boolean loadFromJar)
- Method Detail
  - isQuietDeterministicGoals
```
public boolean isQuietDeterministicGoals()
```
  - setQuietDeterministicGoals
```
public void setQuietDeterministicGoals(boolean quietDeterministicGoals)
```
    Determines whether Flora/Ergo standard output (such as "Yes", variable bindings etc) is produced during deterministicGoal
    
    Parameters:
    
    quietDeterministicGoals -
  - isErgo
```
public static boolean isErgo(String floraDirectory)
```
  - isErgo
```
public boolean isErgo()
```
    This Flora2 engine happens to also be an Ergo engine. If true, the Prolog side will have a fact fjIsErgo(yes).
    
    Returns:
    
    whether it's an Ergo engine
  - getLanguage
```
public String getLanguage()
```
    Returns:
    
    the more advanced language supported
  - setFloraShellStarted
```
public void setFloraShellStarted()
```
  - setFloraShell
```
public void setFloraShell()
```
  - setPrologShell
```
public void setPrologShell()
```
  - inFloraShell
```
public boolean inFloraShell()
```
    We know the engine to be in the Flora shell, so Prolog goals need a Flora suffix
    
    Returns:
    
    true if in Flora/Ergo, otherwise Prolog
  - inPrologShell
```
public boolean inPrologShell()
```
    We know the engine to be in the Prolog shell, so Prolog goals do not need a postfix
    
    Specified by:
    
    inPrologShell in interface PrologEngine
    
    Overrides:
    
    inPrologShell in class AbstractPrologEngine
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    Sets the Flora/Ergo engines's chatter level
    
    Parameters:
    
    verbose -
  - isVerbose
```
public boolean isVerbose()
```
  - interrupt
```
public void interrupt()
```
    Description copied from interface: PrologEngine
    
    Interrupt Prolog and make it return to its top level. This is the equivalent to performing a ctrl+c or similar command when using Prolog under a standard console shell.
    
    Specified by:
    
    interrupt in interface PrologEngine
    
    Overrides:
    
    interrupt in class AbstractPrologEngine
  - resumeEngine
```
public void resumeEngine()
```
    Assumes the engine is in a break state
    
    Overrides:
    
    resumeEngine in class SubprocessEngine
  - abortEngine
```
public void abortEngine()
```
    Assumes the engine is in a break state
    
    Overrides:
    
    abortEngine in class SubprocessEngine
  - command
```
public boolean command(String s)
```
    Execute a Prolog "command; returns true if it succeeds"
    
    Specified by:
    
    command in interface PrologEngine
    
    Overrides:
    
    command in class AbstractPrologEngine
    
    See Also:
    
    AbstractPrologEngine.command(java.lang.String)
  - floraCommand
```
public boolean floraCommand(String s)
```
    Execute a Flora/Ergo "command"
    
    Parameters:
    
    s - the command
    
    Returns:
    
    true if it succeeds
  - isFloraSourceFile
```
public static boolean isFloraSourceFile(File F)
```
  - isFloraSourceFile
```
public static boolean isFloraSourceFile(String filename)
```
  - isErgoSourceFile
```
public static boolean isErgoSourceFile(File F)
```
  - isErgoSourceFile
```
public static boolean isErgoSourceFile(String filename)
```
  - isErgotextSourceFile
```
public static boolean isErgotextSourceFile(File F)
```
  - isErgotextSourceFile
```
public static boolean isErgotextSourceFile(String filename)
```
  - consultAbsolute
```
public boolean consultAbsolute(File f)
```
    \\load a Flora (into main module) or Prolog file
    
    Specified by:
    
    consultAbsolute in interface PrologEngine
    
    Overrides:
    
    consultAbsolute in class AbstractPrologEngine
    
    Parameters:
    
    f -
    
    Returns:
    
    whether it succeeded
    
    See Also:
    
    AbstractPrologEngine.consultAbsolute(java.io.File)
  - consultFloraAbsolute
```
public boolean consultFloraAbsolute(File f,
                                    String module)
```
    \\load a Flora file into a specific module.
  - consultFromPackage
```
public String consultFromPackage(String filename,
                                 Object requester)
```
    Same as superclass, but also accepts a Flora file, which is loaded into module 'main'
    
    Specified by:
    
    consultFromPackage in interface PrologEngine
    
    Overrides:
    
    consultFromPackage in class AbstractPrologEngine
    
    Parameters:
    
    filename - The Prolog file name, including extension; if it has no extension, the Prolog file extensions are appended in turn until a file is found
    
    requester - Defines where the Prolog file resides
    
    See Also:
    
    AbstractPrologEngine.consultFromPackage(String,Object)
  - consultFloraFromPackage
```
public String consultFloraFromPackage(String filename,
                                      Object requester)
```
    Parameters:
    
    filename -
    
    requester -
    
    Returns:
    
    actual path of the consulted file
  - consultFloraFromPackage
```
public String consultFloraFromPackage(String filename,
                                      String module,
                                      Object requester)
```
    Parameters:
    
    filename -
    
    module -
    
    requester -
    
    Returns:
    
    actual path of the consulted file
  - floraDeterministicGoal
```
public boolean floraDeterministicGoal(String FG)
```
  - floraDeterministicGoal
```
public TermModel floraDeterministicGoal(String FG,
                                        String FloraOutputVar)
```
  - floraDeterministicGoal
```
public TermModel[] floraDeterministicGoal(String FG,
                                          String FloraInputVars,
                                          TermModel[] terms,
                                          String FloraOutputVars)
```
    Execute Flora goal FG, binding terms to the variables in FloraInputVars, and returning as many TermModels as vars in FloraOutputVars. Example: TermModel Z = engine.floraDeterministicGoal("?Z is ?X+?Y","?X,?Y",new TermModel[]{new TermModel(2),new TermModel(3)},"?Z")[0]; More: System.out.println("command: "+e.floraDeterministicGoal("true")); System.out.println("one term: "+e.floraDeterministicGoal("?X=2+3","?X")); System.out.println("sum: "+e.floraDeterministicGoal("?Z is ?X+?Y","?X,?Y",new TermModel[]{new TermModel(2),new TermModel(3)},"?Z")[0]); Flora/Ergo goals are always called from the XSB Prolog layer, using flora_query/ergo_query (See Ergo Manual, "Passing Arbitrary Queries to ERGO").
    
    Parameters:
    
    FG -
    
    FloraInputVars -
    
    terms -
    
    FloraOutputVars -
    
    Returns:
    
    bindings
  - getFloraDirectory
```
public String getFloraDirectory()
```
    Returns:
    
    Flora/Ergo install directory
  - getFloraReleaseDate
```
public String getFloraReleaseDate()
```
    Return Flora's release date as YYYY-MM-DD
  - getFloraBuild
```
public String getFloraBuild()
```
  - getFloraVersion
```
public String getFloraVersion()
```
    Return Flora's version
  - main
```
public static void main(String[] args)
```
    Example to create an engine and run a simple query. Source must be edited for correct paths.
    
    Parameters:
    
    args - ignored

Class FloraSubprocessEngine

Nested Class Summary

Nested classes/interfaces inherited from class com.declarativa.interprolog.SubprocessEngine

Field Summary

Fields inherited from class com.declarativa.interprolog.SubprocessEngine

Fields inherited from class com.declarativa.interprolog.AbstractPrologEngine

Fields inherited from interface com.declarativa.interprolog.PrologEngine

Constructor Summary

Method Summary

Methods inherited from class com.declarativa.interprolog.SubprocessEngine

Methods inherited from class com.declarativa.interprolog.AbstractPrologEngine

Methods inherited from class java.lang.Object

Field Detail

FLORA_AUX_BASE

ERGO_AUX_BASE

ERGOTEXT_EXTENSION

Constructor Detail

FloraSubprocessEngine

FloraSubprocessEngine

FloraSubprocessEngine

FloraSubprocessEngine

FloraSubprocessEngine

FloraSubprocessEngine

FloraSubprocessEngine

Method Detail

isQuietDeterministicGoals

setQuietDeterministicGoals

isErgo

isErgo

getLanguage

setFloraShellStarted

setFloraShell

setPrologShell

inFloraShell

inPrologShell

setVerbose

isVerbose

interrupt

resumeEngine

abortEngine

command

floraCommand

isFloraSourceFile

isFloraSourceFile

isErgoSourceFile

isErgoSourceFile

isErgotextSourceFile

isErgotextSourceFile

consultAbsolute

consultFloraAbsolute

consultFromPackage

consultFloraFromPackage

consultFloraFromPackage

floraDeterministicGoal

floraDeterministicGoal

floraDeterministicGoal

getFloraDirectory

getFloraReleaseDate

getFloraBuild

getFloraVersion

main