edu.stanford.smi.protegex.owl.model
Interface OWLRestriction

All Superinterfaces:

edu.stanford.smi.protege.model.Cls, Comparable, edu.stanford.smi.protege.model.Frame, edu.stanford.smi.protege.model.Instance, OWLAnonymousClass, OWLClass, ProtegeCls, ProtegeInstance, RDFObject, RDFResource, RDFSClass, Visitable

All Known Subinterfaces:

OWLAllValuesFrom, OWLCardinality, OWLCardinalityBase, OWLExistentialRestriction, OWLHasValue, OWLMaxCardinality, OWLMinCardinality, OWLQuantifierRestriction, OWLSomeValuesFrom

All Known Implementing Classes:

AbstractOWLCardinalityBase, AbstractOWLQuantifierRestriction, AbstractOWLRestriction, DefaultOWLAllValuesFrom, DefaultOWLCardinality, DefaultOWLHasValue, DefaultOWLMaxCardinality, DefaultOWLMinCardinality, DefaultOWLSomeValuesFrom

public interface OWLRestriction

extends OWLAnonymousClass

The base class of all OWL restriction classes.

Author:

Holger Knublauch

Method Summary

void	checkFillerText(String value) Checks the filler from a textual expression.
RDFProperty	getFillerProperty() Gets the Slot that is used to store the filler at this kind of restriction (e.g., owl:cardinality).
String	getFillerText() Gets the filler of this restriction for display purposes.
RDFProperty	getOnProperty() Gets the Slot that is restricted by this restriction.
char	getOperator() Gets the Unicode operator character that is typically used to represent this type of restriction.
boolean	isDefined() Checks whether this restriction has been completely defined already.
void	setFillerText(String value) Sets the filler from a (valid) textual expression.
void	setOnProperty(RDFProperty property) Sets the restricted property at this restriction.

Methods inherited from interface edu.stanford.smi.protegex.owl.model.OWLAnonymousClass

getExpressionRoot, getOwner

Methods inherited from interface edu.stanford.smi.protegex.owl.model.RDFSClass

addClassListener, addSuperclass, createClone, createInstance, getDependingClasses, getEquivalentClasses, getImageIcon, getInferredInstanceCount, getInferredInstances, getInstanceCount, getInstances, getNamedSubclasses, getNamedSubclasses, getNamedSuperclasses, getNamedSuperclasses, getNestedBrowserText, getNestedNamedClasses, getParsableExpression, getPureSuperclasses, getSubclassCount, getSubclasses, getSuperclassCount, getSuperclasses, getUnionDomainProperties, getUnionDomainProperties, hasEquivalentClass, hasPropertyValueWithBrowserText, isAnonymous, isMetaclass, isSubclassOf, removeClassListener, removeSuperclass

Methods inherited from interface edu.stanford.smi.protegex.owl.model.ProtegeCls

addClsListener, addDirectSuperclass, addDirectTemplateSlot, addTemplateFacetValue, addTemplateSlotValue, createDirectInstance, getBrowserSlotPattern, getConcreteSubclasses, getDirectBrowserSlotPattern, getDirectInstanceCount, getDirectInstances, getDirectlyOverriddenTemplateFacets, getDirectSubclassCount, getDirectSubclasses, getDirectSuperclassCount, getDirectSuperclasses, getDirectTemplateFacetValues, getDirectTemplateSlots, getDirectTemplateSlotValues, getInheritedBrowserSlotPattern, getInstanceCount, getInstances, getOverriddenTemplateFacets, getSubclasses, getSuperclasses, getTemplateFacets, getTemplateFacetValue, getTemplateFacetValues, getTemplateSlotAllowedClses, getTemplateSlotAllowedParents, getTemplateSlotAllowedValues, getTemplateSlotAllowsMultipleValues, getTemplateSlotDefaultValues, getTemplateSlotDocumentation, getTemplateSlotMaximumCardinality, getTemplateSlotMaximumValue, getTemplateSlotMinimumCardinality, getTemplateSlotMinimumValue, getTemplateSlots, getTemplateSlotValue, getTemplateSlotValues, getTemplateSlotValueType, getVisibleDirectSubclassCount, getVisibleDirectSubclasses, getVisibleTemplateSlots, hasDirectlyOverriddenTemplateFacet, hasDirectlyOverriddenTemplateSlot, hasDirectSuperclass, hasDirectTemplateSlot, hasInheritedTemplateSlot, hasOverriddenTemplateFacet, hasOverriddenTemplateSlot, hasSuperclass, hasTemplateFacet, hasTemplateSlot, isAbstract, isClsMetaCls, isConcrete, isDefaultClsMetaCls, isDefaultFacetMetaCls, isDefaultSlotMetaCls, isFacetMetaCls, isMetaCls, isRoot, isSlotMetaCls, moveDirectSubclass, moveDirectTemplateSlot, removeClsListener, removeDirectSuperclass, removeDirectTemplateSlot, removeTemplateFacetOverrides, setAbstract, setDirectBrowserSlot, setDirectBrowserSlotPattern, setDirectTypeOfSubclasses, setTemplateFacetValue, setTemplateFacetValues, setTemplateSlotAllowedClses, setTemplateSlotAllowedParents, setTemplateSlotAllowedValues, setTemplateSlotAllowsMultipleValues, setTemplateSlotDefaultValues, setTemplateSlotDocumentation, setTemplateSlotDocumentation, setTemplateSlotMaximumCardinality, setTemplateSlotMaximumValue, setTemplateSlotMinimumCardinality, setTemplateSlotMinimumValue, setTemplateSlotValue, setTemplateSlotValues, setTemplateSlotValueType

Methods inherited from interface edu.stanford.smi.protegex.owl.model.ProtegeInstance

addDirectType, addFrameListener, addInstanceListener, addOwnFacetValue, addOwnSlotValue, areValidOwnSlotValues, copy, deepCopy, getBrowserText, getDirectOwnSlotValue, getDirectOwnSlotValues, getDirectType, getDirectTypes, getDocumentation, getFrameID, getIcon, getInvalidOwnSlotValuesText, getInvalidOwnSlotValueText, getKnowledgeBase, getOwnFacetValue, getOwnFacetValues, getOwnSlotAllowsMultipleValues, getOwnSlotAndSubslotValues, getOwnSlotDefaultValues, getOwnSlotFacets, getOwnSlotFacetValues, getOwnSlots, getOwnSlotValue, getOwnSlotValueCount, getOwnSlotValues, getOwnSlotValueType, getProject, getReachableSimpleInstances, getReferences, getReferences, hasDirectType, hasOwnSlot, hasType, isBeingDeleted, isDeleted, isEditable, isIncluded, isSystem, isValidOwnSlotValue, markDeleted, markDeleting, removeDirectType, removeFrameListener, removeInstanceListener, removeOwnSlotValue, setDirectOwnSlotValue, setDirectOwnSlotValues, setDirectType, setDirectTypes, setDocumentation, setDocumentation, setEditable, setIncluded, setOwnFacetValue, setOwnFacetValues, setOwnSlotValue, setOwnSlotValues, shallowCopy

Methods inherited from interface edu.stanford.smi.protege.model.Instance

moveDirectType

Methods inherited from interface edu.stanford.smi.protege.model.Frame

delete, getName, isValid, isVisible, moveDirectOwnSlotValue, setName, setVisible

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface edu.stanford.smi.protege.model.Cls

getBrowserSlot, getDirectBrowserSlot, getInheritedBrowserSlot

Methods inherited from interface edu.stanford.smi.protegex.owl.model.RDFResource

addComment, addDifferentFrom, addIsDefinedBy, addLabel, addPropertyValue, addPropertyValueListener, addProtegeType, addRDFType, addResourceListener, addSameAs, addVersionInfo, as, canAs, delete, getAllValuesFromOnTypes, getBrowserText, getComments, getDifferentFrom, getHasValuesOnTypes, getIconLocation, getIconName, getInferredTypes, getIsDefinedBy, getLabels, getLocalName, getName, getNamespace, getNamespacePrefix, getOWLModel, getPossibleRDFProperties, getPropertyValue, getPropertyValue, getPropertyValueAs, getPropertyValueCount, getPropertyValueLiteral, getPropertyValueLiterals, getPropertyValues, getPropertyValues, getPropertyValuesAs, getProtegeType, getProtegeTypes, getRDFProperties, getRDFType, getRDFTypes, getReferringAnonymousClasses, getSameAs, getURI, getVersionInfo, hasPropertyValue, hasPropertyValue, hasPropertyValue, hasPropertyValue, hasProtegeType, hasProtegeType, hasRDFType, hasRDFType, isValidPropertyValue, isVisible, listPropertyValues, listPropertyValues, listPropertyValuesAs, listRDFTypes, removeComment, removeDifferentFrom, removeIsDefinedBy, removeLabel, removePropertyValue, removePropertyValueListener, removeProtegeType, removeRDFType, removeResourceListener, removeSameAs, removeVersionInfo, setComment, setComments, setInferredTypes, setName, setPropertyValue, setPropertyValues, setProtegeType, setProtegeTypes, setRDFType, setRDFTypes, setVisible

Methods inherited from interface edu.stanford.smi.protegex.owl.model.RDFObject

equalsStructurally

Methods inherited from interface edu.stanford.smi.protegex.owl.model.visitor.Visitable

accept

Method Detail

checkFillerText

public void checkFillerText(String value)
                     throws Exception

Checks the filler from a textual expression. This should be called prior to assigning a new filler value.

Parameters:

value - the potential filler value

Throws:

Exception - to indicate a parse exception

getOperator

public char getOperator()

Gets the Unicode operator character that is typically used to represent this type of restriction.

Returns:

the operator char

getFillerProperty

public RDFProperty getFillerProperty()

Gets the Slot that is used to store the filler at this kind of restriction (e.g., owl:cardinality).

Returns:

the filler slot

getFillerText

public String getFillerText()

Gets the filler of this restriction for display purposes.

Returns:

the filler text (never null)

getOnProperty

public RDFProperty getOnProperty()

Gets the Slot that is restricted by this restriction.

Returns:

the value of the owl:onProperty slot at this restriction

isDefined

public boolean isDefined()

Checks whether this restriction has been completely defined already. If this is false, then the user still has to define the restriction values.

Returns:

true if this is completely defined

setFillerText

public void setFillerText(String value)
                   throws Exception

Sets the filler from a (valid) textual expression.

Parameters:

value - the new filler value

Throws:

Exception - to indicate a parse exception

setOnProperty

public void setOnProperty(RDFProperty property)

Sets the restricted property at this restriction.

Parameters:

property - the RDFProperty to restrict