OwlClass

java.lang.Object
- prajna.ontology.OwlClass

All Implemented Interfaces:

Validating
```
public class OwlClass
extends java.lang.Object
implements Validating
```
Class representing an OwlClass defined by an Owl RDF file. This class includes all appropriate references and state for the OwlClass. Methods include validation, initialization of OwlThings for the class, and hooks for editing.

Author:

Edward Swing

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToDisjoint(OwlClass cls)` Add an OwlClass to the set of disjoint classes for this class.
`void`	`addToIntersection(Validating valid)` Add a validating object to the intersection for this class
`void`	`addToUnion(Validating valid)` Add a validating object to the union for this class
`boolean`	`checkEquivalence(OwlThing thing)` Check whether a particular OwlThing matches any equivalence relations for this class.
`static void`	`clearDefined()` Remove all defined OwlClasses from the internal tables
`static OwlClass`	`createFromElement(org.w3c.dom.Element element)` Creates an OwlClass from an element which includes its definition.
`OwlClass`	`findCommonDescendant(OwlClass other)` Find the OwlClass that includes both this OwlClass and the other OwlClass.
`static OwlClass`	`findOwlClass(java.lang.String name)` Find an OwlClass with the given name.
`java.util.Set<OwlRestriction>`	`findRestrictions(java.lang.String propName)` Find all restrictions for a specified property.
`static java.util.SortedSet<java.lang.String>`	`getClassNames()` Gets the set of all available class names
`java.lang.String`	`getComment()` Get the comment for this OwlClass, if any.
`java.util.Set<OwlClass>`	`getDescendants()` Return the set of classes which descend or derive from this class.
`java.util.Set<OwlClass>`	`getDisjoint()` Return the classes this OwlClass is disjoint with.
`java.util.Set<OwlClass>`	`getImpliedClasses()` Gets the set of implied classes.
`java.util.HashSet<Validating>`	`getIntersection()` Gets the set of Validating objects which compose the intersection for this class, or null if this class is not composed of an intersection
`java.lang.String`	`getName()` Gets the name of this OwlClass.
`static OwlClass`	`getOwlClass(java.lang.String name)` Gets the named OwlClass, creating a skeleton if it has not been defined.
`static OwlClass`	`getOwlClass(java.lang.String name, OwlClass parentClass)` Gets the named OwlClass, creating a skeleton if it has not been defined.
`java.util.Set<OwlThing>`	`getOwlThings()` Return the set of OwlThings that are members of this class.
`OwlClass`	`getParent()` Gets the parent of this OwlClass, if any.
`OwlClass`	`getRefinedClass(java.util.Map<java.lang.String,OwlThing> assignMap)` Gets the refined class for a particular set of assignments.
`java.util.Set<OwlRestriction>`	`getRestrictions()` Get all restrictions explicitly defined for this class
`java.util.Set<Validating>`	`getUnion()` Gets the set of Validating objects which compose the union for this class, or null if this class does not include a union
`java.util.Set<OwlProperty>`	`getValidProperties(boolean parentProps)` Get the set of properties which are valid for this OwlClass.
`boolean`	`isDefined()` Checks if this OwlClass is defined.
`boolean`	`isMatch(OwlThing thing)` Return whether the specified thing could be a member of this OwlClass.
`boolean`	`isMember(OwlThing owlThing)` Checks if the provided OwlThing is a member of this OwlClass.
`boolean`	`isModified()` Indicate whether this class has been modified.
`boolean`	`isValid(OwlThing owlThing)` Determine whether the specified OwlThing is a valid member of this OwlClass
`boolean`	`isValidAssignment(java.util.Map<java.lang.String,OwlThing> assignMap)` Checks if the set of assignments are valid for this OwlClass.
`boolean`	`isValidProperty(java.lang.String propertyName, OwlThing owlThing)` Determines whether the given OwlThing may be assigned to the property in a valid way.
`protected void`	`parseSubClassElement(org.w3c.dom.Element element)` Parses the rdfs:subClassOf element, and initializes the relevant definitions in this class.
`void`	`setDefinedValues(OwlThing owlThing)` Sets the values which are defined by this class for the specified OwlThing.
`java.lang.String`	`toString()` Return a string representation of this OwlClass.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - addToDisjoint
```
public void addToDisjoint(OwlClass cls)
```
    Add an OwlClass to the set of disjoint classes for this class.
    
    Parameters:
    cls - the disjoint class
  - addToIntersection
```
public void addToIntersection(Validating valid)
```
    Add a validating object to the intersection for this class
    
    Parameters:
    valid - a validating object, typically another OwlClass
  - addToUnion
```
public void addToUnion(Validating valid)
```
    Add a validating object to the union for this class
    
    Parameters:
    valid - a validating object, typically another OwlClass
  - checkEquivalence
```
public boolean checkEquivalence(OwlThing thing)
```
    Check whether a particular OwlThing matches any equivalence relations for this class. The thing must also be a member of a parent class for the equivalence to be valid. If the equivalence is valid, the thing is refined to be a member of this class.
    
    Parameters:
    thing - the OwlThing to check
    
    Returns:
    true if the thing matches the equivalence
  - findCommonDescendant
```
public OwlClass findCommonDescendant(OwlClass other)
```
    Find the OwlClass that includes both this OwlClass and the other OwlClass. If the two classes are mutually exclusive, this method returns null. If one class is a descendant of the other, this class returns the descendant. If there is an intersection class that includes these two classes, that is returned. Otherwise
    
    Parameters:
    other - the other OwlClass
    
    Returns:
    a common descendant that has both these classes as parents.
  - findRestrictions
```
public java.util.Set<OwlRestriction> findRestrictions(java.lang.String propName)
```
    Find all restrictions for a specified property. This method retrieves matching restrictions from both this class and all of its implied classes to generate a complete list of matching restrictions.
    
    Parameters:
    propName - the name of the property for the class
    
    Returns:
    a set of matching restrictions
  - getComment
```
public java.lang.String getComment()
```
    Get the comment for this OwlClass, if any. This corresponds to the rdfs:comment element in the class definition. It is null if not set.
    
    Returns:
    the comment for the OwlClass
  - getDescendants
```
public java.util.Set<OwlClass> getDescendants()
```
    Return the set of classes which descend or derive from this class. The set returned includes both subclasses of this class, and classes which include this class (or a subclass) as part of an intersection. This class is not included in the set.
    
    Returns:
    the set of descendant classes
  - getDisjoint
```
public java.util.Set<OwlClass> getDisjoint()
```
    Return the classes this OwlClass is disjoint with. Disjoint classes cannot have members in common.
    
    Returns:
    the set of OwlClasses disjoint from this one
  - getImpliedClasses
```
public java.util.Set<OwlClass> getImpliedClasses()
```
    Gets the set of implied classes. Implied classes are those classes which an object of this class also belongs to. The implied classes include both ancestor classes and classes from intersections, as well as the class itself.
    
    Returns:
    the set of implied classes
  - getIntersection
```
public java.util.HashSet<Validating> getIntersection()
```
    Gets the set of Validating objects which compose the intersection for this class, or null if this class is not composed of an intersection
    
    Returns:
    the set of Validating objects for the intersection.
  - getName
```
public java.lang.String getName()
```
    Gets the name of this OwlClass.
    
    Returns:
    the name
  - getOwlThings
```
public java.util.Set<OwlThing> getOwlThings()
```
    Return the set of OwlThings that are members of this class. This method will find both those that are specifically members of the class, those that are a subclass, and those that are part of an intersection that includes this class
    
    Returns:
    the set of things that are members of this class
  - getParent
```
public OwlClass getParent()
```
    Gets the parent of this OwlClass, if any.
    
    Returns:
    the parent OwlClass
  - getRefinedClass
```
public OwlClass getRefinedClass(java.util.Map<java.lang.String,OwlThing> assignMap)
```
    Gets the refined class for a particular set of assignments. This method checks any classes which derive from this class against the assignment map. The refined class will be the class which matches any intersections of this class along with assignments matching the assignment map. If no such class is discovered, null is returned.
    
    Parameters:
    assignMap - the assignment map
    
    Returns:
    the refined class
  - getRestrictions
```
public java.util.Set<OwlRestriction> getRestrictions()
```
    Get all restrictions explicitly defined for this class
    
    Returns:
    the set of restrictions
  - getUnion
```
public java.util.Set<Validating> getUnion()
```
    Gets the set of Validating objects which compose the union for this class, or null if this class does not include a union
    
    Returns:
    the set of Validating objects for the union.
  - getValidProperties
```
public java.util.Set<OwlProperty> getValidProperties(boolean parentProps)
```
    Get the set of properties which are valid for this OwlClass. This returns all properties that have this class or one of its ancestors as a domain, or that have no domain defined. If the parentProps flag is false, only those properties that have no descendants will be returned.
    
    Parameters:
    parentProps - the parent properties flag
    
    Returns:
    the set of valid properties
  - isDefined
```
public boolean isDefined()
```
    Checks if this OwlClass is defined. This method determines whether the actual definition for the OwlClass has been provided.
    
    Returns:
    whether this OwlClass has been defined or not.
  - isMatch
```
public boolean isMatch(OwlThing thing)
```
    Return whether the specified thing could be a member of this OwlClass. It checks the domains of all the properties of the thing, and also checks to see if the property values of the thing conform to all restrictions on this OwlClass
    
    Parameters:
    thing - the OwlThing to check
    
    Returns:
    true if the OwlThing could be a valid member of this class, false otherwise.
  - isMember
```
public boolean isMember(OwlThing owlThing)
```
    Checks if the provided OwlThing is a member of this OwlClass. This checks the intersections and restrictions on this class against the OwlThing to determine if the OwlThing is actually a member of this class. If the OwlThing's class includes this class as a derived class, this method automatically returns true.
    
    Parameters:
    owlThing - the thing to check.
    
    Returns:
    true, if is member
  - isModified
```
public boolean isModified()
```
    Indicate whether this class has been modified. The modified flag is set whenever a class is created from something other than an established ontology, or if it is changed, such as through an editor.
    
    Returns:
    whether the class has been modified or not
  - isValid
```
public boolean isValid(OwlThing owlThing)
```
    Determine whether the specified OwlThing is a valid member of this OwlClass
    
    Specified by:
    
    isValid in interface Validating
    
    Parameters:
    owlThing - the OwlThing to check
    
    Returns:
    true if the OwlThing is completely valid, false otherwise.
  - isValidAssignment
```
public boolean isValidAssignment(java.util.Map<java.lang.String,OwlThing> assignMap)
```
    Checks if the set of assignments are valid for this OwlClass. This method checks all properties against the restrictions and intersections of this class. If all are valid, this method returns true.
    
    Parameters:
    assignMap - the assignment map
    
    Returns:
    true, if the assignment map is a valid set of assignments for this class
  - isValidProperty
```
public boolean isValidProperty(java.lang.String propertyName,
                      OwlThing owlThing)
```
    Determines whether the given OwlThing may be assigned to the property in a valid way. This method checks the property to ensure the OwlThing is of the proper class and has values which match any limitations on the specified property.
    
    Specified by:
    
    isValidProperty in interface Validating
    
    Parameters:
    propertyName - the name of the property
    owlThing - the OwlThing to test for assignment to the property
    
    Returns:
    true if the property assignment is valid, false otherwise
  - parseSubClassElement
```
protected void parseSubClassElement(org.w3c.dom.Element element)
```
    Parses the rdfs:subClassOf element, and initializes the relevant definitions in this class.
    
    Parameters:
    element - the Subclass element
  - setDefinedValues
```
public void setDefinedValues(OwlThing owlThing)
```
    Sets the values which are defined by this class for the specified OwlThing. This method recurses through all ancestors and other implied OwlClasses to ensure that all necessary properties are set appropriately.
    
    Parameters:
    owlThing - the OwlThing to set the values on.
  - toString
```
public java.lang.String toString()
```
    Return a string representation of this OwlClass. This method simply returns the class name.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the class name
  - clearDefined
```
public static void clearDefined()
```
    Remove all defined OwlClasses from the internal tables
  - createFromElement
```
public static OwlClass createFromElement(org.w3c.dom.Element element)
```
    Creates an OwlClass from an element which includes its definition. This method retrieves any already-defined OwlClass with the class name, or creates a new one. The method initializes the OwlClass state from the element provided.
    
    Parameters:
    element - the element containing the class definition.
    
    Returns:
    the OwlClass for the element.
  - findOwlClass
```
public static OwlClass findOwlClass(java.lang.String name)
```
    Find an OwlClass with the given name.
    
    Parameters:
    name - the name of the OwlClass
    
    Returns:
    the OwlClass with the given name, or null if no such thing exists
  - getClassNames
```
public static java.util.SortedSet<java.lang.String> getClassNames()
```
    Gets the set of all available class names
    
    Returns:
    all available class names, as a set of Strings.
  - getOwlClass
```
public static OwlClass getOwlClass(java.lang.String name)
```
    Gets the named OwlClass, creating a skeleton if it has not been defined.
    
    Parameters:
    name - the name of the class
    
    Returns:
    the named OwlClass
  - getOwlClass
```
public static OwlClass getOwlClass(java.lang.String name,
                   OwlClass parentClass)
```
    Gets the named OwlClass, creating a skeleton if it has not been defined.
    
    Parameters:
    name - the name of the class
    parentClass - the parent class
    
    Returns:
    the named OwlClass

Class OwlClass

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addToDisjoint

addToIntersection

addToUnion

checkEquivalence

findCommonDescendant

findRestrictions

getComment

getDescendants

getDisjoint

getImpliedClasses

getIntersection

getName

getOwlThings

getParent

getRefinedClass

getRestrictions

getUnion

getValidProperties

isDefined

isMatch

isMember

isModified

isValid

isValidAssignment

isValidProperty

parseSubClassElement

setDefinedValues

toString

clearDefined

createFromElement

findOwlClass

getClassNames

getOwlClass

getOwlClass