Package org.semanticweb.owlapi.util

Class QNameShortFormProvider

java.lang.Object

org.semanticweb.owlapi.util.QNameShortFormProvider

All Implemented Interfaces:

ShortFormProvider

public class QNameShortFormProvider
extends Object
implements ShortFormProvider

A short form provider which creates QNames for entities.

Since:

2.0.0

Author:

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

Constructor Summary

Constructors

Constructor	Description
QNameShortFormProvider()	Creates a QNameShortFormProvider where namespace prefix mappings will automatically be generated.
QNameShortFormProvider(Map<String,String> prefix2NamespaceMap)	Creates a QNameShortFormProvider where the specified map overrides any auto-generated prefix namespace mappings.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes of the short form proivider.
String	getShortForm(OWLEntity entity)	Gets the short form for the specified entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

QNameShortFormProvider

public QNameShortFormProvider()

Creates a QNameShortFormProvider where namespace prefix mappings will automatically be generated.

QNameShortFormProvider

public QNameShortFormProvider(@Nonnull
                              Map<String,String> prefix2NamespaceMap)

Creates a QNameShortFormProvider where the specified map overrides any auto-generated prefix namespace mappings.

Parameters:

prefix2NamespaceMap - The map which contains a prefix to namespace mapping. The prefix must not have a trailing ":"; if one is there, it will be removed

Method Detail

getShortForm

public String getShortForm(@Nonnull
                           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 specified entity. The returned value will not be null but might be an empty string.

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