|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--jess.Rete
The reasoning engine. Executes the built Rete network, and coordinates many other activities.
(C) 1997 Ernest J. Friedman-Hill and Sandia National Laboratories
Field Summary | |
static int |
ACTIVATE
|
static int |
EVERY_TIME
|
static int |
INSTALL
|
Constructor Summary | |
Rete()
|
|
Rete(java.applet.Applet a)
|
Method Summary | |
protected void |
aboutToFire(Activation a)
|
Deffacts |
addDeffacts(Deffacts df)
Creates a new deffacts in this object |
Defglobal |
addDefglobal(Defglobal dg)
Creates a new Defglobal in this object. |
HasLHS |
addDefrule(HasLHS dr)
Creates a new defrule in this object |
Deftemplate |
addDeftemplate(Deftemplate dt)
Creates a new deftemplate in this object. |
void |
addInputRouter(java.lang.String s,
java.io.Reader is,
boolean consoleLike)
|
void |
addJessListener(JessListener jel)
|
void |
addOutputRouter(java.lang.String s,
java.io.Writer os)
|
Userfunction |
addUserfunction(Userfunction uf)
Creates a new function in this object Will happily destroy an old one. |
Userpackage |
addUserpackage(Userpackage up)
Add a Userpackage to this engine. |
Fact |
assert(Fact f)
Assert a fact |
Fact |
assertString(java.lang.String s)
Assert a fact, as a String |
void |
bload(java.io.InputStream is)
Read this object's state from the given stream. |
void |
bsave(java.io.OutputStream os)
Save this object's state out to the given stream. |
void |
clear()
Reinitialize engine Thanks to Karl Mueller for idea |
void |
clearStorage()
Clear the storage used by store() and fetch(). |
Value |
defclass(java.lang.String jessName,
java.lang.String clazz,
java.lang.String parent)
Add a defclass definition to this engine |
Value |
definstance(java.lang.String jessTypename,
java.lang.Object object,
boolean dynamic)
Tell this engine to pattern match on the given object. |
int |
doPreAssertionProcessing(Fact f)
|
Value |
executeCommand(java.lang.String cmd)
Call a Jess function in this engine's global context. |
Value |
fetch(java.lang.String name)
Retrieve an object previously stored with store(). |
Defglobal |
findDefglobal(java.lang.String name)
|
HasLHS |
findDefrule(java.lang.String name)
Find a defrule object with a certain name |
Deftemplate |
findDeftemplate(java.lang.String name)
Find a deftemplate object with a certain name |
Fact |
findFactByID(int id)
This "find" is very slow; don't use it unless you have to. |
Userfunction |
findUserfunction(java.lang.String name)
Find a userfunction, if there is one. |
java.lang.Object |
getActivationSemaphore()
The monitor of the object returned from this method will be signalled whenever an activation appears. |
java.applet.Applet |
getApplet()
Returns the applet this Rete is installed in. |
java.io.PrintWriter |
getErrStream()
|
int |
getEvalSalience()
Fetch the salience evaluation behaviour |
int |
getEventMask()
|
static jess.factory.Factory |
getFactory()
|
Context |
getGlobalContext()
Fetch the global execution context. |
boolean |
getInputMode(java.lang.String s)
|
java.io.Reader |
getInputRouter(java.lang.String s)
|
java.io.Writer |
getOutputRouter(java.lang.String s)
|
java.io.PrintWriter |
getOutStream()
|
boolean |
getResetGlobals()
When resetGlobals is true, the initializers of global variables are evaluated when (reset) is executed. |
void |
halt()
Stop the engine from firing rules. |
protected void |
justFired(Activation a)
|
java.util.Iterator |
listActivations()
Return an Enumeration of all the activiations - i.e, the agenda. |
java.util.Iterator |
listDeffacts()
Return an Enumeration of all the deffacts in this engine. |
java.util.Iterator |
listDefglobals()
Return an Enumeration of all the defglobals in this engine. |
java.util.Iterator |
listDefinstances()
Return an Enumeration of all the definstanced objects |
java.util.Iterator |
listDefrules()
Return an Enumeration of all the defrules in this engine. |
java.util.Iterator |
listDeftemplates()
Return an Enumeration of all the deftemplates in this engine, both explicit and implied. |
java.util.Iterator |
listFacts()
Return an Enumeration of all the facts currently on the fact-list |
java.util.Iterator |
listFunctions()
Return an Enumeration of all the functions in this engine: built-in, user, and deffunctions. |
void |
ppFacts(java.lang.String head,
java.io.Writer output)
Write the pretty print forms of the facts with the given head to the writer |
void |
ppFacts(java.io.Writer output)
Write the pretty print forms of all facts to the writer |
void |
removeInputRouter(java.lang.String s)
|
void |
removeJessListener(JessListener jel)
|
void |
removeOutputRouter(java.lang.String s)
|
void |
reset()
Reset the Rete engine. |
Fact |
retract(Fact f)
Retract a fact. |
Fact |
retractString(java.lang.String s)
Karl Mueller NASA/GSFC Code 522.2 (Karl.R.Mueller@gsfc.nasa.gov) 27.January.1998 Retract a fact as a string |
int |
run()
Run the actual engine. |
int |
run(int max)
Run the rule engine. |
java.util.Enumeration |
runQuery(java.lang.String name,
ValueVector params)
Quick way to run a defquery |
int |
runUntilHalt()
Run until halt() is called. |
void |
setApplet(java.applet.Applet a)
Associates this Rete with an applet so that, for instance, the (batch) commands will look for scripts using the applet's document base URL. |
void |
setEvalSalience(int method)
Set the salience evaluation behaviour. |
void |
setEventMask(int i)
|
static void |
setFactory(jess.factory.Factory f)
|
void |
setPendingFact(Fact fact,
boolean assert)
|
void |
setResetGlobals(boolean reset)
When resetGlobals is true, the initializers of global variables are evaluated when (reset) is executed. |
java.lang.String |
setStrategy(Strategy s)
|
Value |
store(java.lang.String name,
java.lang.Object val)
Store a value in the engine under a given name for later retrieval by fetch. |
Value |
store(java.lang.String name,
Value val)
Store a value in the engine under a given name for later retrieval by fetch. |
Value |
undefinstance(java.lang.Object o)
Tell this engine to stop pattern matching on the given object |
Value |
unDefrule(java.lang.String name)
|
void |
waitForActivations()
Waits on the activation lock until a rule is activated. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int INSTALL
public static final int ACTIVATE
public static final int EVERY_TIME
Constructor Detail |
public Rete()
public Rete(java.applet.Applet a)
a
- If this Rete object is being created inside an applet,
pass it as an argument.Method Detail |
public void addInputRouter(java.lang.String s, java.io.Reader is, boolean consoleLike)
s
- The router nameis
- A Reader where the router's data comes fromconsoleLike
- See the Jess manualpublic void removeInputRouter(java.lang.String s)
s
- The name of the routerpublic java.io.Reader getInputRouter(java.lang.String s)
s
- The router namepublic void addOutputRouter(java.lang.String s, java.io.Writer os)
s
- The router nameos
- Where the data should gopublic void removeOutputRouter(java.lang.String s)
s
- The name of the routerpublic boolean getInputMode(java.lang.String s)
s
- The router namepublic java.io.Writer getOutputRouter(java.lang.String s)
s
- The router namepublic java.io.PrintWriter getErrStream()
public java.io.PrintWriter getOutStream()
public int doPreAssertionProcessing(Fact f) throws JessException
public void clear() throws JessException
JessException
- public void setPendingFact(Fact fact, boolean assert)
public void reset() throws JessException
JessException
- If anything goes wrong.public Fact assertString(java.lang.String s) throws JessException
s
- JessException
- public Fact assert(Fact f) throws JessException
f
- A Fact object. This fact becomes the property of Jess
after calling assert() -- don't change any of its fields until
the fact is retracted!JessException
- If anything goes wrongpublic Fact retractString(java.lang.String s) throws JessException
s
- JessException
- public Fact retract(Fact f) throws JessException
f
- A Fact object. Doesn't need to be the actual object
that appears on the fact-list; can just be a Fact that could
compare equal to one.JessException
- If anything goes wrong.public Fact findFactByID(int id) throws JessException
id
- The fact-idJessException
- If something goes wrongpublic void ppFacts(java.lang.String head, java.io.Writer output) throws java.io.IOException
public void ppFacts(java.io.Writer output) throws java.io.IOException
JessException
- public java.util.Iterator listDeffacts()
public java.util.Iterator listDeftemplates()
public java.util.Iterator listDefrules()
public java.util.Iterator listFacts()
public java.util.Iterator listDefinstances()
public java.util.Iterator listDefglobals()
public java.util.Iterator listFunctions()
public final HasLHS findDefrule(java.lang.String name)
name
- public Deftemplate findDeftemplate(java.lang.String name)
name
- public Deftemplate addDeftemplate(Deftemplate dt) throws JessException
dt
- JessException
- public Deffacts addDeffacts(Deffacts df) throws JessException
df
- JessException
- public Defglobal addDefglobal(Defglobal dg) throws JessException
dg
- JessException
- public Defglobal findDefglobal(java.lang.String name)
name
- public Userfunction addUserfunction(Userfunction uf)
uf
- A new USerfunctionpublic Userpackage addUserpackage(Userpackage up)
up
- The package objectpublic final Userfunction findUserfunction(java.lang.String name)
name
- The name of the functionpublic final HasLHS addDefrule(HasLHS dr) throws JessException
dr
- JessException
- public final Value unDefrule(java.lang.String name) throws JessException
name
- JessException
- public java.util.Iterator listActivations()
public java.lang.Object getActivationSemaphore()
public void waitForActivations()
getActivationSemaphore
public java.lang.String setStrategy(Strategy s) throws JessException
s
- JessException
- public final void setEvalSalience(int method) throws JessException
method
- One of the acceptable valuesJessException
- If something goes wrongpublic final int getEvalSalience()
public int run() throws JessException
JessException
- If anything goes wrong.protected void aboutToFire(Activation a)
protected void justFired(Activation a)
public int run(int max) throws JessException
max
- The maximum number of rules to fireJessException
- If anything goes wrong.public int runUntilHalt() throws JessException
public void halt()
public void addJessListener(JessListener jel)
public void removeJessListener(JessListener jel)
public int getEventMask()
public void setEventMask(int i)
public void bload(java.io.InputStream is) throws java.io.IOException, java.lang.ClassNotFoundException
public void bsave(java.io.OutputStream os) throws java.io.IOException
public Value definstance(java.lang.String jessTypename, java.lang.Object object, boolean dynamic) throws JessException
jessTypename
- The name of a defclassobject
- An object of the defclass's typedynamic
- true if PropertyChangeListeners should be usedpublic Value undefinstance(java.lang.Object o) throws JessException
object
- An object of the defclass's typepublic Value defclass(java.lang.String jessName, java.lang.String clazz, java.lang.String parent) throws JessException
jessName
- The name Jess should use for this defclassclazz
- The name of the Java classparent
- If non-null, a parent deftemplate or defclass namepublic java.applet.Applet getApplet()
public void setApplet(java.applet.Applet a)
a
- The appletpublic final Context getGlobalContext()
public Value executeCommand(java.lang.String cmd) throws JessException
cmd
- A string containing a value Jess functionJessException
- If anything goes wrongpublic final void setResetGlobals(boolean reset)
reset
- The value of this propertypublic final boolean getResetGlobals()
public Value store(java.lang.String name, Value val)
name
- A key under which to file the valueval
- The value to storefetch(java.lang.String)
public Value store(java.lang.String name, java.lang.Object val)
name
- A key under which to file the valueval
- The value to storepublic Value fetch(java.lang.String name)
name
- The key under which to find an objectstore(java.lang.String, jess.Value)
public void clearStorage()
public static jess.factory.Factory getFactory()
public static void setFactory(jess.factory.Factory f)
public java.util.Enumeration runQuery(java.lang.String name, ValueVector params) throws JessException
|
© 1997 E.J. Friedman-Hill and Sandia Corporation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |