org.coode.suggestor.api

Interface PropertySuggestor

public interface PropertySuggestor

The PropertySuggestor allows us to explore the relationships between the classes and properties in the ontology.

For more general discussion of the suggestor idea please see the package summary

Using the suggestor, we can ask the following questions:

• Which properties does this class have? (What have we said about this class?)
• Which properties could we add to this class?
• Which properties might we be most interested in adding to this class? (Sanctioning)

The following definitions are used in the API definition:

Direct

The direct flag is used to control redundancy. If property p holds for a query in the general case then the direct case only holds if there is no q where StrictSubObjectPropertyOf(q, p) and isCurrent(q, c) is entailed

StrictSub[Object|Data]PropertyOf

For the definition of StrictSubData/ObjectPropertyOf see the OWLAPI OWLReasoner.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSanctionRule(PropertySanctionRule rule) Add a PropertySanctionRule to the end of the rules used for sanctioning
org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLDataProperty>	getCurrentDataProperties(org.semanticweb.owlapi.model.OWLClassExpression c, boolean direct)
org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLObjectPropertyExpression>	getCurrentObjectProperties(org.semanticweb.owlapi.model.OWLClassExpression c, boolean direct)
org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLDataProperty>	getPossibleDataProperties(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty root, boolean direct)
org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLObjectPropertyExpression>	getPossibleObjectProperties(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression root, boolean direct)
org.semanticweb.owlapi.reasoner.OWLReasoner	getReasoner()
Set<org.semanticweb.owlapi.model.OWLDataProperty>	getSanctionedDataProperties(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty root, boolean direct)
Set<org.semanticweb.owlapi.model.OWLObjectPropertyExpression>	getSanctionedObjectProperties(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression root, boolean direct)
boolean	isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty p)
boolean	isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty p, boolean direct)
boolean	isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p) SubClassOf(c, p some Thing) is entailed
boolean	isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p, boolean direct)
boolean	isPossible(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty p)
boolean	isPossible(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p)
boolean	isSanctioned(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty p) Determine if data property p is sanctioned for class c by iterating through all of the registered property sanction rules until one is successful or all fail.
boolean	isSanctioned(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p) Determine if property p is sanctioned for class c by iterating through all of the registered property sanction rules until one is successful or all fail.
void	removeSanctionRule(PropertySanctionRule rule) Remove this PropertySanctionRule from the rules used for sanctioning

Method Detail

isCurrent

boolean isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c,
                org.semanticweb.owlapi.model.OWLObjectPropertyExpression p)

SubClassOf(c, p some Thing) is entailed

Parameters:

c - a class expression

p - an object property

Returns:

true if SubClassOf(c, p some Thing) is entailed

isCurrent

boolean isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c,
                org.semanticweb.owlapi.model.OWLObjectPropertyExpression p,
                boolean direct)

Parameters:

c - a class expression

p - an object property

direct - (see definition above)

Returns:

isCurrent(c, p). If direct then there is no q where StrictSubObjectPropertyOf(q, p) and isCurrent(c, q) is entailed

isCurrent

boolean isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c,
                org.semanticweb.owlapi.model.OWLDataProperty p)

Parameters:

c - a class expression

p - a data property

Returns:

true if SubClassOf(c, p some Literal) is entailed

isCurrent

boolean isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c,
                org.semanticweb.owlapi.model.OWLDataProperty p,
                boolean direct)

Parameters:

c - a class expression

p - a data property

direct - (see definition above)

Returns:

isCurrent(c, p). If direct then there is no q where StrictSubDataPropertyOf(q, p) and isCurrent(c, q) is entailed

isPossible

boolean isPossible(org.semanticweb.owlapi.model.OWLClassExpression c,
                 org.semanticweb.owlapi.model.OWLObjectPropertyExpression p)

Parameters:

c - a class expression

p - an object property

Returns:

true if isSatisfiable(c and p some Thing)

isPossible

boolean isPossible(org.semanticweb.owlapi.model.OWLClassExpression c,
                 org.semanticweb.owlapi.model.OWLDataProperty p)

Parameters:

c - a class expression

p - a data property

Returns:

true if isSatisfiable(c and p some Literal)

isSanctioned

boolean isSanctioned(org.semanticweb.owlapi.model.OWLClassExpression c,
                   org.semanticweb.owlapi.model.OWLObjectPropertyExpression p)

Determine if property p is sanctioned for class c by iterating through all of the registered property sanction rules until one is successful or all fail. Only possible properties can be sanctioned.

Parameters:

c - a class expression

p - an object property

Returns:

true if isPossible(c, p) and ANY property sanction rule is met

isSanctioned

boolean isSanctioned(org.semanticweb.owlapi.model.OWLClassExpression c,
                   org.semanticweb.owlapi.model.OWLDataProperty p)

Determine if data property p is sanctioned for class c by iterating through all of the registered property sanction rules until one is successful or all fail. Only possible properties can be sanctioned.

Parameters:

c - a class expression

p - a data property

Returns:

true if isPossible(c, p) and ANY property sanction rule is met

getCurrentObjectProperties

org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLObjectPropertyExpression> getCurrentObjectProperties(org.semanticweb.owlapi.model.OWLClassExpression c,
                                                                                                                           boolean direct)

Parameters:

c - a class expression

direct - (see definition above)

Returns:

a set of objectproperties where every p satisfies isCurrent(c, p, direct)

getCurrentDataProperties

org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLDataProperty> getCurrentDataProperties(org.semanticweb.owlapi.model.OWLClassExpression c,
                                                                                                             boolean direct)

Parameters:

c - a class expression

direct - (see definition above)

Returns:

a set of dataproperties where every p satisfies isCurrent(c, p, direct)

getPossibleObjectProperties

org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLObjectPropertyExpression> getPossibleObjectProperties(org.semanticweb.owlapi.model.OWLClassExpression c,
                                                                                                                            org.semanticweb.owlapi.model.OWLObjectPropertyExpression root,
                                                                                                                            boolean direct)

Parameters:

c - a class expression

root - an ObjectProperty from which we start our search

direct - whether to search the subclasses or descendants of root

Returns:

a set of objectproperties where every p satisfies StrictSubPropertyOf(p, root) or DescendantOf(p, root) and isPossible(c, p)

getPossibleDataProperties

org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLDataProperty> getPossibleDataProperties(org.semanticweb.owlapi.model.OWLClassExpression c,
                                                                                                              org.semanticweb.owlapi.model.OWLDataProperty root,
                                                                                                              boolean direct)

Parameters:

c - a class expression

root - a DataProperty from which we start our search

direct - whether to search the subclasses or descendants of root

Returns:

a set of dataproperties where every p satisfies StrictSubPropertyOf(p, root) or DescendantOf(p, root) and isPossible(c, p)

getSanctionedObjectProperties

Set<org.semanticweb.owlapi.model.OWLObjectPropertyExpression> getSanctionedObjectProperties(org.semanticweb.owlapi.model.OWLClassExpression c,
                                                                                          org.semanticweb.owlapi.model.OWLObjectPropertyExpression root,
                                                                                          boolean direct)

Parameters:

c - a class expression

root - an ObjectProperty from which we start our search

direct - whether to search the subclasses or descendants of root

Returns:

a set of objectproperties where every p satisfies StrictSubPropertyOf(p, root) or DescendantOf(p, root) and isSanctioned(c, p)

getSanctionedDataProperties

Set<org.semanticweb.owlapi.model.OWLDataProperty> getSanctionedDataProperties(org.semanticweb.owlapi.model.OWLClassExpression c,
                                                                            org.semanticweb.owlapi.model.OWLDataProperty root,
                                                                            boolean direct)

Parameters:

c - a class expression

root - a DataProperty from which we start our search

direct - whether to search the subclasses or descendants of root

Returns:

a set of dataproperties where every p satisfies StrictSubPropertyOf(p, root) or DescendantOf(p, root) and isSanctioned(c, p)

addSanctionRule

void addSanctionRule(PropertySanctionRule rule)

Add a PropertySanctionRule to the end of the rules used for sanctioning

Parameters:

rule - the rule to add

removeSanctionRule

void removeSanctionRule(PropertySanctionRule rule)

Remove this PropertySanctionRule from the rules used for sanctioning

Parameters:

rule - the rule to remove

getReasoner

org.semanticweb.owlapi.reasoner.OWLReasoner getReasoner()

Returns:

get the reasoner used by this suggestor instance