org.semanticweb.owlapi.util

Class BidirectionalShortFormProviderAdapter

java.lang.Object

org.semanticweb.owlapi.util.CachingBidirectionalShortFormProvider

org.semanticweb.owlapi.util.BidirectionalShortFormProviderAdapter

All Implemented Interfaces:

BidirectionalShortFormProvider, ShortFormProvider

public class BidirectionalShortFormProviderAdapter
extends CachingBidirectionalShortFormProvider

A bidirectional short form provider which uses a specified short form provider to generate the bidirectional entity--shortform mappings.

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 18-Apr-2007

Constructor Summary

Constructors

Constructor and Description
BidirectionalShortFormProviderAdapter(OWLOntologyManager man, Set<OWLOntology> ontologies, ShortFormProvider shortFormProvider) Creates a BidirectionalShortFormProvider that maps between the entities that are referenced in the specified ontologies and the shortforms of these entities.
BidirectionalShortFormProviderAdapter(Set<OWLOntology> ontologies, ShortFormProvider shortFormProvider) Creates a BidirectionalShortFormProvider that maps between the entities that are referenced in the specified ontologies and the shortforms of these entities.
BidirectionalShortFormProviderAdapter(ShortFormProvider shortFormProvider)

Method Summary

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

Methods inherited from class org.semanticweb.owlapi.util.CachingBidirectionalShortFormProvider

add, getEntities, getEntity, getShortForm, getShortForms, rebuild, remove, update

Methods inherited from class java.lang.Object

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

Constructor Detail

BidirectionalShortFormProviderAdapter

public BidirectionalShortFormProviderAdapter(ShortFormProvider shortFormProvider)

Parameters:

shortFormProvider - the short form provider to use

BidirectionalShortFormProviderAdapter

public BidirectionalShortFormProviderAdapter(Set<OWLOntology> ontologies,
                                             ShortFormProvider shortFormProvider)

Creates a BidirectionalShortFormProvider that maps between the entities that are referenced in the specified ontologies and the shortforms of these entities.

Parameters:

ontologies - The ontologies that contain references to the entities to be mapped.

shortFormProvider - The short form provider that should be used to generate the short forms of the referenced entities.

BidirectionalShortFormProviderAdapter

public BidirectionalShortFormProviderAdapter(OWLOntologyManager man,
                                             Set<OWLOntology> ontologies,
                                             ShortFormProvider shortFormProvider)

Creates a BidirectionalShortFormProvider that maps between the entities that are referenced in the specified ontologies and the shortforms of these entities. Note that the dispose method must be called when the provider has been finished with so that the provider may remove itself as a listener from the manager.

Parameters:

ontologies - The ontologies that contain references to the entities to be mapped.

shortFormProvider - The short form provider that should be used to generate the short forms of the referenced entities.

man - This short form provider will track changes to ontologies. The provider will listen for ontology changes and update the cache of entity--shortform mappings based on whether the specified ontologies contain references to entities or not.

Method Detail

generateShortForm

protected String generateShortForm(OWLEntity entity)

Description copied from class: CachingBidirectionalShortFormProvider

Generates the short form for the specified entity. This short form will be cached so that it can be retrieved efficiently and so that the entity can be obtained from the short form. If the short form for the entity changes then the cach must explicilty be updated using the update method.

Specified by:

generateShortForm in class CachingBidirectionalShortFormProvider

Parameters:

entity - The entity whose short form should be generated.

Returns:

short form

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

Overrides:

dispose in class CachingBidirectionalShortFormProvider