org.semanticweb.owlapi.util

Class DefaultPrefixManager

java.lang.Object

org.semanticweb.owlapi.util.DefaultPrefixManager

All Implemented Interfaces:

Serializable, PrefixManager, IRIShortFormProvider, ShortFormProvider

public class DefaultPrefixManager
extends Object
implements PrefixManager, ShortFormProvider, IRIShortFormProvider

Author:

Matthew Horridge, The University Of Manchester, Information Management Group, Date: 10-Sep-2008

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultPrefixManager() Creates a namespace manager that does not have a default namespace.
DefaultPrefixManager(Comparator<String> c) Creates a namespace manager that does not have a default namespace.
DefaultPrefixManager(PrefixManager pm)
DefaultPrefixManager(PrefixManager pm, Comparator<String> c)
DefaultPrefixManager(String defaultPrefix) Creates a namespace manager that has the specified default namespace.
DefaultPrefixManager(String defaultPrefix, Comparator<String> c) Creates a namespace manager that has the specified default namespace.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPrefixes(PrefixManager pm)
void	clear() clear the map.
boolean	containsPrefixMapping(String prefix) Determines if this manager knows about a given prefix name and it contains a (non-null) mapping for the prefix.
void	dispose() Disposes of the short form proivider.
String	getDefaultPrefix() Gets the default prefix.
IRI	getIRI(String curie) Gets the URI for a given prefix IRI.
String	getPrefix(String prefixName) Gets the prefix that is bound to a particular prefix name.
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.
String	getShortForm(IRI iri)
String	getShortForm(OWLEntity entity) Gets the short form for the specified entity.
void	setDefaultPrefix(String defaultPrefix) Sets the default namespace.
void	setPrefix(String prefixName, String prefix) Adds a prefix name to prefix mapping.
void	unregisterNamespace(String namespace) Removes a previously registerd prefix namespace mapping.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPrefixManager

public DefaultPrefixManager()

Creates a namespace manager that does not have a default namespace.

DefaultPrefixManager

public DefaultPrefixManager(Comparator<String> c)

Creates a namespace manager that does not have a default namespace.

Parameters:

c - comparator to sort prefixes

DefaultPrefixManager

public DefaultPrefixManager(PrefixManager pm)

Parameters:

pm - the prefix manager to copy

DefaultPrefixManager

public DefaultPrefixManager(PrefixManager pm,
                    Comparator<String> c)

Parameters:

pm - the prefix manager to copy

c - comparator to sort prefixes

DefaultPrefixManager

public DefaultPrefixManager(String defaultPrefix)

Creates a namespace manager that has the specified default namespace.

Parameters:

defaultPrefix - The namespace to be used as the default namespace.

DefaultPrefixManager

public DefaultPrefixManager(String defaultPrefix,
                    Comparator<String> c)

Creates a namespace manager that has the specified default namespace.

Parameters:

defaultPrefix - The namespace to be used as the default namespace.

c - comparator to sort prefixes

Method Detail

addPrefixes

public void addPrefixes(PrefixManager pm)

Parameters:

pm - prefix manager whose prefixes will be added to this manager

clear

public void clear()

clear the map.

getPrefixNames

public Set<String> getPrefixNames()

Description copied from interface: PrefixManager

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

Specified by:

getPrefixNames in interface PrefixManager

Returns:

The prefix names as a set of strings.

setDefaultPrefix

public void setDefaultPrefix(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.

getPrefixIRI

public String getPrefixIRI(IRI iri)

Description copied from interface: PrefixManager

Gets the prefix IRI given a IRI (URI).

Specified by:

getPrefixIRI in interface PrefixManager

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.

getDefaultPrefix

public String getDefaultPrefix()

Description copied from interface: PrefixManager

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

Specified by:

getDefaultPrefix in interface PrefixManager

Returns:

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

containsPrefixMapping

public boolean containsPrefixMapping(String prefix)

Description copied from interface: PrefixManager

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

Specified by:

containsPrefixMapping in interface PrefixManager

Parameters:

prefix - 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.

getIRI

public IRI getIRI(String curie)

Description copied from interface: PrefixManager

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.

Specified by:

getIRI in interface PrefixManager

Parameters:

curie - The Prefix IRI

Returns:

The full IRI.

getPrefixName2PrefixMap

public Map<String,String> getPrefixName2PrefixMap()

Description copied from interface: PrefixManager

Gets a map that maps prefix names to prefixes.

Specified by:

getPrefixName2PrefixMap in interface PrefixManager

Returns:

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

getPrefix

public String getPrefix(String prefixName)

Description copied from interface: PrefixManager

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.

Specified by:

getPrefix in interface PrefixManager

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.

setPrefix

public void setPrefix(String prefixName,
             String prefix)

Adds a prefix name to prefix mapping.

Parameters:

prefixName - name The prefix name (must not be null)

prefix - The prefix. Cannot be null.

Throws:

IllegalArgumentException - if some parameter is null or the prefix name does not end with a colon.

unregisterNamespace

public void unregisterNamespace(String namespace)

Removes a previously registerd prefix namespace mapping.

Parameters:

namespace - The namespace to be removed.

getShortForm

public String getShortForm(IRI iri)

Specified by:

getShortForm in interface IRIShortFormProvider

Parameters:

iri - the IRI to shorten

Returns:

the short form

getShortForm

public String getShortForm(OWLEntity entity)

Description copied from interface: ShortFormProvider

Gets the short form for the specified entity.

Specified by:

getShortForm in interface ShortFormProvider

Parameters:

entity - The entity.

Returns:

A string which represents a short rendering of the speicified entity.

dispose

public void dispose()

Description copied from interface: ShortFormProvider

Disposes of the short form proivider. This frees any resources and clears any caches.

Specified by:

dispose in interface ShortFormProvider