uk.ac.manchester.cs.owl.owlapi

Class OWLLiteralImpl

java.lang.Object

uk.ac.manchester.cs.owl.owlapi.OWLObjectImpl

uk.ac.manchester.cs.owl.owlapi.OWLLiteralImpl

All Implemented Interfaces:

Serializable, Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnonymousIndividuals, HasClassesInSignature, HasComponents, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasHashIndex, HasIndex, HasIndividualsInSignature, HasLang, HasObjectPropertiesInSignature, HasSignature, IsAnonymous, OWLAnnotationObject, OWLAnnotationValue, OWLLiteral, OWLObject, OWLPrimitive, OWLPropertyAssertionObject, HasIncrementalSignatureGenerationSupport

public class OWLLiteralImpl
extends OWLObjectImpl
implements OWLLiteral

Implementation of OWLLiteral that uses compression of strings. See also OWLLiteralImplNoCompression

Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OWLLiteralImpl(String literal, String lang, OWLDatatype datatype)

Method Summary

Modifier and Type	Method and Description
OWLDatatype	getDatatype() Gets the OWLDatatype which types this literal.
String	getLang() Gets the language tag of the literal.
String	getLiteral() Gets the lexical value of this literal.
boolean	hasLang() Determines if this literal has a language tag.
boolean	hasLang(String lang) Determines if this OWLLiteral has a particular language tag.
boolean	isBoolean() Determines if this literal is typed with a datatype that has an IRI that is "http://www.w3.org/2001/XMLSchema#"boolean.
boolean	isDouble() Determines if this literal is typed with a datatype that has an IRI that is "http://www.w3.org/2001/XMLSchema#"double.
boolean	isFloat() Determines if this literal is typed with a datatype that has an IRI that is "http://www.w3.org/2001/XMLSchema#"float.
boolean	isInteger() Determines if this literal is typed with a datatype that has an IRI that is "http://www.w3.org/2001/XMLSchema#"integer.
boolean	isRDFPlainLiteral() Determines if the datatype of this literal is rdf:PlainLiteral.
boolean	parseBoolean() Parses the lexical value of this literal into a boolean.
double	parseDouble() Parses the lexical value of this literal into a double.
float	parseFloat() Parses the lexical value of this literal into a float.
int	parseInteger() Parses the lexical value of this literal into an integer.

Methods inherited from class uk.ac.manchester.cs.owl.owlapi.OWLObjectImpl

annotationPropertiesInSignature, anonymousIndividuals, classesInSignature, compareTo, containsEntityInSignature, dataPropertiesInSignature, datatypesInSignature, equals, hashCode, individualsInSignature, nestedClassExpressions, objectPropertiesInSignature, signature, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.semanticweb.owlapi.model.OWLLiteral

accept, accept, accept, accept, accept, accept, asLiteral, components, hashIndex, typeIndex

Methods inherited from interface org.semanticweb.owlapi.model.OWLAnnotationObject

asAnonymousIndividual, asIRI

Methods inherited from interface org.semanticweb.owlapi.model.OWLObject

getNestedClassExpressions, hasSharedStructure, isAnonymousExpression, isAxiom, isBottomEntity, isIndividual, isIRI, isOntology, isTopEntity, nestedClassExpressions

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.semanticweb.owlapi.model.HasSignature

getSignature, signature

Methods inherited from interface org.semanticweb.owlapi.model.HasContainsEntityInSignature

containsEntityInSignature

Methods inherited from interface org.semanticweb.owlapi.model.HasAnonymousIndividuals

anonymousIndividuals, getAnonymousIndividuals

Methods inherited from interface org.semanticweb.owlapi.model.HasClassesInSignature

classesInSignature, getClassesInSignature

Methods inherited from interface org.semanticweb.owlapi.model.HasObjectPropertiesInSignature

getObjectPropertiesInSignature, objectPropertiesInSignature

Methods inherited from interface org.semanticweb.owlapi.model.HasDataPropertiesInSignature

dataPropertiesInSignature, getDataPropertiesInSignature

Methods inherited from interface org.semanticweb.owlapi.model.HasIndividualsInSignature

getIndividualsInSignature, individualsInSignature

Methods inherited from interface org.semanticweb.owlapi.model.HasDatatypesInSignature

datatypesInSignature, getDatatypesInSignature

Methods inherited from interface org.semanticweb.owlapi.model.HasAnnotationPropertiesInSignature

annotationPropertiesInSignature, getAnnotationPropertiesInSignature

Methods inherited from interface org.semanticweb.owlapi.model.HasComponents

componentsAnnotationsFirst, componentsWithoutAnnotations

Methods inherited from interface org.semanticweb.owlapi.model.IsAnonymous

isAnonymous

Methods inherited from interface uk.ac.manchester.cs.owl.owlapi.HasIncrementalSignatureGenerationSupport

addAnonymousIndividualsToSet, addSignatureEntitiesToSet

Constructor Detail

OWLLiteralImpl

public OWLLiteralImpl(String literal,
                      @Nullable
                      String lang,
                      @Nullable
                      OWLDatatype datatype)

Parameters:

literal - the lexical form

lang - the language; can be null or an empty string, in which case datatype can be any datatype but not null

datatype - the datatype; if lang is null or the empty string, it can be null or it MUST be RDFPlainLiteral

Method Detail

getLiteral

public String getLiteral()

Description copied from interface: OWLLiteral

Gets the lexical value of this literal. Note that if the datatype is rdf:PlainLiteral then the abbreviated lexical form will be returned. That is, the language tag is not included.

Specified by:

getLiteral in interface OWLLiteral

Returns:

The lexical value of this literal. If the datatype is rdf:PlainLiteral then the return values are as follows: If the literal is of the form "abc@"^^rdf:PlainLiteral then the return value will be "abc" (without the language tag included). If the literal is of the form "abc@langTag"^^rdf:PlainLiteral then the return value will be "abc" (without the language tag included).

hasLang

public boolean hasLang()

Description copied from interface: OWLLiteral

Determines if this literal has a language tag.

Specified by:

hasLang in interface OWLLiteral

Returns:

true if this literal has a non-empty language tag, otherwise false

isRDFPlainLiteral

public boolean isRDFPlainLiteral()

Description copied from interface: OWLLiteral

Determines if the datatype of this literal is rdf:PlainLiteral. Note that literals that are abbreviated in the functional syntax (and other concrete syntaxes) and are of the form "abc" or "abc"@langTag will be of the type rdf:PlainLiteral after parsing.

Specified by:

isRDFPlainLiteral in interface OWLLiteral

Returns:

true if the datatype of this literal is rdf:PlainLiteral, otherwise false.

isInteger

public boolean isInteger()

Description copied from interface: OWLLiteral

Determines if this literal is typed with a datatype that has an IRI that is "http://www.w3.org/2001/XMLSchema#"integer.

Specified by:

isInteger in interface OWLLiteral

Returns:

true if this literal is typed with "http://www.w3.org/2001/XMLSchema#"integer, i.e. this literal represents an integer, otherwise false.

isBoolean

public boolean isBoolean()

Description copied from interface: OWLLiteral

Determines if this literal is typed with a datatype that has an IRI that is "http://www.w3.org/2001/XMLSchema#"boolean.

Specified by:

isBoolean in interface OWLLiteral

Returns:

true if this literal is typed with "http://www.w3.org/2001/XMLSchema#"boolean, i.e. this literal represents a boolean, otherwise false.

isDouble

public boolean isDouble()

Description copied from interface: OWLLiteral

Determines if this literal is typed with a datatype that has an IRI that is "http://www.w3.org/2001/XMLSchema#"double.

Specified by:

isDouble in interface OWLLiteral

Returns:

true if this literal is typed with "http://www.w3.org/2001/XMLSchema#"double, i.e. this literal represents a double, otherwise false.

isFloat

public boolean isFloat()

Description copied from interface: OWLLiteral

Determines if this literal is typed with a datatype that has an IRI that is "http://www.w3.org/2001/XMLSchema#"float.

Specified by:

isFloat in interface OWLLiteral

Returns:

true if this literal is typed with "http://www.w3.org/2001/XMLSchema#"float, i.e. this literal represents a float, otherwise false.

parseInteger

public int parseInteger()

Description copied from interface: OWLLiteral

Parses the lexical value of this literal into an integer. The lexical value of this literal should be in the lexical space of the integer datatype ("http://www.w3.org/2001/XMLSchema#"integer)

Specified by:

parseInteger in interface OWLLiteral

Returns:

An integer value that is represented by this literal.

parseBoolean

public boolean parseBoolean()

Description copied from interface: OWLLiteral

Parses the lexical value of this literal into a boolean. The lexical value of this literal should be in the lexical space of the boolean datatype ("http://www.w3.org/2001/XMLSchema#"boolean).

Specified by:

parseBoolean in interface OWLLiteral

Returns:

A boolean value that is represented by this literal.

parseDouble

public double parseDouble()

Description copied from interface: OWLLiteral

Parses the lexical value of this literal into a double. The lexical value of this literal should be in the lexical space of the double datatype ( "http://www.w3.org/2001/XMLSchema#"double).

Specified by:

parseDouble in interface OWLLiteral

Returns:

A double value that is represented by this literal.

parseFloat

public float parseFloat()

Description copied from interface: OWLLiteral

Parses the lexical value of this literal into a float. The lexical value of this literal should be in the lexical space of the float datatype ( "http://www.w3.org/2001/XMLSchema#"float).

Specified by:

parseFloat in interface OWLLiteral

Returns:

A float value that is represented by this literal.

getLang

public String getLang()

Description copied from interface: HasLang

Gets the language tag of the literal.

Specified by:

getLang in interface HasLang

Specified by:

getLang in interface OWLLiteral

Returns:

A string representing the language tag of a literal. If the literal does not have a language tag, because it is not of the type rdf:PlainLiteral, or because its language tag is empty, then the empty string will be returned.

hasLang

public boolean hasLang(@Nullable
                       String lang)

Description copied from interface: OWLLiteral

Determines if this OWLLiteral has a particular language tag.

Specified by:

hasLang in interface OWLLiteral

Parameters:

lang - The specific lang to test for. The tag will be normalised - white space will be trimmed from the end and it will be converted to lower case. Null input will be treted as empty.

Returns:

true if this literal has a language tag equal to lang, otherwise false.

getDatatype

public OWLDatatype getDatatype()

Description copied from interface: OWLLiteral

Gets the OWLDatatype which types this literal.

Specified by:

getDatatype in interface OWLLiteral

Returns:

The OWLDatatype that types this literal. Note that for strings with language tag (previously considered to be untyped literals) the datatype will be rdf:PlainLiteral. The return value is never null.