org.semanticweb.owlapi.vocab

Class PrefixOWLOntologyFormat

java.lang.Object

org.semanticweb.owlapi.model.OWLOntologyFormat

org.semanticweb.owlapi.vocab.PrefixOWLOntologyFormat

All Implemented Interfaces:

Serializable, PrefixManager

Direct Known Subclasses:

OWLFunctionalSyntaxOntologyFormat, OWLXMLOntologyFormat, RDFOntologyFormat

public class PrefixOWLOntologyFormat
extends OWLOntologyFormat
implements PrefixManager

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 20-Feb-2007

See Also:

Serialized Form

Field Summary

Fields inherited from class org.semanticweb.owlapi.model.OWLOntologyFormat

USE_INTERMEDIATE_OUTPUT_FILE

Constructor Summary

Constructors

Constructor and Description
PrefixOWLOntologyFormat() default constructor
PrefixOWLOntologyFormat(DefaultPrefixManager manager)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearPrefixes() Clears any previously set prefixes.
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	copyPrefixesFrom(PrefixManager prefixManager)
void	copyPrefixesFrom(PrefixOWLOntologyFormat fromFormat) Copies the prefix from another ontology format into this format.
String	getDefaultPrefix() Gets the default prefix.
IRI	getIRI(String iri) 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.
void	setDefaultPrefix(String namespace) Sets the default namespace.
void	setPrefix(String prefixName, String prefix) A convenience method to add a prefix name to prefix mapping.
void	setPrefixManager(DefaultPrefixManager m)

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

asPrefixOWLOntologyFormat, equals, getOntologyLoaderMetaData, getParameter, hashCode, isPrefixOWLOntologyFormat, setOntologyLoaderMetaData, setParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

PrefixOWLOntologyFormat

public PrefixOWLOntologyFormat()

default constructor

PrefixOWLOntologyFormat

public PrefixOWLOntologyFormat(DefaultPrefixManager manager)

Parameters:

manager - prefix manager to use

Method Detail

setPrefixManager

public void setPrefixManager(DefaultPrefixManager m)

Parameters:

m - prefix manager to use

setPrefix

public void setPrefix(String prefixName,
             String prefix)

A convenience method to add a prefix name to prefix mapping.

Parameters:

prefixName - The prefix name which maps to a prefix

prefix - The prefix

clearPrefixes

public void clearPrefixes()

Clears any previously set prefixes.

copyPrefixesFrom

public void copyPrefixesFrom(PrefixOWLOntologyFormat fromFormat)

Copies the prefix from another ontology format into this format.

Parameters:

fromFormat - The format that the prefixes should be copied from

copyPrefixesFrom

public void copyPrefixesFrom(PrefixManager prefixManager)

Parameters:

prefixManager - prefix to copy prefixes from

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 namespace)

Sets the default namespace. This is equivalent to adding mapping from the empty string prefix to a namespace.

Parameters:

namespace - The namespace to be set.

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.

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 iri)

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:

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