org.apache.stanbol.ontologymanager.servicesapi.io

Class AbstractGenericInputSource<O>

java.lang.Object

org.apache.stanbol.ontologymanager.servicesapi.io.AbstractGenericInputSource<O>

Type Parameters:

O - the ontology returned by this input source.

All Implemented Interfaces:

OntologyInputSource<O>

Direct Known Subclasses:

AbstractOntologyReferenceSource

public abstract class AbstractGenericInputSource<O>
extends Object
implements OntologyInputSource<O>

The abstract implementation of the OntologyInputSource interface which is inherited by all concrete implementations.

Author:

alexdma

Field Summary

Fields

Modifier and Type	Field and Description
protected Origin<?>	origin Where the ontology object was retrieved from.
protected O	rootOntology

Constructor Summary

Constructors

Constructor and Description
AbstractGenericInputSource()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	bindPhysicalOrigin(Origin<?> origin) This method is used to remind developers to bind a physical reference to the OntologyInputSource if intending to do so.
protected void	bindRootOntology(O ontology) This method is used to remind developers to bind a root ontology to the OntologyInputSource if intending to do so.
boolean	equals(Object obj)
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.
abstract String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

origin

protected Origin<?> origin

Where the ontology object was retrieved from.

rootOntology

protected O rootOntology

Constructor Detail

AbstractGenericInputSource

public AbstractGenericInputSource()

Method Detail

bindPhysicalOrigin

protected void bindPhysicalOrigin(Origin<?> origin)

This method is used to remind developers to bind a physical reference to the OntologyInputSource if intending to do so. Implementations should assign a value to origin.

Parameters:

origin - where the ontology object was obtained from.

bindRootOntology

protected void bindRootOntology(O ontology)

This method is used to remind developers to bind a root ontology to the OntologyInputSource if intending to do so. Implementation should assign a value to rootOntology.

Parameters:

ontology - the root ontology.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getOrigin

public Origin<?> getOrigin()

Description copied from interface: OntologyInputSource

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.

Specified by:

getOrigin in interface OntologyInputSource<O>

Returns:

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

getRootOntology

public O getRootOntology()

Description copied from interface: OntologyInputSource

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

Specified by:

getRootOntology in interface OntologyInputSource<O>

Returns:

the ontology network root.

hasOrigin

public boolean hasOrigin()

Description copied from interface: OntologyInputSource

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.

Specified by:

hasOrigin in interface OntologyInputSource<O>

Returns:

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

hasRootOntology

public boolean hasRootOntology()

Description copied from interface: OntologyInputSource

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

Specified by:

hasRootOntology in interface OntologyInputSource<O>

Returns:

true if a root ontology is available, false otherwise.

toString

public abstract String toString()

Overrides:

toString in class Object