Package org.semanticweb.owlapi.model

Interface PrefixManager

All Superinterfaces:

Serializable

All Known Subinterfaces:

PrefixDocumentFormat

All Known Implementing Classes:

AbstractRDFPrefixDocumentFormat, DefaultPrefixManager, FunctionalSyntaxDocumentFormat, ManchesterSyntaxDocumentFormat, OWLXMLDocumentFormat, PrefixDocumentFormatImpl, RDFXMLDocumentFormat, TurtleDocumentFormat

public interface PrefixManager
extends Serializable

A prefix manager than can provide prefixes for prefix names.

Since:

2.2.0

Author:

Matthew Horridge, The University Of Manchester, Information Management Group

Method Summary

Modifier and Type	Method	Description
void	clear()	clear the map
boolean	containsPrefixMapping(String prefixName)	Determines if this manager knows about a given prefix name and it contains a (non-null) mapping for the prefix.
void	copyPrefixesFrom(Map<String,String> from)	Copies the prefix from another prefix manager into this one
void	copyPrefixesFrom(PrefixManager from)	Copies the prefix from another prefix manager into this one
String	getDefaultPrefix()	Gets the default prefix.
IRI	getIRI(String prefixIRI)	Gets the URI for a given prefix IRI.
String	getPrefix(String prefixName)	Gets the prefix that is bound to a particular prefix name.
StringComparator	getPrefixComparator()
String	getPrefixIRI(IRI iri)	Gets the prefix IRI given a IRI (URI).
Map<String,String>	getPrefixName2PrefixMap()	Gets a map that maps prefix names to prefixes.
Set<String>	getPrefixNames()	Gets the prefix names that have a mapping in this prefix manager.
void	setDefaultPrefix(String defaultPrefix)	Sets the default namespace.
void	setPrefix(String prefixName, String prefix)	Adds a prefix name to prefix mapping
void	setPrefixComparator(StringComparator comparator)
void	unregisterNamespace(String namespace)	Removes a previously registerd prefix namespace mapping

Method Detail

getPrefixComparator

@Nonnull
StringComparator getPrefixComparator()

Returns:

the prefix comparator currently used by the prefix manager

setPrefixComparator

void setPrefixComparator(@Nonnull
                         StringComparator comparator)

Parameters:

comparator - the comparator to use

getDefaultPrefix

@Nullable
String getDefaultPrefix()

Gets the default prefix. The default prefix is denoted by the prefix name ":"

Returns:

The default prefix, or null if there is no default prefix.

containsPrefixMapping

boolean containsPrefixMapping(@Nonnull
                              String prefixName)

Determines if this manager knows about a given prefix name and it contains a (non-null) mapping for the prefix.

Parameters:

prefixName - The prefix name to be tested for.

Returns:

true if the manager knows about this prefix and there is a non-null mapping for this prefix.

getPrefix

@Nullable
String getPrefix(@Nonnull
                 String prefixName)

Gets the prefix that is bound to a particular prefix name. Note that specifying ":" corresponds to requesting the default prefix and will return the same result as a call to the getDefaultPrefix() method.

Parameters:

prefixName - The prefix name. A string that represents a prefix name of the prefix to be retrieved. Note that specifying ":" is the same as asking for the default prefix (see the getDefaultPrefix() method).

Returns:

The prefix, or null if there is no prefix name bound to this prefix, or the prefix name doesn't exist.

getPrefixName2PrefixMap

@Nonnull
Map<String,String> getPrefixName2PrefixMap()

Gets a map that maps prefix names to prefixes.

Returns:

The map of prefix names to prefixes. Note that modifying the contents of this map will not change the prefix name - prefix mappings

getIRI

@Nonnull
IRI getIRI(@Nonnull
           String prefixIRI)

Gets the URI for a given prefix IRI. The prefix IRI must have a prefix name that is registered with this manager, or a runtime exception will be thrown.

Parameters:

prefixIRI - The Prefix IRI

Returns:

The full IRI.

Throws:

OWLRuntimeException - if the prefix name of the prefix IRI doesn't have a corresponding prefix managed by this manager.

getPrefixIRI

@Nullable
String getPrefixIRI(@Nonnull
                    IRI iri)

Gets the prefix IRI given a IRI (URI).

Parameters:

iri - The IRI whose prefix it to be retrieved

Returns:

The prefix IRI for this IRI, or null if a prefix IRI cannot be generated.

getPrefixNames

@Nonnull
Set<String> getPrefixNames()

Gets the prefix names that have a mapping in this prefix manager.

Returns:

The prefix names as a set of strings.

setDefaultPrefix

void setDefaultPrefix(@Nullable
                      String defaultPrefix)

Sets the default namespace. This will also bind the prefix name ":" to this prefix

Parameters:

defaultPrefix - The namespace to be used as the default namespace. Note that the value may be null in order to clear the default namespace.

setPrefix

void setPrefix(@Nonnull
               String prefixName,
               @Nonnull
               String prefix)

Adds a prefix name to prefix mapping

Parameters:

prefixName - name The prefix name (must end with a colon)

prefix - The prefix.

copyPrefixesFrom

void copyPrefixesFrom(@Nonnull
                      PrefixManager from)

Copies the prefix from another prefix manager into this one

Parameters:

from - The manager that the prefixes should be copied from

copyPrefixesFrom

void copyPrefixesFrom(@Nonnull
                      Map<String,String> from)

Copies the prefix from another prefix manager into this one

Parameters:

from - The map containing the prefixes

unregisterNamespace

void unregisterNamespace(@Nonnull
                         String namespace)

Removes a previously registerd prefix namespace mapping

Parameters:

namespace - The namespace to be removed.

clear

void clear()

clear the map