org.semanticweb.owlapi.formats

Class PrefixDocumentFormatImpl

java.lang.Object

org.semanticweb.owlapi.model.OWLDocumentFormatImpl

org.semanticweb.owlapi.formats.PrefixDocumentFormatImpl

All Implemented Interfaces:

Serializable, PrefixDocumentFormat, OWLDocumentFormat, PrefixManager

Direct Known Subclasses:

AbstractRDFPrefixDocumentFormat, FunctionalSyntaxDocumentFormat, ManchesterSyntaxDocumentFormat, OWLXMLDocumentFormat

public class PrefixDocumentFormatImpl
extends OWLDocumentFormatImpl
implements PrefixDocumentFormat

A PrefixOWLOntologyFormat delegates all PrefixManager operations to a PrefixManager implementation.

Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PrefixDocumentFormatImpl() default constructor
PrefixDocumentFormatImpl(PrefixManager manager)

Method Summary

Modifier and Type	Method and Description
PrefixDocumentFormat	asPrefixOWLOntologyFormat() If this format is an instance of PrefixDocumentFormat then this method will obtain it as a PrefixDocumentFormat.
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	getKey()
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).
String	getPrefixIRIIgnoreQName(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.
boolean	isPrefixOWLOntologyFormat() Determines if this format is an instance of a format that uses prefixes to shorted IRIs.
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	setPrefixManager(PrefixManager m)
void	unregisterNamespace(String namespace) Removes a previously registered prefix namespace mapping

Methods inherited from class org.semanticweb.owlapi.model.OWLDocumentFormatImpl

determineIllegalPunnings, equals, getOntologyLoaderMetaData, getParameter, hashCode, isAddMissingTypes, isMissingType, isTextual, setAddMissingTypes, setOntologyLoaderMetaData, setParameter, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.semanticweb.owlapi.model.OWLDocumentFormat

getOntologyLoaderMetaData, getParameter, isAddMissingTypes, isTextual, setAddMissingTypes, setOntologyLoaderMetaData, setParameter, supportsRelativeIRIs

Constructor Detail

PrefixDocumentFormatImpl

public PrefixDocumentFormatImpl()

default constructor

PrefixDocumentFormatImpl

public PrefixDocumentFormatImpl(@Nonnull
                                PrefixManager manager)

Parameters:

manager - prefix manager to use

Method Detail

setPrefixManager

public void setPrefixManager(@Nonnull
                             PrefixManager m)

Specified by:

setPrefixManager in interface PrefixDocumentFormat

Parameters:

m - prefix manager to use

setPrefix

public void setPrefix(String prefixName,
                      String prefix)

Description copied from interface: PrefixManager

Adds a prefix name to prefix mapping

Specified by:

setPrefix in interface PrefixManager

Parameters:

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

prefix - The prefix.

clear

public void clear()

Description copied from interface: PrefixManager

clear the map

Specified by:

clear in interface PrefixManager

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)

Description copied from interface: PrefixManager

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

Specified by:

setDefaultPrefix in interface PrefixManager

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.

containsPrefixMapping

public boolean containsPrefixMapping(String prefixName)

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:

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.

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.

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.

getIRI

public IRI getIRI(String prefixIRI)

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:

prefixIRI - The Prefix IRI

Returns:

The full IRI.

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.

getPrefixIRIIgnoreQName

public String getPrefixIRIIgnoreQName(IRI iri)

Description copied from interface: PrefixManager

Gets the prefix IRI given a IRI (URI). Does not restrict the response to be a QName

Specified by:

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

copyPrefixesFrom

public void copyPrefixesFrom(PrefixManager from)

Description copied from interface: PrefixManager

Copies the prefix from another prefix manager into this one

Specified by:

copyPrefixesFrom in interface PrefixManager

Parameters:

from - The manager that the prefixes should be copied from

copyPrefixesFrom

public void copyPrefixesFrom(Map<String,String> from)

Description copied from interface: PrefixManager

Copies the prefix from another prefix manager into this one

Specified by:

copyPrefixesFrom in interface PrefixManager

Parameters:

from - The map containing the prefixes

unregisterNamespace

public void unregisterNamespace(String namespace)

Description copied from interface: PrefixManager

Removes a previously registered prefix namespace mapping

Specified by:

unregisterNamespace in interface PrefixManager

Parameters:

namespace - The namespace to be removed.

getPrefixComparator

public StringComparator getPrefixComparator()

Specified by:

getPrefixComparator in interface PrefixManager

Returns:

the prefix comparator currently used by the prefix manager

setPrefixComparator

public void setPrefixComparator(StringComparator comparator)

Specified by:

setPrefixComparator in interface PrefixManager

Parameters:

comparator - the comparator to use

getKey

public String getKey()

Specified by:

getKey in interface OWLDocumentFormat

Returns:

A unique key for this format.

isPrefixOWLOntologyFormat

public boolean isPrefixOWLOntologyFormat()

Description copied from interface: OWLDocumentFormat

Determines if this format is an instance of a format that uses prefixes to shorted IRIs.

Specified by:

isPrefixOWLOntologyFormat in interface OWLDocumentFormat

Returns:

true if this format is an instance of PrefixDocumentFormat other wise false.

asPrefixOWLOntologyFormat

public PrefixDocumentFormat asPrefixOWLOntologyFormat()

Description copied from interface: OWLDocumentFormat

If this format is an instance of PrefixDocumentFormat then this method will obtain it as a PrefixDocumentFormat.

Specified by:

asPrefixOWLOntologyFormat in interface OWLDocumentFormat

Returns:

This format as a more specific PrefixDocumentFormat.