| java.lang.Object
 com.hp.hpl.jena.reasoner.rulesys.FBRuleReasoner
All known Subclasses: com.hp.hpl.jena.reasoner.rulesys.GenericRuleReasoner, com.hp.hpl.jena.reasoner.rulesys.OWLFBRuleReasoner, com.hp.hpl.jena.reasoner.rulesys.impl.oldCode.OWLExptRuleReasoner, com.hp.hpl.jena.reasoner.rulesys.RDFSFBRuleReasoner,
| FBRuleReasoner | | public class FBRuleReasoner implements RuleReasoner(Code) | | Rule-based reasoner interface. This is the default rule reasoner to use.
It supports both forward reasoning and backward reasoning, including use
of forward rules to generate and instantiate backward rules.
author:
Dave Reynolds
version:
$Revision: 1.26 $ on $Date: 2008/01/02 12:07:47 $ |
| Method Summary | |
| public void | addDescription(Model configSpec, Resource base)
Add a configuration description for this reasoner into a partial
configuration specification model. | | public FBRuleReasoner | addRules(List rules)
Add the given rules to the current set and answer this Reasoner. | | public InfGraph | bind(Graph data)
Attach the reasoner to a set of RDF data to process.
The reasoner may already have been bound to specific rules or ontology
axioms (encoded in RDF) through earlier bindRuleset calls.
Parameters:
data - the RDF data to be processed, some reasoners may restrictthe range of RDF which is legal here (e.g. | | public Reasoner | bindSchema(Graph tbox)
Precompute the implications of a schema graph. | | public Reasoner | bindSchema(Model tbox)
Precompute the implications of a schema Model. | | protected boolean | doSetParameter(Property parameter, Object value)
Set a configuration parameter for the reasoner. | | protected boolean | doSetRDFNodeParameter(Property parameter, RDFNode value)
Set a parameter from a statement, given the property and its RDFNode value.
Most parameters are, historically, set from the string value of the RDFNode,
but newer parameters may have Resource values with embedded models,
for which their toString() is not just suspect, but definitively wrong. | | protected boolean | doSetResourceParameter(Property parameter, Resource value)
Set a parameter with a Resource value. | | public Capabilities | getGraphCapabilities()
Return the Jena Graph Capabilties that the inference graphs generated
by this reasoner are expected to conform to. | | protected synchronized InfGraph | getPreload()
Get the single static precomputed rule closure. | | public Model | getReasonerCapabilities()
Return a description of the capabilities of this reasoner encoded in
RDF. | | public List | getRules()
| | public boolean | isTraceOn()
Return the state of the trace flag.If set to true then rule firings
are logged out to the Log at "INFO" level. | | protected void | loadConfiguration(Resource configuration)
load the configuration from the configuring Resource (in its Model). | | public static List | loadRules(String fileName)
Answer the list of rules loaded from the given filename. | | public void | setDerivationLogging(boolean logOn)
Switch on/off drivation logging.
If set to true then the InfGraph created from the bind operation will start
life with recording of derivations switched on. | | public void | setParameter(Property parameter, Object value)
Set a configuration parameter for the reasoner. | | public void | setRules(List rules)
Set (or change) the rule set that this reasoner should execute. | | public void | setTraceOn(boolean state)
Set the state of the trace flag. | | public boolean | supportsProperty(Property property)
Determine whether the given property is recognized and treated specially
by this reasoner. | | public synchronized void | tablePredicate(Node predicate)
Register an RDF predicate as one whose presence in a goal should force
the goal to be tabled. |
| cachePreload | | final protected static boolean cachePreload(Code) | | Flag, if true we cache the closure of the pure rule set with its axioms
|
| capabilities | | protected Capabilities capabilities(Code) | | The graph capabilities of the infgraphs generated by this reasoner
|
| configuration | | protected Resource configuration(Code) | | The original configuration properties, if any
|
| factory | | protected ReasonerFactory factory(Code) | | The parent reasoner factory which is consulted to answer capability questions
|
| preload | | protected InfGraph preload(Code) | | The cached empty closure, if wanted
|
| recordDerivations | | protected boolean recordDerivations(Code) | | Flag to set whether the inference class should record derivations
|
| rules | | protected List rules(Code) | | The rules to be used by this instance of the forward engine
|
| schemaGraph | | protected Graph schemaGraph(Code) | | A precomputed set of schema deductions
|
| traceOn | | boolean traceOn(Code) | | Flag which, if true, enables tracing of rule actions to logger.info
|
| FBRuleReasoner | | public FBRuleReasoner(List rules)(Code) | | Constructor. This is the raw version that does not reference a ReasonerFactory
and so has no capabilities description.
Parameters:
rules - a list of Rule instances which defines the ruleset to process |
| FBRuleReasoner | | public FBRuleReasoner(ReasonerFactory factory)(Code) | | Constructor
Parameters:
factory - the parent reasoner factory which is consulted to answer capability questions |
| FBRuleReasoner | | public FBRuleReasoner(ReasonerFactory factory, Resource configuration)(Code) | | Constructor
Parameters:
factory - the parent reasoner factory which is consulted to answer capability questions
Parameters:
configuration - RDF node to configure the rule set and mode, can be null |
| FBRuleReasoner | | public FBRuleReasoner(List rules, ReasonerFactory factory)(Code) | | Constructor
Parameters:
rules - a list of Rule instances which defines the ruleset to process
Parameters:
factory - the parent reasoner factory which is consulted to answer capability questions |
| FBRuleReasoner | | protected FBRuleReasoner(List rules, Graph schemaGraph, ReasonerFactory factory)(Code) | | Internal constructor, used to generated a partial binding of a schema
to a rule reasoner instance.
|
| addDescription | | public void addDescription(Model configSpec, Resource base)(Code) | | Add a configuration description for this reasoner into a partial
configuration specification model.
Parameters:
configSpec - a Model into which the configuration information should be placed
Parameters:
base - the Resource to which the configuration parameters should be added. |
| addRules | | public FBRuleReasoner addRules(List rules)(Code) | | Add the given rules to the current set and answer this Reasoner. Provided
so that the Factory can deal out reasoners with specified rulesets.
There may well be a better way to arrange this.
TODO review & revise
|
| bind | | public InfGraph bind(Graph data) throws ReasonerException(Code) | | Attach the reasoner to a set of RDF data to process.
The reasoner may already have been bound to specific rules or ontology
axioms (encoded in RDF) through earlier bindRuleset calls.
Parameters:
data - the RDF data to be processed, some reasoners may restrictthe range of RDF which is legal here (e.g. syntactic restrictions in OWL). an inference graph through which the data+reasoner can be queried.
throws:
ReasonerException - if the data is ill-formed according to theconstraints imposed by this reasoner. |
| bindSchema | | public Reasoner bindSchema(Graph tbox) throws ReasonerException(Code) | | Precompute the implications of a schema graph. The statements in the graph
will be combined with the data when the final InfGraph is created.
|
| bindSchema | | public Reasoner bindSchema(Model tbox) throws ReasonerException(Code) | | Precompute the implications of a schema Model. The statements in the graph
will be combined with the data when the final InfGraph is created.
|
| doSetParameter | | protected boolean doSetParameter(Property parameter, Object value)(Code) | | Set a configuration parameter for the reasoner. The supported parameters
are:
- PROPderivationLogging - set to true to enable recording all rule derivations
- PROPtraceOn - set to true to enable verbose trace information to be sent to the logger INFO channel
Parameters:
parameter - the property identifying the parameter to be changed
Parameters:
value - the new value for the parameter, typically this is a wrappedjava object like Boolean or Integer. false if the parameter was not known |
| doSetRDFNodeParameter | | protected boolean doSetRDFNodeParameter(Property parameter, RDFNode value)(Code) | | Set a parameter from a statement, given the property and its RDFNode value.
Most parameters are, historically, set from the string value of the RDFNode,
but newer parameters may have Resource values with embedded models,
for which their toString() is not just suspect, but definitively wrong. Hence the
introduction of this relay station.
Parameters:
parameter - the propoerty naming the value to set
Parameters:
value - the RDFNode with the value of that property true if the property was understood, false otherwise |
| doSetResourceParameter | | protected boolean doSetResourceParameter(Property parameter, Resource value)(Code) | | Set a parameter with a Resource value. Answer false if the parameter is not
understood. Default understands no parameters; subclasses may override.
|
| getGraphCapabilities | | public Capabilities getGraphCapabilities()(Code) | | Return the Jena Graph Capabilties that the inference graphs generated
by this reasoner are expected to conform to.
|
| getPreload | | protected synchronized InfGraph getPreload()(Code) | | Get the single static precomputed rule closure.
|
| getReasonerCapabilities | | public Model getReasonerCapabilities()(Code) | | Return a description of the capabilities of this reasoner encoded in
RDF. These capabilities may be static or may depend on configuration
information supplied at construction time. May be null if there are
no useful capabilities registered.
|
| getRules | | public List getRules()(Code) | | Return the list of Rules used by this reasoner
a List of Rule objects |
| isTraceOn | | public boolean isTraceOn()(Code) | | Return the state of the trace flag.If set to true then rule firings
are logged out to the Log at "INFO" level.
|
| loadConfiguration | | protected void loadConfiguration(Resource configuration)(Code) | | load the configuration from the configuring Resource (in its Model).
|
| loadRules | | public static List loadRules(String fileName)(Code) | | Answer the list of rules loaded from the given filename. May throw a
ReasonerException wrapping an IOException.
|
| setDerivationLogging | | public void setDerivationLogging(boolean logOn)(Code) | | Switch on/off drivation logging.
If set to true then the InfGraph created from the bind operation will start
life with recording of derivations switched on. This is currently only of relevance
to rule-based reasoners.
Default - false.
|
| setParameter | | public void setParameter(Property parameter, Object value)(Code) | | Set a configuration parameter for the reasoner. The supported parameters
are:
- PROPderivationLogging - set to true to enable recording all rule derivations
- PROPtraceOn - set to true to enable verbose trace information to be sent to the logger INFO channel
Parameters:
parameter - the property identifying the parameter to be changed
Parameters:
value - the new value for the parameter, typically this is a wrappedjava object like Boolean or Integer.
throws:
IllegalParameterException - if the parameter is unknown |
| setRules | | public void setRules(List rules)(Code) | | Set (or change) the rule set that this reasoner should execute.
Parameters:
rules - a list of Rule objects |
| setTraceOn | | public void setTraceOn(boolean state)(Code) | | Set the state of the trace flag. If set to true then rule firings
are logged out to the Log at "INFO" level.
|
| supportsProperty | | public boolean supportsProperty(Property property)(Code) | | Determine whether the given property is recognized and treated specially
by this reasoner. This is a convenience packaging of a special case of getCapabilities.
Parameters:
property - the property which we want to ask the reasoner about, given as a Node sincethis is part of the SPI rather than API true if the given property is handled specially by the reasoner. |
| tablePredicate | | public synchronized void tablePredicate(Node predicate)(Code) | | Register an RDF predicate as one whose presence in a goal should force
the goal to be tabled. This is better done directly in the rule set.
|
|
|