com.clarkparsia.pellet.datatypes

Interface Datatype<T>

All Known Implementing Classes:

AbstractBaseDatatype, AbstractDerivedIntegerType, AbstractTimelineDatatype, InfiniteNamedDatatype, OWLRational, OWLReal, RDFPlainLiteral, XSDAnyURI, XSDBoolean, XSDByte, XSDDate, XSDDateTime, XSDDateTimeStamp, XSDDecimal, XSDDecimal, XSDDouble, XSDDouble, XSDDuration, XSDFloat, XSDFloat, XSDGDay, XSDGMonth, XSDGMonthDay, XSDGYear, XSDGYearMonth, XSDInt, XSDInteger, XSDInteger, XSDLanguage, XSDLong, XSDLong, XSDName, XSDNCName, XSDNegativeInteger, XSDNMToken, XSDNonNegativeInteger, XSDNonPositiveInteger, XSDNormalizedString, XSDPositiveInteger, XSDShort, XSDString, XSDTime, XSDToken, XSDUnsignedByte, XSDUnsignedInt, XSDUnsignedLong, XSDUnsignedShort

public interface Datatype<T>

Title: Datatype

Description: A datatype as described in the OWL 2 specificationf

Copyright: Copyright (c) 2009

Company: Clark & Parsia, LLC.

Author:

Mike Smith

Method Summary

Modifier and Type	Method and Description
RestrictedDatatype<T>	asDataRange() Get the canonical data range for a datatype
aterm.ATermAppl	getCanonicalRepresentation(aterm.ATermAppl input) Get the canonical representation of a lexical form
aterm.ATermAppl	getLiteral(Object value) Get the canonical ATermAppl literal representation for a value space object.
aterm.ATermAppl	getName() Get the datatype identifier
Datatype<?>	getPrimitiveDatatype() Get the primitive datatype associated with this datatype.
T	getValue(aterm.ATermAppl literal) Get the Java object representation of a data value
boolean	isPrimitive() Check if a datatype is primitive.

Method Detail

asDataRange

RestrictedDatatype<T> asDataRange()

Get the canonical data range for a datatype

Returns:

a DataRange representation of the datatype value space

getCanonicalRepresentation

aterm.ATermAppl getCanonicalRepresentation(aterm.ATermAppl input)
                                    throws InvalidLiteralException

Get the canonical representation of a lexical form

Parameters:

input - a lexical form of the literal

Returns:

the canonical representation of the lexical form

Throws:

InvalidLiteralException

getLiteral

aterm.ATermAppl getLiteral(Object value)

Get the canonical ATermAppl literal representation for a value space object. This may be unsupported by datatypes for which isPrimitive() returns false.

Parameters:

value - Element of the value space for some datatype

Returns:

The ATermAppl representation of value

Throws:

IllegalArgumentException - if value is not contained in the value space of the datatype

getName

aterm.ATermAppl getName()

Get the datatype identifier

Returns:

ATermAppl of URI for datatype

getPrimitiveDatatype

Datatype<?> getPrimitiveDatatype()

Get the primitive datatype associated with this datatype.

Returns:

this if isPrimitive() == true, else a primitive datatype that is a superset of the value space of this datatype.

getValue

T getValue(aterm.ATermAppl literal)
    throws InvalidLiteralException

Get the Java object representation of a data value

Parameters:

literal - the literal

Returns:

the Java object representation of the lexical form

Throws:

InvalidLiteralException

isPrimitive

boolean isPrimitive()

Check if a datatype is primitive. All datatypes are either primitive or derived. Derived datatypes are names for subsets of the value spaces of primitive datatypes, defined using specific constraining facet values.

Returns:

true if the datatype is primitive, false else