org.apache.stanbol.ontologymanager.servicesapi.ontology

Interface OWLExportable

All Known Subinterfaces:

CoreOntologySpace, CustomOntologySpace, OntologyScope, OntologySpace, OntologySpace, OWLExportable, Scope, Session, Session

public interface OWLExportable

An object that can be represented as an ontology instance.

Author:

alexdma

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OWLExportable.ConnectivityPolicy The policy that determines how an OWL exportable objects should represent other referenced objects.

Method Summary

Methods

Modifier and Type	Method and Description
<O> O	export(Class<O> returnType, boolean merge) Returns an ontological form of this object of the specified return type, if supported.
<O> O	export(Class<O> returnType, boolean merge, org.semanticweb.owlapi.model.IRI universalPrefix) Returns an ontological form of this object of the specified return type, if supported.
OWLExportable.ConnectivityPolicy	getConnectivityPolicy() Returns the connectivity policy adopted by this object when exported to an OWL artifact.
void	setConnectivityPolicy(OWLExportable.ConnectivityPolicy policy) Sets the connectivity policy that will be adopted by this object when it is exported to an OWL artifact.

Method Detail

export

<O> O export(Class<O> returnType,
           boolean merge)

Returns an ontological form of this object of the specified return type, if supported. If the supplied class is not a supported return type, an UnsupportedOperationException is thrown.

TODO replace merge parameter with integer for merge level (-1 for infinite).

Parameters:

returnType - the desired class of the returned object.

merge - if true, all imported ontologies will be merged and no import statements will appear.

Returns:

the ontology that represents this object.

export

<O> O export(Class<O> returnType,
           boolean merge,
           org.semanticweb.owlapi.model.IRI universalPrefix)

Returns an ontological form of this object of the specified return type, if supported. If the supplied class is not a supported return type, an UnsupportedOperationException is thrown.

TODO replace merge parameter with integer for merge level (-1 for infinite).

Parameters:

returnType - the desired class of the returned object.

merge - if true, all imported ontologies will be merged and no import statements will appear.

Returns:

the ontology that represents this object.

getConnectivityPolicy

OWLExportable.ConnectivityPolicy getConnectivityPolicy()

Returns the connectivity policy adopted by this object when exported to an OWL artifact.

Returns:

the connectivity policy.

setConnectivityPolicy

void setConnectivityPolicy(OWLExportable.ConnectivityPolicy policy)

Sets the connectivity policy that will be adopted by this object when it is exported to an OWL artifact.

Parameters:

policy - the new connectivity policy.