org.semanticweb.owlapi.util

Interface BidirectionalShortFormProvider

All Superinterfaces:

ShortFormProvider

All Known Implementing Classes:

BidirectionalShortFormProviderAdapter, CachingBidirectionalShortFormProvider

public interface BidirectionalShortFormProvider
extends ShortFormProvider

A short form provider which is capable of translating back and forth between entities and their short forms.

Since:

2.0.0

Author:

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

Method Summary

Modifier and Type	Method and Description
Stream<OWLEntity>	entities(String shortForm) For a given short form this method obtains the entities which have this short form.
default Set<OWLEntity>	getEntities(String shortForm) For a given short form this method obtains the entities which have this short form.
OWLEntity	getEntity(String shortForm) A convenience method which gets an entity from its short form.
default Set<String>	getShortForms() Gets all of the short forms that are mapped to entities.
Stream<String>	shortForms() Gets all of the short forms that are mapped to entities.

Methods inherited from interface org.semanticweb.owlapi.util.ShortFormProvider

dispose, getShortForm

Method Detail

getEntities

default Set<OWLEntity> getEntities(String shortForm)

For a given short form this method obtains the entities which have this short form.

Parameters:

shortForm - The short form of the entities that will be retrieved.

Returns:

The set of entities that have the specified short form. The set that is returned is a copy; modifications to the returned set will not be reflected in this object.

entities

Stream<OWLEntity> entities(String shortForm)

For a given short form this method obtains the entities which have this short form.

Parameters:

shortForm - The short form of the entities that will be retrieved.

Returns:

stream of entities that have the specified short form.

getEntity

@Nullable
OWLEntity getEntity(String shortForm)

A convenience method which gets an entity from its short form.

Parameters:

shortForm - The short form of the entity.

Returns:

The actual entity or null if there is no entity which has the specified short form. If the specified short form corresponds to more than one entity then an entity will be chosen by the implementation of the short form provider.

getShortForms

default Set<String> getShortForms()

Gets all of the short forms that are mapped to entities.

Returns:

A set which contains the strings representing the short forms of entities for which there is a mapping. The set that is returned is a copy; modifications to the returned set will not be reflected in this object.

shortForms

Stream<String> shortForms()

Gets all of the short forms that are mapped to entities.

Returns:

stream of the strings representing the short forms of entities for which there is a mapping.