com.hp.hpl.jena.rdf.model
Interface InfModel

All Superinterfaces:

Model, ModelCon, ModelLock, com.hp.hpl.jena.shared.PrefixMapping, RDFReaderF, RDFWriterF

public interface InfModel

extends Model

An extension to the normal Model interface that supports access to any underlying inference capability.

In Jena the primary use of inference is to generate additional entailments from a set of RDF data. These entailments just appear as additional RDF data in the inferred model and are accessed through the normal API. For example, if an inference engine can determine the class of a resource "foo" is "fooClass" then all Model API calls such as listStatements and getProperty should act as if the triple:

 foo rdf:type fooClass .
 

were in the data.

A few reasoner services cannot be made directly available in this way and the InfGraph extension gives access to these - specifically access to validation/consistency checking, derivation traces and find-with-posits.

Note that this interface, and especially the interface onto ValidityReports and Derivations are not yet stable.

Version:

$Revision: 1.4 $ on $Date: 2003/06/23 13:10:58 $

Author:

Dave Reynolds

Nested Class Summary

Nested classes inherited from class com.hp.hpl.jena.shared.PrefixMapping

com.hp.hpl.jena.shared.PrefixMapping.Factory, com.hp.hpl.jena.shared.PrefixMapping.IllegalPrefixException, com.hp.hpl.jena.shared.PrefixMapping.JenaLockedException

Field Summary

Fields inherited from interface com.hp.hpl.jena.shared.PrefixMapping

Standard

Fields inherited from interface com.hp.hpl.jena.rdf.model.ModelLock

READ, WRITE

Method Summary

java.util.Iterator	getDerivation(Statement statement) Return the derivation of the given statement (which should be the result of some previous list operation).
Model	getRawModel() Return the raw RDF model being processed (i.e. the argument to the Reasonder.bind call that created this InfModel).
Reasoner	getReasoner() Return the Reasoner which is being used to answer queries to this graph.
StmtIterator	listStatements(Resource subject, Property predicate, RDFNode object, Model posit) Find all the statements matching a pattern.
void	prepare() Perform any initial processing and caching.
void	rebind() Cause the inference model to reconsult the underlying data to take into account changes.
void	setDerivationLogging(boolean logOn) Switch on/off drivation logging.
ValidityReport	validate() Test the consistency of the underlying data.

Methods inherited from interface com.hp.hpl.jena.rdf.model.Model

abort, add, add, add, add, add, begin, close, commit, contains, contains, contains, containsAll, containsAll, containsAny, containsAny, containsResource, createList, createList, createList, createLiteral, createLiteral, createProperty, createReifiedStatement, createReifiedStatement, createResource, createResource, createResource, createStatement, createTypedLiteral, createTypedLiteral, createTypedLiteral, difference, equals, executeInTransaction, getAnyReifiedStatement, getGraph, getModelLock, getProperty, getProperty, getResource, independent, intersection, isEmpty, isIsomorphicWith, isReified, listNameSpaces, listObjects, listObjectsOfProperty, listObjectsOfProperty, listReifiedStatements, listReifiedStatements, listStatements, listStatements, listStatements, listSubjects, listSubjectsWithProperty, listSubjectsWithProperty, query, queryBindingsWith, queryHandler, read, read, read, read, read, read, register, remove, remove, remove, removeAllReifications, removeReification, size, supportsSetOperations, supportsTransactions, union, unregister, write, write, write, write, write, write

Methods inherited from interface com.hp.hpl.jena.rdf.model.ModelCon

add, add, add, add, add, add, add, add, add, add, add, contains, contains, contains, contains, contains, contains, contains, contains, createAlt, createAlt, createBag, createBag, createLiteral, createLiteral, createLiteral, createLiteral, createLiteral, createLiteral, createLiteral, createProperty, createResource, createResource, createResource, createResource, createSeq, createSeq, createStatement, createStatement, createStatement, createStatement, createStatement, createStatement, createStatement, createStatement, createStatement, createStatement, createTypedLiteral, createTypedLiteral, createTypedLiteral, createTypedLiteral, createTypedLiteral, createTypedLiteral, createTypedLiteral, createTypedLiteral, createTypedLiteral, getAlt, getAlt, getBag, getBag, getProperty, getRDFNode, getResource, getSeq, getSeq, listStatements, listStatements, listStatements, listStatements, listStatements, listStatements, listStatements, listSubjectsWithProperty, listSubjectsWithProperty, listSubjectsWithProperty, listSubjectsWithProperty, listSubjectsWithProperty, listSubjectsWithProperty, listSubjectsWithProperty, listSubjectsWithProperty, remove, remove

Methods inherited from interface com.hp.hpl.jena.rdf.model.RDFReaderF

getReader, getReader, setReaderClassName

Methods inherited from interface com.hp.hpl.jena.rdf.model.RDFWriterF

getWriter, getWriter, setWriterClassName

Methods inherited from interface com.hp.hpl.jena.shared.PrefixMapping

expandPrefix, getNsPrefixMap, getNsPrefixURI, getNsURIPrefix, lock, setNsPrefix, setNsPrefixes, setNsPrefixes, usePrefix

Methods inherited from interface com.hp.hpl.jena.rdf.model.ModelLock

enterCriticalSection, leaveCriticalSection

Method Detail

getRawModel

public Model getRawModel()

Return the raw RDF model being processed (i.e. the argument to the Reasonder.bind call that created this InfModel).

getReasoner

public Reasoner getReasoner()

Return the Reasoner which is being used to answer queries to this graph.

rebind

public void rebind()

Cause the inference model to reconsult the underlying data to take into account changes. Normally changes are made through the InfModel's add and remove calls are will be handled appropriately. However, in some cases changes are made "behind the InfModels's back" and this forces a full reconsult of the changed data.

prepare

public void prepare()

Perform any initial processing and caching. This call is optional. Most engines either have negligable set up work or will perform an implicit "prepare" if necessary. The call is provided for those occasions where substantial preparation work is possible (e.g. running a forward chaining rule system) and where an application might wish greater control over when this prepration is done rather than just leaving to be done at first query time.

validate

public ValidityReport validate()

Test the consistency of the underlying data. This normally tests the validity of the bound instance data against the bound schema data.

Returns:

a ValidityReport structure

listStatements

public StmtIterator listStatements(Resource subject,
                                   Property predicate,
                                   RDFNode object,
                                   Model posit)

Find all the statements matching a pattern.

Return an iterator over all the statements in a model that match a pattern. The statements selected are those whose subject matches the subject argument, whose predicate matches the predicate argument and whose object matchesthe object argument. If an argument is null it matches anything.

The s/p/o terms may refer to resources which are temporarily defined in the "posit" model. This allows one, for example, to query what resources are of type CE where CE is a class expression rather than a named class - put CE in the posit arg.

Parameters:

subject - The subject sought

predicate - The predicate sought

object - The value sought

Returns:

an iterator over the subjects

setDerivationLogging

public void setDerivationLogging(boolean logOn)

Switch on/off drivation logging. If this is switched on then every time an inference is a made that fact is recorded and the resulting record can be access through a later getDerivation call. This may consume a lot of space!

getDerivation

public java.util.Iterator getDerivation(Statement statement)

Return the derivation of the given statement (which should be the result of some previous list operation). Not all reasoneers will support derivations.

Returns:

an iterator over Derivation records or null if there is no derivation information available for this triple.