org.semanticweb.owlapi.model

Class IRI

java.lang.Object

org.semanticweb.owlapi.model.IRI

All Implemented Interfaces:

Serializable, CharSequence, Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnonymousIndividuals, HasClassesInSignature, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasIndividualsInSignature, HasObjectPropertiesInSignature, HasShortForm, HasSignature, OWLAnnotationObject, OWLAnnotationSubject, OWLAnnotationValue, OWLObject, OWLPrimitive, SWRLPredicate

public class IRI
extends Object
implements OWLAnnotationSubject, OWLAnnotationValue, SWRLPredicate, CharSequence, OWLPrimitive, HasShortForm

Represents International Resource Identifiers

Since:

3.0.0

Author:

Matthew Horridge, The University of Manchester, Information Management Group

See Also:

Serialized Form

Method Summary

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
com.google.common.base.Optional<OWLAnonymousIndividual>	asAnonymousIndividual()
com.google.common.base.Optional<IRI>	asIRI()
com.google.common.base.Optional<OWLLiteral>	asLiteral()
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<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
Set<OWLDatatype>	getDatatypesInSignature() A convenience method that obtains the datatypes that are in the signature of this object
String	getFragment() Deprecated. use getNCName() - getFragment() does not return a real fragment. e.g., it does not allow / and () on it
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
com.google.common.base.Optional<String>	getRemainder()
String	getScheme()
String	getShortForm() Gets the short form.
Set<OWLEntity>	getSignature() Gets the signature of this object.
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()
String	prefixedBy(String prefix)
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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Method Detail

toURI

@Nonnull
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

@Nullable
public String getScheme()

Returns:

the IRI scheme, e.g., http, urn

getNamespace

@Nonnull
public String getNamespace()

Returns:

the prefix

resolve

@Nonnull
public IRI resolve(@Nonnull
                            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

@Deprecated
 @Nonnull
public String getFragment()

Deprecated. use getNCName() - getFragment() does not return a real fragment. e.g., it does not allow / and () on it

Gets the fragment of the IRI.

Returns:

The IRI fragment, or empty string if the IRI does not have a fragment

getRemainder

@Nonnull
public com.google.common.base.Optional<String> getRemainder()

Returns:

the remainder (coincident with NCName usually) for this IRI.

toQuotedString

@Nonnull
public String toQuotedString()

Obtained this IRI surrounded by angled brackets

Returns:

This IRI surrounded by < and >

create

@Nonnull
public static IRI create(@Nonnull
                                  String str)

Creates an IRI from the specified String.

Parameters:

str - The String that specifies the IRI

Returns:

The IRI that has the specified string representation.

create

@Nonnull
public static IRI create(@Nullable
                                  String prefix,
                                  @Nullable
                                  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

suffix - The second string

Returns:

An IRI whose characters consist of prefix + suffix.

Since:

3.3

create

@Nonnull
public static IRI create(@Nonnull
                                  File file)

Parameters:

file - the file to create the IRI from

Returns:

file.toURI() IRI

create

@Nonnull
public static IRI create(@Nonnull
                                  URI uri)

Parameters:

uri - the uri to create the IRI from

Returns:

the IRI wrapping the uri

create

@Nonnull
public static IRI create(@Nonnull
                                  URL url)

Parameters:

url - the url to create the IRI from

Returns:

an IRI wrapping url.toURI()

Throws:

OWLRuntimeException - if the URL is ill formed

generateDocumentIRI

@Nonnull
public static IRI generateDocumentIRI()

Gets an auto-generated ontology document IRI.

Returns:

An auto-generated ontology document IRI. The IRI has the form owlapi:ontologyNNNNNNNNNNN

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

prefixedBy

@Nonnull
public String prefixedBy(@Nonnull
                                  String prefix)

Parameters:

prefix - prefix to use for replacing the IRI namespace

Returns:

prefix plus IRI ncname

getShortForm

@Nonnull
public String getShortForm()

Description copied from interface: HasShortForm

Gets the short form.

Specified by:

getShortForm in interface HasShortForm

Returns:

A string that represents the short form. Not null.

accept

public void accept(@Nonnull
                   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(@Nonnull
                    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(@Nonnull
                   OWLAnnotationSubjectVisitor visitor)

Specified by:

accept in interface OWLAnnotationSubject

Parameters:

visitor - visitor to accept

accept

public <E> E accept(@Nonnull
                    OWLAnnotationSubjectVisitorEx<E> visitor)

Specified by:

accept in interface OWLAnnotationSubject

Type Parameters:

E - visitor return type

Parameters:

visitor - visitor to accept

Returns:

visitor value

getClassesInSignature

@Nonnull
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

@Nonnull
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.

getIndividualsInSignature

@Nonnull
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.

getObjectPropertiesInSignature

@Nonnull
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.

getSignature

@Nonnull
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

@Nonnull
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

getDatatypesInSignature

@Nonnull
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.

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.

getNestedClassExpressions

@Nonnull
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

@Nonnull
public String toString()

Specified by:

toString in interface CharSequence

Specified by:

toString in interface OWLObject

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

accept

public void accept(@Nonnull
                   OWLAnnotationValueVisitor visitor)

Specified by:

accept in interface OWLAnnotationValue

Parameters:

visitor - visitor to accept

accept

public <O> O accept(@Nonnull
                    OWLAnnotationValueVisitorEx<O> visitor)

Specified by:

accept in interface OWLAnnotationValue

Type Parameters:

O - visitor return type

Parameters:

visitor - visitor to accept

Returns:

visitor value

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.

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