uk.ac.manchester.cs.owl.owlapi

Class OWL2DatatypeImpl

java.lang.Object

uk.ac.manchester.cs.owl.owlapi.OWL2DatatypeImpl

All Implemented Interfaces:

Serializable, Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnonymousIndividuals, HasClassesInSignature, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasIndividualsInSignature, HasIRI, HasObjectPropertiesInSignature, HasSignature, OWLDataRange, OWLDatatype, OWLEntity, OWLLogicalEntity, OWLNamedObject, OWLObject, OWLPrimitive, OWLPropertyRange, SWRLPredicate

public class OWL2DatatypeImpl
extends Object
implements OWLDatatype

An optimised implementation of OWLDatatype for OWL2Datatypes.

Since:

3.2.0

Author:

Matthew Horridge, Stanford University, Bio-Medical Informatics Research Group

See Also:

Serialized Form

Property Summary

Type	Property and Description
OWLAnnotationProperty	asOWLAnnotation A convenience method that obtains this entity as an OWLAnnotationProperty (in order to avoid explicit casting).
OWLDataProperty	asOWLData A convenience method that obtains this entity as an OWLDataProperty (in order to avoid explicit casting).
OWLObjectProperty	asOWLObject A convenience method that obtains this entity as an OWLObjectProperty (in order to avoid explicit casting).
boolean	isOWLAnnotation Gets the value of the property oWLAnnotationProperty.
boolean	isOWLData Gets the value of the property oWLDataProperty.
boolean	isOWLObject Gets the value of the property oWLObjectProperty.

Constructor Summary

Constructors

Constructor and Description
OWL2DatatypeImpl(OWL2Datatype owl2Datatype) Creates an instance of OWLDatatypeImplForOWL2Datatype for the specified OWL2Datatype.

Method Summary

Modifier and Type	Method and Description
void	accept(OWLDataRangeVisitor visitor)
<O> O	accept(OWLDataRangeVisitorEx<O> visitor)
void	accept(OWLDataVisitor visitor)
<O> O	accept(OWLDataVisitorEx<O> visitor)
void	accept(OWLEntityVisitor visitor)
<O> O	accept(OWLEntityVisitorEx<O> visitor)
void	accept(OWLNamedObjectVisitor visitor) Accepts a visitor
<O> O	accept(OWLNamedObjectVisitorEx<O> visitor) Accepts a visitor
void	accept(OWLObjectVisitor visitor) Accepts a visitor
<O> O	accept(OWLObjectVisitorEx<O> visitor) Accepts a visitor
OWLAnnotationProperty	asOWLAnnotationProperty() A convenience method that obtains this entity as an OWLAnnotationProperty (in order to avoid explicit casting).
OWLClass	asOWLClass() A convenience method that obtains this entity as an OWLClass (in order to avoid explicit casting).
OWLDataProperty	asOWLDataProperty() A convenience method that obtains this entity as an OWLDataProperty (in order to avoid explicit casting).
OWLDatatype	asOWLDatatype() If this data range is a datatype then this method may be used to obtain it as a datatype (rather than using an explicit cast).
OWLNamedIndividual	asOWLNamedIndividual() A convenience method that obtains this entity as an OWLNamedIndividual (in order to avoid explicit casting).
OWLObjectProperty	asOWLObjectProperty() A convenience method that obtains this entity as an OWLObjectProperty (in order to avoid explicit casting).
int	compareTo(OWLObject o)
boolean	containsEntityInSignature(OWLEntity owlEntity) Determines if the signature of this object contains the specified entity.
boolean	equals(Object obj)
Set<OWLAnnotationProperty>	getAnnotationPropertiesInSignature() A convenience method that obtains the annotation properties that are in the signature of this object
Set<OWLAnonymousIndividual>	getAnonymousIndividuals() Gets the anonymous individuals occurring in this object.
OWL2Datatype	getBuiltInDatatype() Gets the built in datatype information if this datatype is a built in datatype.
Set<OWLClass>	getClassesInSignature() Gets the classes in the signature of this object.
Set<OWLDataProperty>	getDataPropertiesInSignature() A convenience method that obtains the data properties that are in the signature of this object
DataRangeType	getDataRangeType() Gets the type of this data range
Set<OWLDatatype>	getDatatypesInSignature() A convenience method that obtains the datatypes that are in the signature of this object
EntityType<?>	getEntityType() Gets the entity type for this entity
Set<OWLNamedIndividual>	getIndividualsInSignature() A convenience method that obtains the individuals that are in the signature of this object
IRI	getIRI() Gets the IRI of this object
Set<OWLClassExpression>	getNestedClassExpressions() Gets all of the nested (includes top level) class expressions that are used in this object
Set<OWLObjectProperty>	getObjectPropertiesInSignature() A convenience method that obtains the object properties that are in the signature of this object
Set<OWLEntity>	getSignature() Gets the signature of this object.
int	hashCode()
boolean	isBoolean() Determines if this datatype has the IRI xsd:boolean
boolean	isBottomEntity() Determines if this object is either, owl:Nothing (the bottom class), owl:bottomObjectProperty (the bottom object property) , owl:bottomDataProperty (the bottom data property).
boolean	isBuiltIn() Determines if this entity is a built in entity.
boolean	isDatatype() Determines if this data range is a datatype (int, float, ...)
boolean	isDouble() Determines if this datatype has the IRI xsd:double
boolean	isFloat() Determines if this datatype has the IRI xsd:float
boolean	isInteger() Determines if this datatype has the IRI xsd:integer
boolean	isOWLAnnotationProperty() Gets the value of the property oWLAnnotationProperty.
boolean	isOWLClass() A convenience method that determines if this entity is an OWLClass
boolean	isOWLDataProperty() Gets the value of the property oWLDataProperty.
boolean	isOWLDatatype() A convenience method that determines if this entity is an OWLDatatype
boolean	isOWLNamedIndividual() A convenience method that determines if this entity is an OWLNamedIndividual
boolean	isOWLObjectProperty() Gets the value of the property oWLObjectProperty.
boolean	isRDFPlainLiteral() Determines if this datatype has the IRI rdf:PlainLiteral
boolean	isString() Determines if this datatype has the IRI xsd:string
boolean	isTopDatatype() Determines if this data range is the top data type.
boolean	isTopEntity() Determines if this object is either, owl:Thing (the top class), owl:topObjectProperty (the top object property) , owl:topDataProperty (the top data property) or rdfs:Literal (the top datatype).
boolean	isType(EntityType<?> entityType) Tests to see if this entity is of the specified type
String	toString()
String	toStringID() Returns a string representation that can be used as the ID of this entity.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Property Detail

isOWLObject

public boolean isOWLObjectProperty

Gets the value of the property oWLObjectProperty.

Specified by:

isOWLObjectProperty in interface OWLEntity

Returns:

true if this entity is an OWLObjectProperty, otherwise false

asOWLObject

public OWLObjectProperty asOWLObjectProperty

Specified by:

asOWLObjectProperty in interface OWLEntity

Returns:

The entity as an OWLObjectProperty.

isOWLData

public boolean isOWLDataProperty

Gets the value of the property oWLDataProperty.

Specified by:

isOWLDataProperty in interface OWLEntity

Returns:

true if this entity is an OWLDataProperty, otherwise false

asOWLData

public OWLDataProperty asOWLDataProperty

Specified by:

asOWLDataProperty in interface OWLEntity

Returns:

The entity as an OWLDataProperty.

isOWLAnnotation

public boolean isOWLAnnotationProperty

Gets the value of the property oWLAnnotationProperty.

Specified by:

isOWLAnnotationProperty in interface OWLEntity

Returns:

true if this entity is an OWLAnnotationProperty, otherwise false

asOWLAnnotation

public OWLAnnotationProperty asOWLAnnotationProperty

Specified by:

asOWLAnnotationProperty in interface OWLEntity

Returns:

The entity as an OWLAnnotationProperty.

Constructor Detail

OWL2DatatypeImpl

public OWL2DatatypeImpl(@Nonnull
                        OWL2Datatype owl2Datatype)

Creates an instance of OWLDatatypeImplForOWL2Datatype for the specified OWL2Datatype.

Parameters:

owl2Datatype - The datatype. Not null.

Throws:

NullPointerException - if owl2Datatype is null.

Method Detail

getBuiltInDatatype

public OWL2Datatype getBuiltInDatatype()

Description copied from interface: OWLDatatype

Gets the built in datatype information if this datatype is a built in datatype. This method should only be called if the isBuiltIn() method returns true

Specified by:

getBuiltInDatatype in interface OWLDatatype

Returns:

The OWLDatatypeVocabulary that describes this built in datatype

isString

public boolean isString()

Description copied from interface: OWLDatatype

Determines if this datatype has the IRI xsd:string

Specified by:

isString in interface OWLDatatype

Returns:

true if this datatype has the IRI xsd:string, otherwise false.

isInteger

public boolean isInteger()

Description copied from interface: OWLDatatype

Determines if this datatype has the IRI xsd:integer

Specified by:

isInteger in interface OWLDatatype

Returns:

true if this datatype has the IRI xsd:integer, otherwise false.

isFloat

public boolean isFloat()

Description copied from interface: OWLDatatype

Determines if this datatype has the IRI xsd:float

Specified by:

isFloat in interface OWLDatatype

Returns:

true if this datatype has the IRI xsd:float, otherwise false.

isDouble

public boolean isDouble()

Description copied from interface: OWLDatatype

Determines if this datatype has the IRI xsd:double

Specified by:

isDouble in interface OWLDatatype

Returns:

true if this datatype has the IRI xsd:double, otherwise false.

isBoolean

public boolean isBoolean()

Description copied from interface: OWLDatatype

Determines if this datatype has the IRI xsd:boolean

Specified by:

isBoolean in interface OWLDatatype

Returns:

true if this datatype has the IRI xsd:boolean, otherwise false.

isRDFPlainLiteral

public boolean isRDFPlainLiteral()

Description copied from interface: OWLDatatype

Determines if this datatype has the IRI rdf:PlainLiteral

Specified by:

isRDFPlainLiteral in interface OWLDatatype

Returns:

true if this datatype has the IRI rdf:PlainLiteral otherwise false

isDatatype

public boolean isDatatype()

Description copied from interface: OWLDataRange

Determines if this data range is a datatype (int, float, ...)

Specified by:

isDatatype in interface OWLDataRange

Returns:

true if this datarange is a datatype, or false if it is not a datatype and is some other data range such as a data range restriction, data oneOf or data complementOf.

isTopDatatype

public boolean isTopDatatype()

Description copied from interface: OWLDataRange

Determines if this data range is the top data type.

Specified by:

isTopDatatype in interface OWLDataRange

Returns:

true if this data range is the top datatype otherwise false

asOWLDatatype

@Nonnull
public OWLDatatype asOWLDatatype()

Description copied from interface: OWLDataRange

If this data range is a datatype then this method may be used to obtain it as a datatype (rather than using an explicit cast).

Specified by:

asOWLDatatype in interface OWLDataRange

Specified by:

asOWLDatatype in interface OWLEntity

Returns:

This data range as an OWLDatatype

getDataRangeType

public DataRangeType getDataRangeType()

Description copied from interface: OWLDataRange

Gets the type of this data range

Specified by:

getDataRangeType in interface OWLDataRange

Returns:

The data range type

accept

public void accept(OWLDataVisitor visitor)

Specified by:

accept in interface OWLDataRange

Parameters:

visitor - visitor

accept

public <O> O accept(OWLDataVisitorEx<O> visitor)

Specified by:

accept in interface OWLDataRange

Type Parameters:

O - visitor return type

Parameters:

visitor - visitor

Returns:

visitor return value

accept

public void accept(OWLDataRangeVisitor visitor)

Specified by:

accept in interface OWLDataRange

Parameters:

visitor - visitor

accept

public <O> O accept(OWLDataRangeVisitorEx<O> visitor)

Specified by:

accept in interface OWLDataRange

Type Parameters:

O - visitor return type

Parameters:

visitor - visitor

Returns:

visitor return value

getEntityType

public EntityType<?> getEntityType()

Description copied from interface: OWLEntity

Gets the entity type for this entity

Specified by:

getEntityType in interface OWLEntity

Returns:

The entity type

isType

public boolean isType(EntityType<?> entityType)

Description copied from interface: OWLEntity

Tests to see if this entity is of the specified type

Specified by:

isType in interface OWLEntity

Parameters:

entityType - The entity type

Returns:

true if this entity is of the specified type, otherwise false.

isBuiltIn

public boolean isBuiltIn()

Description copied from interface: OWLEntity

Determines if this entity is a built in entity. The entity is a built in entity if it is:

• a class and the URI corresponds to owl:Thing or owl:Nothing
• an object property and the URI corresponds to owl:topObjectProperty or owl:bottomObjectProperty
• a data property and the URI corresponds to owl:topDataProperty or owl:bottomDataProperty
• a datatype and the IRI is rdfs:Literal or is in the OWL 2 datatype map or is rdf:PlainLiteral
• an annotation property and the URI is in the set of built in annotation property URIs, i.e. one of:
  • rdfs:label
  • rdfs:comment
  • rdfs:seeAlso
  • rdfs:isDefinedBy
  • owl:deprecated
  • owl:priorVersion
  • owl:backwardCompatibleWith
  • owl:incompatibleWith

Specified by:

isBuiltIn in interface OWLEntity

Returns:

true if this entity is a built in entity, or false if this entity is not a builtin entity.

isOWLClass

public boolean isOWLClass()

Description copied from interface: OWLEntity

A convenience method that determines if this entity is an OWLClass

Specified by:

isOWLClass in interface OWLEntity

Returns:

true if this entity is an OWLClass, otherwise false

asOWLClass

public OWLClass asOWLClass()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLClass (in order to avoid explicit casting).

Specified by:

asOWLClass in interface OWLEntity

Returns:

The entity as an OWLClass.

isOWLObjectProperty

public boolean isOWLObjectProperty()

Gets the value of the property oWLObjectProperty.

Specified by:

isOWLObjectProperty in interface OWLEntity

Returns:

true if this entity is an OWLObjectProperty, otherwise false

asOWLObjectProperty

public OWLObjectProperty asOWLObjectProperty()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLObjectProperty (in order to avoid explicit casting).

Specified by:

asOWLObjectProperty in interface OWLEntity

Returns:

The entity as an OWLObjectProperty.

isOWLDataProperty

public boolean isOWLDataProperty()

Gets the value of the property oWLDataProperty.

Specified by:

isOWLDataProperty in interface OWLEntity

Returns:

true if this entity is an OWLDataProperty, otherwise false

asOWLDataProperty

public OWLDataProperty asOWLDataProperty()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLDataProperty (in order to avoid explicit casting).

Specified by:

asOWLDataProperty in interface OWLEntity

Returns:

The entity as an OWLDataProperty.

isOWLNamedIndividual

public boolean isOWLNamedIndividual()

Description copied from interface: OWLEntity

A convenience method that determines if this entity is an OWLNamedIndividual

Specified by:

isOWLNamedIndividual in interface OWLEntity

Returns:

true if this entity is an OWLNamedIndividual, otherwise false

asOWLNamedIndividual

public OWLNamedIndividual asOWLNamedIndividual()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLNamedIndividual (in order to avoid explicit casting).

Specified by:

asOWLNamedIndividual in interface OWLEntity

Returns:

The entity as an OWLNamedIndividual.

isOWLDatatype

public boolean isOWLDatatype()

Description copied from interface: OWLEntity

A convenience method that determines if this entity is an OWLDatatype

Specified by:

isOWLDatatype in interface OWLEntity

Returns:

true if this entity is an OWLDatatype, otherwise false

isOWLAnnotationProperty

public boolean isOWLAnnotationProperty()

Gets the value of the property oWLAnnotationProperty.

Specified by:

isOWLAnnotationProperty in interface OWLEntity

Returns:

true if this entity is an OWLAnnotationProperty, otherwise false

asOWLAnnotationProperty

public OWLAnnotationProperty asOWLAnnotationProperty()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLAnnotationProperty (in order to avoid explicit casting).

Specified by:

asOWLAnnotationProperty in interface OWLEntity

Returns:

The entity as an OWLAnnotationProperty.

toStringID

public String toStringID()

Description copied from interface: OWLEntity

Returns a string representation that can be used as the ID of this entity. This is the toString representation of the IRI

Specified by:

toStringID in interface OWLEntity

Returns:

A string representing the toString of the IRI of this entity.

toString

public String toString()

Specified by:

toString in interface OWLObject

Overrides:

toString in class Object

accept

public void accept(OWLEntityVisitor visitor)

Specified by:

accept in interface OWLEntity

Parameters:

visitor - visitor

accept

public <O> O accept(OWLEntityVisitorEx<O> visitor)

Specified by:

accept in interface OWLEntity

Type Parameters:

O - visitor return type

Parameters:

visitor - visitor

Returns:

visitor return value

getIRI

public IRI getIRI()

Description copied from interface: OWLNamedObject

Gets the IRI of this object

Specified by:

getIRI in interface HasIRI

Specified by:

getIRI in interface OWLNamedObject

Returns:

The IRI of this object

accept

public void accept(OWLNamedObjectVisitor visitor)

Description copied from interface: OWLNamedObject

Accepts a visitor

Specified by:

accept in interface OWLNamedObject

Parameters:

visitor - The visitor

accept

public void accept(OWLObjectVisitor visitor)

Description copied from interface: OWLObject

Accepts a visitor

Specified by:

accept in interface OWLObject

Parameters:

visitor - The visitor

accept

public <O> O accept(OWLObjectVisitorEx<O> visitor)

Description copied from interface: OWLObject

Accepts a visitor

Specified by:

accept in interface OWLObject

Type Parameters:

O - visitor return type

Parameters:

visitor - The visitor

Returns:

visitor value

accept

public <O> O accept(OWLNamedObjectVisitorEx<O> visitor)

Description copied from interface: OWLNamedObject

Accepts a visitor

Specified by:

accept in interface OWLNamedObject

Type Parameters:

O - visitor return type

Parameters:

visitor - The visitor

Returns:

visitor return value

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSignature

public Set<OWLEntity> getSignature()

Description copied from interface: HasSignature

Gets the signature of this object.

Specified by:

getSignature in interface HasSignature

Returns:

A set of entities that represents the signature of this object. Changes are not reflected back.

containsEntityInSignature

public boolean containsEntityInSignature(OWLEntity owlEntity)

Description copied from interface: HasContainsEntityInSignature

Determines if the signature of this object contains the specified entity.

Specified by:

containsEntityInSignature in interface HasContainsEntityInSignature

Parameters:

owlEntity - The entity

Returns:

true if the signature of this object contains owlEntity, otherwise false

getAnonymousIndividuals

public Set<OWLAnonymousIndividual> getAnonymousIndividuals()

Description copied from interface: HasAnonymousIndividuals

Gets the anonymous individuals occurring in this object. The set is a copy, changes are not reflected back.

Specified by:

getAnonymousIndividuals in interface HasAnonymousIndividuals

Returns:

A set of anonymous individuals

getClassesInSignature

public Set<OWLClass> getClassesInSignature()

Description copied from interface: HasClassesInSignature

Gets the classes in the signature of this object.

Specified by:

getClassesInSignature in interface HasClassesInSignature

Returns:

A set containing the classes that are in the signature of this object. The set is a subset of the signature, and is not backed by the signature; it is a modifiable collection and changes are not reflected by the signature.

getDataPropertiesInSignature

public Set<OWLDataProperty> getDataPropertiesInSignature()

Description copied from interface: HasDataPropertiesInSignature

A convenience method that obtains the data properties that are in the signature of this object

Specified by:

getDataPropertiesInSignature in interface HasDataPropertiesInSignature

Returns:

A set containing the data properties that are in the signature of this object.The set is a subset of the signature, and is not backed by the signature; it is a modifiable collection and changes are not reflected by the signature.

getObjectPropertiesInSignature

public Set<OWLObjectProperty> getObjectPropertiesInSignature()

Description copied from interface: HasObjectPropertiesInSignature

A convenience method that obtains the object properties that are in the signature of this object

Specified by:

getObjectPropertiesInSignature in interface HasObjectPropertiesInSignature

Returns:

A set containing the object properties that are in the signature of this object.The set is a subset of the signature, and is not backed by the signature; it is a modifiable collection and changes are not reflected by the signature.

getAnnotationPropertiesInSignature

public Set<OWLAnnotationProperty> getAnnotationPropertiesInSignature()

Description copied from interface: HasAnnotationPropertiesInSignature

A convenience method that obtains the annotation properties that are in the signature of this object

Specified by:

getAnnotationPropertiesInSignature in interface HasAnnotationPropertiesInSignature

Returns:

A set containing the annotation properties that are in the signature of this object.The set is a subset of the signature, and is not backed by the signature; it is a modifiable collection and changes are not reflected by the signature.

getIndividualsInSignature

public Set<OWLNamedIndividual> getIndividualsInSignature()

Description copied from interface: HasIndividualsInSignature

A convenience method that obtains the individuals that are in the signature of this object

Specified by:

getIndividualsInSignature in interface HasIndividualsInSignature

Returns:

A set containing the individuals that are in the signature of this object.The set is a subset of the signature, and is not backed by the signature; it is a modifiable collection and changes are not reflected by the signature.

getDatatypesInSignature

public Set<OWLDatatype> getDatatypesInSignature()

Description copied from interface: HasDatatypesInSignature

A convenience method that obtains the datatypes that are in the signature of this object

Specified by:

getDatatypesInSignature in interface HasDatatypesInSignature

Returns:

A set containing the datatypes that are in the signature of this object.The set is a subset of the signature, and is not backed by the signature; it is a modifiable collection and changes are not reflected by the signature.

getNestedClassExpressions

public Set<OWLClassExpression> getNestedClassExpressions()

Description copied from interface: OWLObject

Gets all of the nested (includes top level) class expressions that are used in this object

Specified by:

getNestedClassExpressions in interface OWLObject

Returns:

A set of OWLClassExpressions that represent the nested class expressions used in this object.

isTopEntity

public boolean isTopEntity()

Description copied from interface: OWLObject

Determines if this object is either, owl:Thing (the top class), owl:topObjectProperty (the top object property) , owl:topDataProperty (the top data property) or rdfs:Literal (the top datatype).

Specified by:

isTopEntity in interface OWLObject

Returns:

true if this object corresponds to one of the above entities.

isBottomEntity

public boolean isBottomEntity()

Description copied from interface: OWLObject

Determines if this object is either, owl:Nothing (the bottom class), owl:bottomObjectProperty (the bottom object property) , owl:bottomDataProperty (the bottom data property).

Specified by:

isBottomEntity in interface OWLObject

Returns:

true if this object corresponds to one of the above entities.

compareTo

public int compareTo(OWLObject o)

Specified by:

compareTo in interface Comparable<OWLObject>

hashCode

public int hashCode()

Overrides:

hashCode in class Object