Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.mindswap.owl
Interface OWLModel

All Known Subinterfaces:
OWLKnowledgeBase, OWLOntology, OWLSKnowledgeBase, OWLSModel, OWLSOntology
public interface OWLModel

An abstract view for querying a KnowledgeBase or a single ontology.

Author:
Evren Sirin

Method Summary
 void addProperty(OWLIndividual ind, OWLDataProperty prop, java.lang.Object value)
           
 void addProperty(OWLIndividual ind, OWLDataProperty prop, OWLDataValue value)
           
 void addProperty(OWLIndividual ind, OWLDataProperty prop, java.lang.String value)
           
 void addProperty(OWLIndividual ind, OWLObjectProperty prop, OWLIndividual value)
           
 void addProperty(OWLIndividual ind, OWLProperty prop, OWLValue value)
           
 void addType(OWLIndividual ind, OWLClass c)
           
 void apply(AtomList atoms)
          Apply the given set of (ground) atoms to the model.
 void classify()
          Tell the reasoner to compute the subclass relations between all the named classes and find the instances of each class.
 AnyOrder createAnyOrder()
           
 AnyOrder createAnyOrder(java.net.URI uri)
           
 AtomicProcess createAtomicProcess()
           
 AtomicProcess createAtomicProcess(java.net.URI uri)
           
 Choice createChoice()
           
 Choice createChoice(java.net.URI uri)
           
 OWLClass createClass(java.net.URI uri)
           
 CompositeProcess createCompositeProcess()
           
 CompositeProcess createCompositeProcess(java.net.URI uri)
           
 ControlConstructBag createControlConstructBag(ControlConstruct item)
           
 ControlConstructList createControlConstructList(ControlConstruct item)
           
 OWLDataProperty createDataProperty(java.net.URI uri)
           
 OWLDataValue createDataValue(java.lang.Object value)
           
 OWLDataValue createDataValue(java.lang.Object value, java.net.URI datatypeURI)
           
 OWLDataValue createDataValue(java.lang.String value)
           
 OWLDataValue createDataValue(java.lang.String value, java.lang.String language)
           
 ForEach createForEach()
           
 ForEach createForEach(java.net.URI uri)
           
 Grounding createGrounding()
           
 Grounding createGrounding(java.net.URI uri)
           
 IfThenElse createIfThenElse()
           
 IfThenElse createIfThenElse(java.net.URI uri)
           
 OWLIndividual createIndividual(java.net.URI uri)
           
 Input createInput()
           
 Input createInput(java.net.URI uri)
           
 InputBinding createInputBinding()
           
 InputBinding createInputBinding(java.net.URI uri)
           
 OWLIndividual createInstance(OWLClass c)
           
 OWLIndividual createInstance(OWLClass c, java.net.URI uri)
           
 JavaAtomicGrounding createJavaAtomicGrounding()
           
 JavaAtomicGrounding createJavaAtomicGrounding(java.net.URI uri)
           
 Grounding createJavaGrounding()
           
 Grounding createJavaGrounding(java.net.URI uri)
           
 OWLSObjList createList()
           
 RDFList createList(ListVocabulary vocabulary)
           
 RDFList createList(ListVocabulary vocabulary, OWLIndividual item)
           
 RDFList createList(ListVocabulary vocabulary, OWLIndividualList items)
           
 OWLSObjList createList(OWLIndividual item)
           
 OWLSObjList createList(OWLIndividualList items)
           
 Local createLocal()
           
 Local createLocal(java.net.URI uri)
           
 OWLObjectProperty createObjectProperty(java.net.URI uri)
           
 Output createOutput()
           
 Output createOutput(java.net.URI uri)
           
 OutputBinding createOutputBinding()
           
 OutputBinding createOutputBinding(java.net.URI uri)
           
 Perform createPerform()
           
 Perform createPerform(OWLIndividual individual)
           
 Perform createPerform(java.net.URI uri)
           
 Produce createProduce()
           
 Produce createProduce(java.net.URI uri)
           
 Profile createProfile()
           
 Profile createProfile(java.net.URI uri)
           
 RepeatUntil createRepeatUntil()
           
 RepeatUntil createRepeatUntil(java.net.URI uri)
           
 RepeatWhile createRepeatWhile()
           
 RepeatWhile createRepeatWhile(java.net.URI uri)
           
 Result createResult()
           
 Result createResult(java.net.URI uri)
           
 Sequence createSequence()
           
 Sequence createSequence(java.net.URI uri)
           
 Service createService()
           
 Service createService(java.net.URI uri)
           
 ServiceParameter createServiceParameter()
           
 ServiceParameter createServiceParameter(java.net.URI uri)
           
 Split createSplit()
           
 Split createSplit(java.net.URI uri)
           
 SplitJoin createSplitJoin()
           
 SplitJoin createSplitJoin(java.net.URI uri)
           
 Condition createSWRLCondition()
           
 Condition createSWRLCondition(java.net.URI uri)
           
 Expression createSWRLExpression()
           
 Expression createSWRLExpression(java.net.URI uri)
           
 UPnPAtomicGrounding createUPnPAtomicGrounding()
           
 UPnPAtomicGrounding createUPnPAtomicGrounding(java.net.URI uri)
           
 MessageMap createUPnPMessageMap()
           
 MessageMap createUPnPMessageMap(java.net.URI uri)
           
 ValueData createValueData(OWLValue dataValue)
           
 ValueOf createValueOf()
           
 ValueOf createValueOf(java.net.URI uri)
           
 WSDLAtomicGrounding createWSDLAtomicGrounding()
           
 WSDLAtomicGrounding createWSDLAtomicGrounding(java.net.URI uri)
           
 MessageMap createWSDLInputMessageMap()
           
 MessageMap createWSDLInputMessageMap(java.net.URI uri)
           
 WSDLOperationRef createWSDLOperationRef()
           
 WSDLOperationRef createWSDLOperationRef(java.net.URI uri)
           
 MessageMap createWSDLOutputMessageMap()
           
 MessageMap createWSDLOutputMessageMap(java.net.URI uri)
           
 OWLOntology getBaseOntology()
          The ontology where the changes will go.
 OWLClass getClass(java.net.URI uri)
           
 OWLDataProperty getDataProperty(java.net.URI uri)
           
 OWLDataType getDataType(java.net.URI uri)
           
 OWLIndividualList getDifferentIndividuals(OWLIndividual ind)
           
 OWLEntity getEntity(java.net.URI uri)
           
 OWLIndividualList getEnumerations(OWLClass c)
          Returns the enumeration for the class (the list of individuals declared in the owl:oneOf list).
 java.util.Set getEquivalentClasses(OWLClass c)
           
 java.util.Set getEquivalentProperties(OWLProperty p)
           
 java.lang.Object getImplementation()
          Return the implementation specific object for this model.
 OWLIndividualList getIncomingProperties(OWLDataProperty prop, OWLDataValue value)
           
 OWLIndividualList getIncomingProperties(OWLIndividual ind)
           
 OWLIndividualList getIncomingProperties(OWLObjectProperty prop, OWLIndividual ind)
           
 OWLIndividual getIncomingProperty(OWLDataProperty prop, OWLDataValue value)
           
 OWLIndividual getIncomingProperty(OWLObjectProperty prop, OWLIndividual ind)
           
 OWLIndividual getIndividual(java.net.URI uri)
           
 OWLIndividualList getIndividuals()
           
 OWLIndividualList getInstances(OWLClass c)
           
 OWLObjectProperty getObjectProperty(java.net.URI uri)
           
 Process getProcess(java.net.URI processURI)
           
 java.util.List getProcesses()
           
 java.util.List getProcesses(int type)
           
 Profile getProfile(java.net.URI profileURI)
           
 java.util.List getProfiles()
           
 java.util.Map getProperties(OWLIndividual ind)
           
 OWLDataValueList getProperties(OWLIndividual ind, OWLDataProperty prop)
           
 OWLIndividualList getProperties(OWLIndividual ind, OWLObjectProperty prop)
           
 OWLDataValue getProperty(OWLIndividual ind, OWLDataProperty prop)
           
 OWLDataValue getProperty(OWLIndividual ind, OWLDataProperty prop, java.lang.String lang)
           
 OWLIndividual getProperty(OWLIndividual ind, OWLObjectProperty prop)
           
 OWLProperty getProperty(java.net.URI uri)
           
 java.lang.Object getReasoner()
           
 OWLIndividualList getSameIndividuals(OWLIndividual ind)
           
 Service getService(java.net.URI serviceURI)
           
 java.util.List getServices()
           
 java.util.Set getSubClasses(OWLClass c)
           
 java.util.Set getSubClasses(OWLClass c, boolean direct)
          Get all the (direct) subclasses of the given class
 java.util.Set getSubProperties(OWLProperty p)
           
 java.util.Set getSuperClasses(OWLClass c)
          Get all the superclasses of the given class
 java.util.Set getSuperClasses(OWLClass c, boolean direct)
          Get all the (direct) subclasses of the given class
 java.util.Set getSuperProperties(OWLProperty p)
           
 OWLClass getType(OWLIndividual ind)
           
 OWLType getType(java.net.URI uri)
           
 java.util.Set getTypes(OWLIndividual ind)
           
 boolean hasProperty(OWLIndividual ind, OWLProperty prop)
           
 boolean hasProperty(OWLIndividual ind, OWLProperty prop, OWLValue value)
           
 boolean isClassified()
          Returns true if the model is classifed.
 boolean isConsistent()
          Check if the model is consistent or not.
 boolean isDifferentFrom(OWLIndividual ind1, OWLIndividual ind2)
          Return true if given two individuals are different from each other as dictated by the semantics of owl:differentFrom.
 boolean isDisjoint(OWLClass c1, OWLClass c2)
           
 boolean isDisjoint(OWLType t1, OWLType t2)
           
 boolean isEnumerated(OWLClass c)
          Returns true if c is an enumerated class (defined with owl:oneOf)
 boolean isEquivalent(OWLType t1, OWLType t2)
           
 boolean isLockSupported()
          Checks if this implementation supports locking for concurrent access;
 boolean isSameAs(OWLIndividual ind1, OWLIndividual ind2)
          Return true if given two individuals are same as each other as dictated by the semantics of owl:sameAs.
 boolean isSubClassOf(OWLClass c1, OWLClass c2)
          Check if one class is subclass of another
 boolean isSubTypeOf(OWLDataType t1, OWLDataType t2)
           
 boolean isSubTypeOf(OWLType t1, OWLType t2)
           
 boolean isTrue(ABoxQuery query)
          Check if the conjunction of given atoms is entailed by the model.
 boolean isTrue(Condition condition)
          Check if the condition is true in this model.
 boolean isTrue(Condition condition, ValueMap binding)
          Apply the given binding to the condition, thus grounding some of the variables, and then check if this condition is true in this model.
 boolean isType(OWLIndividual ind, OWLClass c)
           
 void lockForRead()
          Lock the model for read operations.
 void lockForWrite()
          Lock the model for write operations.
 OWLIndividual parseLiteral(java.lang.String literal)
          Turn the RDF/XML representation into an OWLIndividual
 void prepare()
          Prepare the reasoner associated with this model.
 java.util.List query(ABoxQuery query)
          Answer the given ABoxQuery and return a List of ValueMap's that contains the bindings for the result variables of the query.
 java.util.List query(ABoxQuery query, ValueMap values)
          Answer the given ABoxQuery passing in an initial binding of some of the variables in the query.
 java.util.List query(java.lang.String query)
           
 void refresh()
          Refresh the data in this model from the original source.
 void releaseLock()
          Releases the lock form the matching lockForXXX function.
 void removeProperties(OWLIndividual ind, OWLProperty prop)
           
 void removeProperty(OWLIndividual theInd, OWLProperty theProp, OWLValue theValue)
          Removes the specified triple from the Model.
 void removeTypes(OWLIndividual ind)
           
 void setProperty(OWLIndividual ind, OWLDataProperty prop, java.lang.Object value)
           
 void setProperty(OWLIndividual ind, OWLDataProperty prop, OWLDataValue value)
           
 void setProperty(OWLIndividual ind, OWLDataProperty prop, java.lang.String value)
           
 void setProperty(OWLIndividual ind, OWLObjectProperty prop, OWLIndividual value)
           
 void setReasoner(java.lang.Object reasoner)
          Set the reasoner using an implementation specific reasoner object.
 void setReasoner(java.lang.String reasonerName)
          Set the reasoner of this model using a reasner name.
 

Method Detail

getImplementation

java.lang.Object getImplementation()
Return the implementation specific object for this model.

Returns:

refresh

void refresh()
Refresh the data in this model from the original source.

isConsistent

boolean isConsistent()
Check if the model is consistent or not. This functions will simply return true if there is no reasoner attached or the reasoner used does not support consistency check.

Returns:

prepare

void prepare()
Prepare the reasoner associated with this model.

classify

void classify()
Tell the reasoner to compute the subclass relations between all the named classes and find the instances of each class. The results will be cached and subsequent calls to queyr the model will use the cache. This call has no effect if reasoner does not support classification.

isClassified

boolean isClassified()
Returns true if the model is classifed.

setReasoner

void setReasoner(java.lang.String reasonerName)
Set the reasoner of this model using a reasner name. See OWLFactory.getReasoners() for available reasoner names.

For Jena based implementation available reasoner names are:

Parameters:
reasonerName -

setReasoner

void setReasoner(java.lang.Object reasoner)
Set the reasoner using an implementation specific reasoner object. The exact type of the parameter is different for Jena and OWL-API.

Parameters:
reasoner -

getReasoner

java.lang.Object getReasoner()
Returns:

getBaseOntology

OWLOntology getBaseOntology()
The ontology where the changes will go. If this model represents an OWLOntology object then it is the same ontology, if th emodel represents a OWLKnowledgeBase then it is the base ontology of the KB.

Returns:

createClass

OWLClass createClass(java.net.URI uri)
Parameters:
uri -
Returns:

createObjectProperty

OWLObjectProperty createObjectProperty(java.net.URI uri)
Parameters:
uri -
Returns:

createDataProperty

OWLDataProperty createDataProperty(java.net.URI uri)
Parameters:
uri -
Returns:

createIndividual

OWLIndividual createIndividual(java.net.URI uri)
Parameters:
uri -
Returns:

createInstance

OWLIndividual createInstance(OWLClass c)
Parameters:
c -
Returns:

createInstance

OWLIndividual createInstance(OWLClass c,
                             java.net.URI uri)
Parameters:
c -
uri -
Returns:

createDataValue

OWLDataValue createDataValue(java.lang.String value)
Parameters:
value -
Returns:

createDataValue

OWLDataValue createDataValue(java.lang.String value,
                             java.lang.String language)
Parameters:
value -
language -
Returns:

createDataValue

OWLDataValue createDataValue(java.lang.Object value,
                             java.net.URI datatypeURI)
Parameters:
value -
datatypeURI -
Returns:

createDataValue

OWLDataValue createDataValue(java.lang.Object value)
Parameters:
value -
Returns:

getClass

OWLClass getClass(java.net.URI uri)
Parameters:
uri -
Returns:

getIndividual

OWLIndividual getIndividual(java.net.URI uri)
Parameters:
uri -
Returns:

getIndividuals

OWLIndividualList getIndividuals()

getProperty

OWLProperty getProperty(java.net.URI uri)
Parameters:
uri -
Returns:

getObjectProperty

OWLObjectProperty getObjectProperty(java.net.URI uri)
Parameters:
uri -
Returns:

getDataProperty

OWLDataProperty getDataProperty(java.net.URI uri)
Parameters:
uri -
Returns:

getDataType

OWLDataType getDataType(java.net.URI uri)
Parameters:
uri -
Returns:

getType

OWLType getType(java.net.URI uri)
Parameters:
uri -
Returns:

getEntity

OWLEntity getEntity(java.net.URI uri)
Parameters:
uri -
Returns:

setProperty

void setProperty(OWLIndividual ind,
                 OWLDataProperty prop,
                 java.lang.String value)
Parameters:
ind -
prop -
value -

setProperty

void setProperty(OWLIndividual ind,
                 OWLDataProperty prop,
                 OWLDataValue value)
Parameters:
ind -
prop -
value -

setProperty

void setProperty(OWLIndividual ind,
                 OWLDataProperty prop,
                 java.lang.Object value)
Parameters:
ind -
prop -
value -

addProperty

void addProperty(OWLIndividual ind,
                 OWLProperty prop,
                 OWLValue value)

addProperty

void addProperty(OWLIndividual ind,
                 OWLDataProperty prop,
                 OWLDataValue value)
Parameters:
ind -
prop -
value -

addProperty

void addProperty(OWLIndividual ind,
                 OWLDataProperty prop,
                 java.lang.Object value)

addProperty

void addProperty(OWLIndividual ind,
                 OWLDataProperty prop,
                 java.lang.String value)

removeProperties

void removeProperties(OWLIndividual ind,
                      OWLProperty prop)
Parameters:
ind -
prop -

removeProperty

void removeProperty(OWLIndividual theInd,
                    OWLProperty theProp,
                    OWLValue theValue)
Removes the specified triple from the Model.

Parameters:
theInd - OWLIndividual
theProp - OWLProperty
theValue - OWLValue

addProperty

void addProperty(OWLIndividual ind,
                 OWLObjectProperty prop,
                 OWLIndividual value)
Parameters:
ind -
prop -
value -

setProperty

void setProperty(OWLIndividual ind,
                 OWLObjectProperty prop,
                 OWLIndividual value)
Parameters:
ind -
prop -
value -

addType

void addType(OWLIndividual ind,
             OWLClass c)
Parameters:
ind -
c -

removeTypes

void removeTypes(OWLIndividual ind)
Parameters:
ind -

isEnumerated

boolean isEnumerated(OWLClass c)
Returns true if c is an enumerated class (defined with owl:oneOf)

Parameters:
c -
Returns:

getEnumerations

OWLIndividualList getEnumerations(OWLClass c)
Returns the enumeration for the class (the list of individuals declared in the owl:oneOf list).

Parameters:
c -
Returns:
List of individuals or null if the class is not enumerated

isSubClassOf

boolean isSubClassOf(OWLClass c1,
                     OWLClass c2)
Check if one class is subclass of another

Parameters:
c1 -
c2 -
Returns:

isSubTypeOf

boolean isSubTypeOf(OWLDataType t1,
                    OWLDataType t2)
Parameters:
t1 -
t2 -
Returns:

isSubTypeOf

boolean isSubTypeOf(OWLType t1,
                    OWLType t2)
Parameters:
t1 -
t2 -
Returns:

isEquivalent

boolean isEquivalent(OWLType t1,
                     OWLType t2)
Parameters:
t1 -
t2 -
Returns:

isDisjoint

boolean isDisjoint(OWLType t1,
                   OWLType t2)
Parameters:
t1 -
t2 -
Returns:

isDisjoint

boolean isDisjoint(OWLClass c1,
                   OWLClass c2)
Parameters:
c1 -
c2 -
Returns:

getSubClasses

java.util.Set getSubClasses(OWLClass c)
Parameters:
c -
Returns:

getSubClasses

java.util.Set getSubClasses(OWLClass c,
                            boolean direct)
Get all the (direct) subclasses of the given class

Parameters:
c -
direct -
Returns:

getSuperClasses

java.util.Set getSuperClasses(OWLClass c)
Get all the superclasses of the given class

Parameters:
c -
Returns:

getSuperClasses

java.util.Set getSuperClasses(OWLClass c,
                              boolean direct)
Get all the (direct) subclasses of the given class

Parameters:
c -
direct -
Returns:

getEquivalentClasses

java.util.Set getEquivalentClasses(OWLClass c)
Parameters:
c -
Returns:

getSubProperties

java.util.Set getSubProperties(OWLProperty p)
Parameters:
p -
Returns:

getSuperProperties

java.util.Set getSuperProperties(OWLProperty p)
Parameters:
p -
Returns:

getEquivalentProperties

java.util.Set getEquivalentProperties(OWLProperty p)
Parameters:
p -
Returns:

getInstances

OWLIndividualList getInstances(OWLClass c)
Parameters:
c -
Returns:

isType

boolean isType(OWLIndividual ind,
               OWLClass c)
Parameters:
ind -
c -
Returns:

getType

OWLClass getType(OWLIndividual ind)
Parameters:
ind -
Returns:

getTypes

java.util.Set getTypes(OWLIndividual ind)
Parameters:
ind -
Returns:

getProperty

OWLIndividual getProperty(OWLIndividual ind,
                          OWLObjectProperty prop)
Parameters:
ind -
prop -
Returns:

getProperties

OWLIndividualList getProperties(OWLIndividual ind,
                                OWLObjectProperty prop)
Parameters:
ind -
prop -
Returns:

getProperties

java.util.Map getProperties(OWLIndividual ind)
Parameters:
ind -
Returns:

getProperty

OWLDataValue getProperty(OWLIndividual ind,
                         OWLDataProperty prop)
Parameters:
ind -
prop -
Returns:

getProperty

OWLDataValue getProperty(OWLIndividual ind,
                         OWLDataProperty prop,
                         java.lang.String lang)
Parameters:
ind -
prop -
lang -
Returns:

getProperties

OWLDataValueList getProperties(OWLIndividual ind,
                               OWLDataProperty prop)
Parameters:
ind -
prop -
Returns:

getIncomingProperty

OWLIndividual getIncomingProperty(OWLObjectProperty prop,