IRI (OWLAPI Model Interfaces and utilities 3.5.0 API)

java.lang.Object
- org.semanticweb.owlapi.model.IRI

All Implemented Interfaces:

Serializable, CharSequence, Comparable<OWLObject>, HasAnonymousIndividuals, HasClassesInSignature, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasIndividualsInSignature, HasObjectPropertiesInSignature, HasSignature, OWLAnnotationObject, OWLAnnotationSubject, OWLAnnotationValue, OWLObject, OWLPrimitive, SWRLPredicate
```
public class IRI
extends Object
implements OWLAnnotationSubject, OWLAnnotationValue, SWRLPredicate, OWLPrimitive, CharSequence
```
Author:

Matthew Horridge, The University of Manchester, Information Management Group, Date: 14-Jan-2009 Represents International Resource Identifiers

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`IRI(String s)`
`protected`	`IRI(String prefix, String fragment)` Constructs an IRI which is built from the concatenation of the specified prefix and suffix.
`protected`	`IRI(URI uri)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`accept(OWLAnnotationSubjectVisitor visitor)`
`<E> E`	`accept(OWLAnnotationSubjectVisitorEx<E> visitor)`
`void`	`accept(OWLAnnotationValueVisitor visitor)`
`<O> O`	`accept(OWLAnnotationValueVisitorEx<O> visitor)`
`void`	`accept(OWLObjectVisitor visitor)` Accepts a visitor
`<O> O`	`accept(OWLObjectVisitorEx<O> visitor)` Accepts a visitor
`char`	`charAt(int index)`
`int`	`compareTo(OWLObject o)`
`boolean`	`containsEntityInSignature(OWLEntity owlEntity)` Determines if the signature of this object contains the specified entity.
`static IRI`	`create(File file)`
`static IRI`	`create(String str)` Creates an IRI from the specified String.
`static IRI`	`create(String prefix, String suffix)` Creates an IRI by concatenating two strings.
`static IRI`	`create(URI uri)`
`static IRI`	`create(URL url)`
`boolean`	`equals(Object obj)`
`static IRI`	`generateDocumentIRI()` Gets an auto-generated ontology document IRI.
`Set<OWLAnonymousIndividual>`	`getAnonymousIndividuals()` Gets the anonymous individuals occurring in this object, as collected by an OWLEntityCollector.
`Set<OWLClass>`	`getClassesInSignature()` A convenience method that obtains the classes that are 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
`Set<OWLDatatype>`	`getDatatypesInSignature()` A convenience method that obtains the datatypes that are in the signature of this object
`String`	`getFragment()` Gets the fragment of the IRI.
`Set<OWLNamedIndividual>`	`getIndividualsInSignature()` A convenience method that obtains the individuals that are in the signature of this object
`String`	`getNamespace()`
`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
`String`	`getScheme()`
`Set<OWLEntity>`	`getSignature()` Gets the signature of this object
`String`	`getStart()` Deprecated. use getNamespace instead - better name
`int`	`hashCode()`
`boolean`	`isAbsolute()` Determines if this IRI is absolute
`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`	`isNothing()` Determines if this IRI is equal to the IRI that `owl:Nothing` is named with
`boolean`	`isPlainLiteral()` Determines if this IRI is equal to the IRI that is named `rdf:PlainLiteral`
`boolean`	`isReservedVocabulary()` Determines if this IRI is in the reserved vocabulary.
`boolean`	`isThing()` Determines if this IRI is equal to the IRI that `owl:Thing` is named with
`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).
`int`	`length()`
`IRI`	`resolve(String s)`
`CharSequence`	`subSequence(int start, int end)`
`String`	`toQuotedString()` Obtained this IRI surrounded by angled brackets
`String`	`toString()`
`URI`	`toURI()` Obtains this IRI as a URI.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence
chars, codePoints

- Constructor Detail
  - IRI
```
protected IRI(String prefix,
              String fragment)
```
    Constructs an IRI which is built from the concatenation of the specified prefix and suffix.
    
    Parameters:
    
    prefix - The prefix.
    
    fragment - The suffix.
  - IRI
```
protected IRI(String s)
```
  - IRI
```
protected IRI(URI uri)
```
- Method Detail
  - toURI
```
public URI toURI()
```
    Obtains this IRI as a URI. Note that Java URIs handle unicode characters, so there is no loss during this translation.
    
    Returns:
    
    The URI
  - isAbsolute
```
public boolean isAbsolute()
```
    Determines if this IRI is absolute
    
    Returns:
    
    true if this IRI is absolute or false if this IRI is not absolute
  - getScheme
```
public String getScheme()
```
    Returns:
    
    the IRI scheme, e.g., http, urn... can be null
  - getStart
```
@Deprecated
public String getStart()
```
    Deprecated. use getNamespace instead - better name
    
    Returns:
    
    the prefix. Can be null.
  - getNamespace
```
public String getNamespace()
```
    Returns:
    
    the prefix. Can be null.
  - resolve
```
public IRI resolve(String s)
```
    Parameters:
    
    s - the IRI stirng to be resolved
    
    Returns:
    
    s resolved against this IRI (with the URI::resolve() method, unless this IRI is opaque)
  - isReservedVocabulary
```
public boolean isReservedVocabulary()
```
    Determines if this IRI is in the reserved vocabulary. An IRI is in the reserved vocabulary if it starts with <http://www.w3.org/1999/02/22-rdf-syntax-ns#> or <http://www.w3.org/2000/01/rdf-schema#> or <http://www.w3.org/2001/XMLSchema#> or <http://www.w3.org/2002/07/owl#>
    
    Returns:
    
    true if the IRI is in the reserved vocabulary, otherwise false.
  - isThing
```
public boolean isThing()
```
    Determines if this IRI is equal to the IRI that owl:Thing is named with
    
    Returns:
    
    true if this IRI is equal to <http://www.w3.org/2002/07/owl#Thing> and otherwise false
  - isNothing
```
public boolean isNothing()
```
    Determines if this IRI is equal to the IRI that owl:Nothing is named with
    
    Returns:
    
    true if this IRI is equal to <http://www.w3.org/2002/07/owl#Nothing> and otherwise false
  - isPlainLiteral
```
public boolean isPlainLiteral()
```
    Determines if this IRI is equal to the IRI that is named rdf:PlainLiteral
    
    Returns:
    
    true if this IRI is equal to <http://www.w3.org/1999/02/22-rdf-syntax-ns#PlainLiteral>, otherwise false
  - getFragment
```
public String getFragment()
```
    Gets the fragment of the IRI.
    
    Returns:
    
    The IRI fragment, or null if the IRI does not have a fragment
  - toQuotedString
```
public String toQuotedString()
```
    Obtained this IRI surrounded by angled brackets
    
    Returns:
    
    This IRI surrounded by < and >
  - create
```
public static IRI create(String str)
```
    Creates an IRI from the specified String.
    
    Parameters:
    
    str - The String that specifies the IRI. Cannot be null.
    
    Returns:
    
    The IRI that has the specified string representation.
  - create
```
public static IRI create(String prefix,
                         String suffix)
```
    Creates an IRI by concatenating two strings. The full IRI is an IRI that contains the characters in prefix + suffix.
    
    Parameters:
    
    prefix - The first string. May be null.
    
    suffix - The second string. May be null.
    
    Returns:
    
    An IRI whose characters consist of prefix + suffix.
    
    Since:
    
    3.3
  - create
```
public static IRI create(File file)
```
    Parameters:
    
    file - the file to create the IRI from. Cannot be null.
    
    Returns:
    
    file.toURI() IRI
  - create
```
public static IRI create(URI uri)
```
    Parameters:
    
    uri - the uri to create the IRI from. Cannot be null
    
    Returns:
    
    the IRI wrapping the uri
  - create
```
public static IRI create(URL url)
                  throws URISyntaxException
```
    Parameters:
    
    url - the url to create the IRI from. Cannot be null.
    
    Returns:
    
    an IRI wraopping url.toURI()
    
    Throws:
    
    URISyntaxException - if the URL is ill formed
  - generateDocumentIRI
```
public static IRI generateDocumentIRI()
```
    Gets an auto-generated ontology document IRI.
    
    Returns:
    
    An auto-generated ontology document IRI. The IRI has the form owlapi:ontologyTIMESTAMP
  - length
```
public int length()
```
    Specified by:
    
    length in interface CharSequence
  - charAt
```
public char charAt(int index)
```
    Specified by:
    
    charAt in interface CharSequence
  - subSequence
```
public CharSequence subSequence(int start,
                                int end)
```
    Specified by:
    
    subSequence in interface CharSequence
  - 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 void accept(OWLAnnotationSubjectVisitor visitor)
```
    Specified by:
    
    accept in interface OWLAnnotationSubject
    
    Parameters:
    
    visitor - visitor to accept
  - accept
```
public <E> E accept(OWLAnnotationSubjectVisitorEx<E> visitor)
```
    Specified by:
    
    accept in interface OWLAnnotationSubject
    
    Type Parameters:
    
    E - visitor return type
    
    Parameters:
    
    visitor - visitor to accept
    
    Returns:
    
    visitor value
  - getClassesInSignature
```
public Set<OWLClass> getClassesInSignature()
```
    Description copied from interface: OWLObject
    
    A convenience method that obtains the classes that are in the signature of this object
    
    Specified by:
    
    getClassesInSignature in interface HasClassesInSignature
    
    Specified by:
    
    getClassesInSignature in interface OWLObject
    
    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: OWLObject
    
    A convenience method that obtains the data properties that are in the signature of this object
    
    Specified by:
    
    getDataPropertiesInSignature in interface HasDataPropertiesInSignature
    
    Specified by:
    
    getDataPropertiesInSignature in interface OWLObject
    
    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.
  - getIndividualsInSignature
```
public Set<OWLNamedIndividual> getIndividualsInSignature()
```
    Description copied from interface: OWLObject
    
    A convenience method that obtains the individuals that are in the signature of this object
    
    Specified by:
    
    getIndividualsInSignature in interface HasIndividualsInSignature
    
    Specified by:
    
    getIndividualsInSignature in interface OWLObject
    
    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.
  - getObjectPropertiesInSignature
```
public Set<OWLObjectProperty> getObjectPropertiesInSignature()
```
    Description copied from interface: OWLObject
    
    A convenience method that obtains the object properties that are in the signature of this object
    
    Specified by:
    
    getObjectPropertiesInSignature in interface HasObjectPropertiesInSignature
    
    Specified by:
    
    getObjectPropertiesInSignature in interface OWLObject
    
    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.
  - getSignature
```
public Set<OWLEntity> getSignature()
```
    Description copied from interface: OWLObject
    
    Gets the signature of this object
    
    Specified by:
    
    getSignature in interface HasSignature
    
    Specified by:
    
    getSignature in interface OWLObject
    
    Returns:
    
    A set of entities that correspond to the signature of this object. The set is a copy, 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: OWLObject
    
    Gets the anonymous individuals occurring in this object, as collected by an OWLEntityCollector. The set is a copy, changes are not reflected back.
    
    Specified by:
    
    getAnonymousIndividuals in interface HasAnonymousIndividuals
    
    Specified by:
    
    getAnonymousIndividuals in interface OWLObject
    
    Returns:
    
    A set of anonymous individuals.
  - getDatatypesInSignature
```
public Set<OWLDatatype> getDatatypesInSignature()
```
    Description copied from interface: OWLObject
    
    A convenience method that obtains the datatypes that are in the signature of this object
    
    Specified by:
    
    getDatatypesInSignature in interface HasDatatypesInSignature
    
    Specified by:
    
    getDatatypesInSignature in interface OWLObject
    
    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.
  - compareTo
```
public int compareTo(OWLObject o)
```
    Specified by:
    
    compareTo in interface Comparable<OWLObject>
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - 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
  - 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.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class IRI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.CharSequence

Constructor Detail

IRI

IRI

IRI

Method Detail

toURI

isAbsolute

getScheme

getStart

getNamespace

resolve

isReservedVocabulary

isThing

isNothing

isPlainLiteral

getFragment

toQuotedString

create

create

create

create

create

generateDocumentIRI

length

charAt

subSequence

accept

accept

accept

accept

getClassesInSignature

getDataPropertiesInSignature

getIndividualsInSignature

getObjectPropertiesInSignature

getSignature

containsEntityInSignature

getAnonymousIndividuals

getDatatypesInSignature

getNestedClassExpressions

compareTo

toString

hashCode

accept

accept

isTopEntity

isBottomEntity

equals