prajna.ontology

Class OwlDatatypeProperty

java.lang.Object

prajna.data.rdf.Property

prajna.ontology.OwlProperty

prajna.ontology.OwlDatatypeProperty

All Implemented Interfaces:

java.io.Serializable

public class OwlDatatypeProperty
extends OwlProperty

Class representing a datatype property defined by an Owl RDF file.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OwlDatatypeProperty(java.lang.String name, java.lang.String type) Create a new OwlDataTypeProperty with the given name and type

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addValueToThing(OwlThing thing, java.lang.String value) Apply the value to this property for the given OwlThing.
static OwlDatatypeProperty	createFromElement(org.w3c.dom.Element element) Create a DataType property from an Element.
FieldDesc<?>	generateFieldDesc(java.lang.String fieldType) Generate the internal field description for this datatype element, based upon the field type.
DataType	getDataType() Get the basic data type expected by this property.
FieldDesc<?>	getFieldDesc() Get the internal field descriptor for this datatype property
Property	getParent() Get the parent property, if any, for this property
static OwlDatatypeProperty	getProperty(java.lang.String name) Get the named datatype property.
static java.util.Set<java.lang.String>	getPropertyNames() Get the list of DatatypeProperty names
java.lang.String	getRangeType() Get the range type for this datatype.
void	setFieldDesc(FieldDesc<?> desc) Set the field descriptor for this datatype property.
void	setName(java.lang.String propName) Set the name of this datatype property
void	setParent(OwlDatatypeProperty prop) Set the parent for this property

Methods inherited from class prajna.ontology.OwlProperty

getComment, getDisplayName, getDomain, isFunctional, isInverseFunctional, setComment, setDisplayName, setDomain, setFunctional, setInverseFunctional

Methods inherited from class prajna.data.rdf.Property

addProperty, clearDefined, equals, getName, getUri, hashCode, isDescendant, isDescendant, putProperty, setUri, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OwlDatatypeProperty

public OwlDatatypeProperty(java.lang.String name,
                   java.lang.String type)

Create a new OwlDataTypeProperty with the given name and type

Parameters:

name - the property name

type - the property type

Method Detail

addValueToThing

public boolean addValueToThing(OwlThing thing,
                      java.lang.String value)

Apply the value to this property for the given OwlThing. This implementation ensures that the thing matches the domain for this property, and that the value is a valid element for the range.

Specified by:

addValueToThing in class OwlProperty

Parameters:

thing - The OwlThing to apply the property to.

value - The value for this property

Returns:

true if the value could be set, false if the value is not valid for this property.

generateFieldDesc

public FieldDesc<?> generateFieldDesc(java.lang.String fieldType)

Generate the internal field description for this datatype element, based upon the field type. The fieldType attribute must conform to the list of field types as specified in the OWL schema. This method is called by the constructor, but is public to enable editing of the property. Careless usage may create invalid property states.

Parameters:

fieldType - the fieldType attribute.

Returns:

the field descriptor generated, or null if the field type was invalid

getDataType

public DataType getDataType()

Get the basic data type expected by this property.

Returns:

the basic data type expected by this property.

getFieldDesc

public FieldDesc<?> getFieldDesc()

Get the internal field descriptor for this datatype property

Returns:

the internal field descriptor

getParent

public Property getParent()

Get the parent property, if any, for this property

Overrides:

getParent in class Property

Returns:

the parent property

getRangeType

public java.lang.String getRangeType()

Get the range type for this datatype. The RangeType is the XML representation of the data type for this property, usually from the ontology file.

Returns:

the range type

setFieldDesc

public void setFieldDesc(FieldDesc<?> desc)

Set the field descriptor for this datatype property. The field descriptor is used for parsing text into the property values. This method is appropriate when creating a specific parser for field properties, or when creating a datatype property programatically.

Parameters:

desc - the new field descriptor

setName

public void setName(java.lang.String propName)

Set the name of this datatype property

Overrides:

setName in class Property

Parameters:

propName - the property name

setParent

public void setParent(OwlDatatypeProperty prop)

Set the parent for this property

Parameters:

prop - the parent property

createFromElement

public static OwlDatatypeProperty createFromElement(org.w3c.dom.Element element)

Create a DataType property from an Element. The element must conform to the OWL RDF schema.

Parameters:

element - the datatype property element

Returns:

the datatype property that is created (or augmented)

getProperty

public static OwlDatatypeProperty getProperty(java.lang.String name)

Get the named datatype property.

Parameters:

name - the name of the property

Returns:

the named datatype property

getPropertyNames

public static java.util.Set<java.lang.String> getPropertyNames()

Get the list of DatatypeProperty names

Returns:

the set of DatatypeProperty names currently loaded