OWLLiteralImplString (OWLAPI Distribution 4.2.2 API)

java.lang.Object
- uk.ac.manchester.cs.owl.owlapi.OWLLiteralImplString

All Implemented Interfaces:

Serializable, Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnonymousIndividuals, HasClassesInSignature, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasIndividualsInSignature, HasLang, HasObjectPropertiesInSignature, HasSignature, OWLAnnotationObject, OWLAnnotationValue, OWLLiteral, OWLObject, OWLPrimitive, OWLPropertyAssertionObject
```
public class OWLLiteralImplString
extends Object
implements OWLLiteral
```
An OWLLiteral with xsd:string datatype and no language tag

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 26-Oct-2006

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

OWLLiteralImplString(String literal)

Constructors
Constructor and Description
`OWLLiteralImplString(String literal)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(OWLAnnotationValueVisitor visitor)`
`<O> O`	`accept(OWLAnnotationValueVisitorEx<O> visitor)`
`void`	`accept(OWLDataVisitor visitor)`
`<O> O`	`accept(OWLDataVisitorEx<O> visitor)`
`void`	`accept(OWLObjectVisitor visitor)` Accepts a visitor
`<O> O`	`accept(OWLObjectVisitorEx<O> visitor)` Accepts a visitor
`com.google.common.base.Optional<OWLAnonymousIndividual>`	`asAnonymousIndividual()`
`com.google.common.base.Optional<IRI>`	`asIRI()`
`com.google.common.base.Optional<OWLLiteral>`	`asLiteral()`
`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.
`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
`OWLDatatype`	`getDatatype()` Gets the `OWLDatatype` which types this literal.
`Set<OWLDatatype>`	`getDatatypesInSignature()` A convenience method that obtains the datatypes that are in the signature of this object
`Set<OWLNamedIndividual>`	`getIndividualsInSignature()` A convenience method that obtains the individuals that are in the signature of this object
`String`	`getLang()` Gets the language tag of this literal.
`String`	`getLiteral()` Gets the lexical value of this literal.
`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`	`hasLang()` Determines if this literal has a language tag.
`boolean`	`hasLang(String l)` 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`	`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`	`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`	`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`	`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 java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

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

- Constructor Detail
  - OWLLiteralImplString
```
public OWLLiteralImplString(@Nonnull
                            String literal)
```
    Parameters:
    
    literal - the lexical form
- 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
  - parseInteger
```
public int parseInteger()
                 throws NumberFormatException
```
    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.
    
    Throws:
    
    NumberFormatException - if the lexical form could not be parsed into an integer because it is not in the lexical space of the integer datatype.
  - 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.
  - 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: OWLLiteral
    
    Gets the language tag of this literal.
    
    Specified by:
    
    getLang in interface HasLang
    
    Specified by:
    
    getLang in interface OWLLiteral
    
    Returns:
    
    The language tag of this 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. (The null value is never returned).
  - hasLang
```
public boolean hasLang(String l)
```
    Description copied from interface: OWLLiteral
    
    Determines if this OWLLiteral has a particular language tag.
    
    Specified by:
    
    hasLang in interface OWLLiteral
    
    Parameters:
    
    l - 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.
    
    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.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - accept
```
public void accept(OWLDataVisitor visitor)
```
    Specified by:
    
    accept in interface OWLLiteral
    
    Parameters:
    
    visitor - visitor
  - accept
```
public <O> O accept(OWLDataVisitorEx<O> visitor)
```
    Specified by:
    
    accept in interface OWLLiteral
    
    Type Parameters:
    
    O - visitor return type
    
    Parameters:
    
    visitor - visitor
    
    Returns:
    
    visitor return value
  - accept
```
public void accept(OWLAnnotationValueVisitor visitor)
```
    Specified by:
    
    accept in interface OWLAnnotationValue
    
    Parameters:
    
    visitor - visitor to accept
  - accept
```
public <O> O accept(OWLAnnotationValueVisitorEx<O> visitor)
```
    Specified by:
    
    accept in interface OWLAnnotationValue
    
    Type Parameters:
    
    O - visitor return type
    
    Parameters:
    
    visitor - visitor to accept
    
    Returns:
    
    visitor value
  - 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
  - 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.
  - 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.
  - 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.
  - 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.
  - 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>
  - 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
  - asIRI
```
public com.google.common.base.Optional<IRI> asIRI()
```
    Specified by:
    
    asIRI in interface OWLAnnotationValue
    
    Returns:
    
    if the value is an IRI, return an optional containing it. Return Optional.absent otherwise.
  - asAnonymousIndividual
```
public com.google.common.base.Optional<OWLAnonymousIndividual> asAnonymousIndividual()
```
    Specified by:
    
    asAnonymousIndividual in interface OWLAnnotationValue
    
    Returns:
    
    if the value is an anonymous, return an optional containing it. Return Optional.absent otherwise.
  - asLiteral
```
public com.google.common.base.Optional<OWLLiteral> asLiteral()
```
    Specified by:
    
    asLiteral in interface OWLAnnotationValue
    
    Returns:
    
    if the value is a literal, return an optional containing it. Return Optional.absent otherwise.

Class OWLLiteralImplString

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

OWLLiteralImplString

Method Detail

getLiteral

hasLang

parseInteger

isRDFPlainLiteral

isInteger

isBoolean

isDouble

isFloat

parseBoolean

parseDouble

parseFloat

getLang

hasLang

getDatatype

hashCode

equals

accept

accept

accept

accept

accept

accept

getSignature

getAnonymousIndividuals

getClassesInSignature

getAnnotationPropertiesInSignature

getDataPropertiesInSignature

getObjectPropertiesInSignature

getIndividualsInSignature

getDatatypesInSignature

getNestedClassExpressions

isTopEntity

isBottomEntity

compareTo

containsEntityInSignature

asIRI

asAnonymousIndividual

asLiteral