org.apache.stanbol.ontologymanager.servicesapi.io

Interface OntologyInputSource<O>

Type Parameters:

O - the root ontology object delivered by this input source.

All Known Subinterfaces:

OntologyInputSource<O>

All Known Implementing Classes:

AbstractGenericInputSource, AbstractOntologyReferenceSource, StoredOntologySource, StoredOntologySource

public interface OntologyInputSource<O>

An ontology input source provides a point for loading an ontology. Currently it provides two ways of obtaining an ontology document:

1. From an OWLOntology.
2. By dereferencing a physical IRI.
3. By querying a triple store.

Consumers that use an ontology input source will attempt to obtain a concrete representation of an ontology in the above order. Implementations of this interface may try to dereference the IRI internally and just provide the OWLOntology, or directly provide the physical IRI for other classes to dereference. Implementations should allow multiple attempts at loading an ontology.

Author:

alexdma

Method Summary

Methods

Modifier and Type	Method and Description
Origin<?>	getOrigin() Returns a reference object that can be used for obtaining the supplied ontology.
O	getRootOntology() Returns the OWL Ontology that imports the whole ontology network addressed by this input source.
boolean	hasOrigin() Determines if a physical reference is known for this ontology source.
boolean	hasRootOntology() Determines if a root ontology that imports the entire network is available.

Method Detail

getOrigin

Origin<?> getOrigin()

Returns a reference object that can be used for obtaining the supplied ontology. Depending on how the ontology was obtained, the origin can be a physical URL, the ID of a database or graph in the local storage, or something else.This method is supposed to return null if the ontology lives in-memory and was not or is not going to be stored publicly.

Returns:

a physical reference for this ontology source, or null if unknown.

getRootOntology

O getRootOntology()

Returns the OWL Ontology that imports the whole ontology network addressed by this input source.

Returns:

the ontology network root.

hasOrigin

boolean hasOrigin()

Determines if a physical reference is known for this ontology source. Note that an anonymous ontology may have been fetched from a physical location, just as a named ontology may have been stored in memory and have no physical location.

Returns:

true if a physical reference is known for this ontology source.

hasRootOntology

boolean hasRootOntology()

Determines if a root ontology that imports the entire network is available.

Returns:

true if a root ontology is available, false otherwise.