org.semanticweb.HermiT

Class Prefixes

java.lang.Object

org.semanticweb.HermiT.Prefixes

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Prefixes.ImmutablePrefixes

public class Prefixes
extends Object
implements Serializable

This class is responsible for abbreviating IRIs. The resulting IRIs can be either
1) <uri> or
2) prefix-name:local-name where prefix-name can be empty.
Forms 1 and 2 are dependent upon a set of prefix declarations that associates prefix names with prefix IRIs. A IRI abbreviated using form 2 that uses an unregistered prefix is invalid---expanding it will result in an exception. Neither prefixes nor local names may contain colon characters. The grammar used for various parts of the IRIs is as follows:
PN_CHARS_BASE ::= [A-Z] | [a-z] | [#x00C0-#x00D6] | [#x00D8-#x00F6] | [#x00F8-#x02FF] | [#x0370-#x037D] | [#x037F-#x1FFF] | [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]
PN_CHARS ::= PN_CHARS_BASE | '_' | '-' | [0-9] | #x00B7 | [#x0300-#x036F] | [#x203F-#x2040]
PN_LOCAL ::= ( PN_CHARS_BASE | '_' | [0-9] ) ( ( PN_CHARS | '.' )* PN_CHARS )?
PN_PREFIX ::= PN_CHARS_BASE ( ( PN_CHARS | '.' )* PN_CHARS )?

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Prefixes.ImmutablePrefixes

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,String>	s_semanticWebPrefixes semantic prefixes
static Prefixes	STANDARD_PREFIXES standard prefixes

Constructor Summary

Constructors

Constructor and Description
Prefixes() Prefixes

Method Summary

Modifier and Type	Method and Description
String	abbreviateIRI(String iri)
boolean	addPrefixes(Prefixes prefixes) Registers all the prefixes from the supplied object.
boolean	canBeExpanded(String iri) Checks whether the given IRI can be expanded
boolean	declareDefaultPrefix(String defaultPrefixIRI)
boolean	declareInternalPrefixes(Collection<String> individualIRIs, Collection<String> anonIndividualIRIs) Registers HermiT's internal prefixes with this object.
boolean	declarePrefix(String prefixName, String prefixIRI)
boolean	declareSemanticWebPrefixes() Registers the well-known Semantic Web prefixes.
String	expandAbbreviatedIRI(String abbreviation) Expands a full IRI from the abbreviated one, which is of one of the following forms: 'prefix:name', where 'prefix' is a registered prefix name (can be empty), or '<iri>', where 'iri' is an IRI.
String	getPrefixIRI(String prefixName)
Map<String,String>	getPrefixIRIsByPrefixName()
String	getPrefixName(String prefixIRI)
static boolean	isInternalIRI(String iri) Determines whether the supplied IRI is used internally by HermiT.
static boolean	isValidLocalName(String localName) Determines whether the supplied string is a valid local name.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

s_semanticWebPrefixes

public static final Map<String,String> s_semanticWebPrefixes

semantic prefixes

STANDARD_PREFIXES

public static final Prefixes STANDARD_PREFIXES

standard prefixes

Constructor Detail

Prefixes

public Prefixes()

Prefixes

Method Detail

abbreviateIRI

public String abbreviateIRI(String iri)

Parameters:

iri - iri

Returns:

abbreviated iri

expandAbbreviatedIRI

public String expandAbbreviatedIRI(String abbreviation)

Expands a full IRI from the abbreviated one, which is of one of the following forms: 'prefix:name', where 'prefix' is a registered prefix name (can be empty), or '<iri>', where 'iri' is an IRI.

Parameters:

abbreviation - input

Returns:

expanded string

canBeExpanded

public boolean canBeExpanded(String iri)

Checks whether the given IRI can be expanded

declarePrefix

public boolean declarePrefix(String prefixName,
                             String prefixIRI)

Parameters:

prefixName - prefixName

prefixIRI - prefixIRI

Returns:

true if modification happened

declareDefaultPrefix

public boolean declareDefaultPrefix(String defaultPrefixIRI)

Parameters:

defaultPrefixIRI - defaultPrefixIRI

Returns:

true if modification happened

getPrefixIRIsByPrefixName

public Map<String,String> getPrefixIRIsByPrefixName()

Returns:

iris by name

getPrefixIRI

public String getPrefixIRI(String prefixName)

getPrefixName

public String getPrefixName(String prefixIRI)

Parameters:

prefixIRI - prefixIRI

Returns:

prefix name

declareInternalPrefixes

public boolean declareInternalPrefixes(Collection<String> individualIRIs,
                                       Collection<String> anonIndividualIRIs)

Registers HermiT's internal prefixes with this object.

Parameters:

individualIRIs - the collection of IRIs used in individuals (used for registering nominal prefix names)

anonIndividualIRIs - anonIndividualIRIs

Returns:

'true' if this object already contained one of the internal prefix names

declareSemanticWebPrefixes

public boolean declareSemanticWebPrefixes()

Registers the well-known Semantic Web prefixes.

Returns:

'true' if this object already contained one of the well-known prefixes

addPrefixes

public boolean addPrefixes(Prefixes prefixes)

Registers all the prefixes from the supplied object.

Parameters:

prefixes - the object from which the prefixes are taken

Returns:

'true' if this object already contained one of the prefixes from the supplied object

toString

public String toString()

Overrides:

toString in class Object

isInternalIRI

public static boolean isInternalIRI(String iri)

Determines whether the supplied IRI is used internally by HermiT.

Parameters:

iri - iri

Returns:

true if internal

isValidLocalName

public static boolean isValidLocalName(String localName)

Determines whether the supplied string is a valid local name.

Parameters:

localName - localName

Returns:

true if valid