org.coode.suggestor.api

Interface FillerSuggestor

public interface FillerSuggestor

The FillerSuggestor allows us to explore the relationships between the classes in the ontology.

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

To help with the notion of "property values" or "local ranges".

Filler level questions - Given a class description and an object property:

1. What are the named fillers on these properties?
2. What are the possible named fillers for a new existential restriction?
3. What are the sanctioned named fillers for a new existential restriction?

The following definitions are used in the API definition:

Direct

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

For the definition of StrictSubClassOf see the OWLAPI OWLReasoner.

Method Summary

Modifier and Type	Method and Description
void	addSanctionRule(FillerSanctionRule rule) Add a FillerSanctionRule to the end of the rules used for sanctioning
org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLClass>	getCurrentNamedFillers(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p, boolean direct)
org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLClass>	getPossibleNamedFillers(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p, org.semanticweb.owlapi.model.OWLClassExpression root, boolean direct) Find subclasses (or descendants) of root for which isPossible() holds.
org.semanticweb.owlapi.reasoner.OWLReasoner	getReasoner()
java.util.Set<org.semanticweb.owlapi.model.OWLClass>	getSanctionedFillers(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p, org.semanticweb.owlapi.model.OWLClassExpression root, boolean direct) Find subclasses (or descendants) of root for which isSanctioned() holds.
boolean	isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty p, org.semanticweb.owlapi.model.OWLDataRange f)
boolean	isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty p, org.semanticweb.owlapi.model.OWLDataRange f, boolean direct)
boolean	isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p, org.semanticweb.owlapi.model.OWLClassExpression f)
boolean	isCurrent(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p, org.semanticweb.owlapi.model.OWLClassExpression f, boolean direct)
boolean	isPossible(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty p, org.semanticweb.owlapi.model.OWLDataRange f)
boolean	isPossible(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p, org.semanticweb.owlapi.model.OWLClassExpression f)
boolean	isRedundant(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p, org.semanticweb.owlapi.model.OWLClassExpression f) Roughly speaking, would adding SubClassOf(c, p some f) fail to usefully "specialise" c
boolean	isSanctioned(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLDataProperty p, org.semanticweb.owlapi.model.OWLDataRange f)
boolean	isSanctioned(org.semanticweb.owlapi.model.OWLClassExpression c, org.semanticweb.owlapi.model.OWLObjectPropertyExpression p, org.semanticweb.owlapi.model.OWLClassExpression f)
void	removeSanctionRule(FillerSanctionRule rule) Remove this FillerSanctionRule from the rules used for sanctioning

Method Detail

isCurrent

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

Parameters:

c - a class expression

p - an object property

f - a filler class expression

Returns:

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

isCurrent

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

Parameters:

c - a class expression

p - an object property

f - a filler class expression

direct - (see definition above)

Returns:

isCurrent(c, p, f). If direct then there is no g where StrictSubClassOf(g, f) and isCurrent(c, p, g) is true

isCurrent

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

Parameters:

c - a class expression

p - a data property

f - a filler data range

Returns:

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

isCurrent

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

Parameters:

c - class

p - property

f - filler

direct - direct

Returns:

true if current

isPossible

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

Parameters:

c - a class expression

p - an object property

f - a filler class expression

Returns:

true if isSatisfiable(c and p some f)

isPossible

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

Parameters:

c - a class expression

p - a data property

f - a filler data range

Returns:

true if isSatisfiable(c and p some f)

isSanctioned

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

Parameters:

c - a class expression

p - an object property

f - a filler class expression

Returns:

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

isSanctioned

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

Parameters:

c - a class expression

p - a data property

f - a filler data range

Returns:

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

isRedundant

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

Roughly speaking, would adding SubClassOf(c, p some f) fail to usefully "specialise" c

Parameters:

c - a class expression

p - an object property

f - a filler class expression

Returns:

isCurrent(c, p, f) or there is a g such that StrictSubClassOf(g, f) and isCurrent(c, p, g) or SubClassOf(c, p only g)

getCurrentNamedFillers

org.semanticweb.owlapi.reasoner.NodeSet<org.semanticweb.owlapi.model.OWLClass> getCurrentNamedFillers(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:

a set of named class fillers where every f satisfies isCurrent(c, p, f, direct)

getPossibleNamedFillers

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

Find subclasses (or descendants) of root for which isPossible() holds.

Parameters:

c - a class expression

p - an object property

root - the class from which we start our search

direct - controls whether subclasses or descendants of root are searched

Returns:

a set of named class fillers where every f satisfies StrictSubClassOf(f, root) or StrictDescendantOf(f, root) and isPossible(c, p, f)

getSanctionedFillers

java.util.Set<org.semanticweb.owlapi.model.OWLClass> getSanctionedFillers(org.semanticweb.owlapi.model.OWLClassExpression c,
                                                                          org.semanticweb.owlapi.model.OWLObjectPropertyExpression p,
                                                                          org.semanticweb.owlapi.model.OWLClassExpression root,
                                                                          boolean direct)

Find subclasses (or descendants) of root for which isSanctioned() holds.

Parameters:

c - a class expression

p - an object property

root - the class from which we start our search

direct - controls whether subclasses or descendants of root are searched

Returns:

a set of named class fillers where every f satisfies StrictSubClassOf(f, root) or StrictDescendantOf(f, root) and isSanctioned(c, p, f, direct)

addSanctionRule

void addSanctionRule(FillerSanctionRule rule)

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

Parameters:

rule - the rule to add

removeSanctionRule

void removeSanctionRule(FillerSanctionRule rule)

Remove this FillerSanctionRule 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