Module org.apache.jena.core
Package org.apache.jena.ontology

Interface Ontology

All Superinterfaces:
FrontsNode, OntResource, RDFNode, Resource
All Known Implementing Classes:
OntologyImpl
public interface Ontology extends OntResource

Interface encapsulating the distinguished instance in a given ontology document that presents meta-data and other processing data about the document (including which other documents are imported by a document).

  • Method Details

    • setImport

      void setImport(Resource res)

      Assert that this ontology imports only the given ontology. Any existing statements for sameAs will be removed.

      Parameters:
      res - Represents a resource that this ontology imports.
      Throws:
      ProfileException - If the Profile.IMPORTS() property is not supported in the current language profile.

    • addImport

      void addImport(Resource res)

      Add a resource representing an ontology that this ontology (strictly, the ontology represented by this node) imports.

      Parameters:
      res - Represents a resource that this ontology imports.
      Throws:
      ProfileException - If the Profile.IMPORTS() property is not supported in the current language profile.

    • getImport

      OntResource getImport()

      Answer a resource that represents an ontology imported by this ontology. If there is more than one such resource, an arbitrary selection is made.

      Returns:
      An OntResource representing a resource that this ontology imports
      Throws:
      ProfileException - If the Profile.IMPORTS() property is not supported in the current language profile.

    • listImports

      ExtendedIterator<OntResource> listImports()

      Answer an iterator over all of the resources representing ontologies imported by this ontology.

      Returns:
      An iterator over the ontology import resources
      Throws:
      ProfileException - If the Profile.IMPORTS() property is not supported in the current language profile.

    • imports

      boolean imports(Resource res)

      Answer true if this ontology (the ontology represented by this resource) imports the given resource.

      Parameters:
      res - A resource to test against
      Returns:
      True if this ontology imports the ontology represented by res

    • removeImport

      void removeImport(Resource res)

      Remove the statement that this ontology imports the ontology represented by the given resource. If this statement is not true of the current model, nothing happens.

      Parameters:
      res - A resource that represents an ontology that is no longer to be imported

    • setBackwardCompatibleWith

      void setBackwardCompatibleWith(Resource res)

      Assert that this ontology is backward compatible with the given ontology. Any existing statements for sameAs will be removed.

      Parameters:
      res - Represents a resource that this ontology is compatible with.
      Throws:
      ProfileException - If the Profile.BACKWARD_COMPATIBLE_WITH() property is not supported in the current language profile.

    • addBackwardCompatibleWith

      void addBackwardCompatibleWith(Resource res)

      Add a resource representing an ontology that this ontology (strictly, the ontology represented by this node) is backwards compatible with.

      Parameters:
      res - Represents a resource that this ontology is compatible with.
      Throws:
      ProfileException - If the Profile.BACKWARD_COMPATIBLE_WITH() property is not supported in the current language profile.

    • getBackwardCompatibleWith

      OntResource getBackwardCompatibleWith()

      Answer a resource that represents an ontology that is backwards compatible with this ontology. If there is more than one such resource, an arbitrary selection is made.

      Returns:
      An OntResource representing an ontology that this ontology is compatible with
      Throws:
      ProfileException - If the Profile.BACKWARD_COMPATIBLE_WITH() property is not supported in the current language profile.

    • listBackwardCompatibleWith

      ExtendedIterator<OntResource> listBackwardCompatibleWith()

      Answer an iterator over all of the resources representing ontologies that this ontology is backwards compatible with.

      Returns:
      An iterator over the ontology resources compatible with this ontology
      Throws:
      ProfileException - If the Profile.BACKWARD_COMPATIBLE_WITH() property is not supported in the current language profile.

    • isBackwardCompatibleWith

      boolean isBackwardCompatibleWith(Resource res)

      Answer true if this ontology (the ontology represented by this resource) is backward compatible with the given resource.

      Parameters:
      res - A resource to test against
      Returns:
      True if this ontology is compatible with the ontology represented by res

    • removeBackwardCompatibleWith

      void removeBackwardCompatibleWith(Resource res)

      Remove the statement that this ontology is backwards compatible with the ontology represented by the given resource. If this statement is not true of the current model, nothing happens.

      Parameters:
      res - A resource that represents an ontology that is no longer to be imported

    • setPriorVersion

      void setPriorVersion(Resource res)

      Assert that this ontology is a new version of the given ontology. Any existing statements for priorVersion will be removed.

      Parameters:
      res - Represents a resource that this ontology supercedes.
      Throws:
      ProfileException - If the Profile.PRIOR_VERSION() property is not supported in the current language profile.

    • addPriorVersion

      void addPriorVersion(Resource res)

      Add a resource representing an ontology that this ontology (strictly, the ontology represented by this node) supercedes.

      Parameters:
      res - Represents a resource that this ontology supercedes.
      Throws:
      ProfileException - If the Profile.PRIOR_VERSION() property is not supported in the current language profile.

    • getPriorVersion

      OntResource getPriorVersion()

      Answer a resource that represents an ontology that is superceded by this ontology. If there is more than one such resource, an arbitrary selection is made.

      Returns:
      An OntResource representing an ontology that this ontology supercedes
      Throws:
      ProfileException - If the Profile.PRIOR_VERSION() property is not supported in the current language profile.

    • listPriorVersion

      ExtendedIterator<OntResource> listPriorVersion()

      Answer an iterator over all of the resources representing ontologies that this ontology supercedes.

      Returns:
      An iterator over the ontology resources superceded by this ontology
      Throws:
      ProfileException - If the Profile.PRIOR_VERSION() property is not supported in the current language profile.

    • hasPriorVersion

      boolean hasPriorVersion(Resource res)

      Answer true if this ontology (the ontology represented by this resource) supercedes the given resource.

      Parameters:
      res - A resource to test against
      Returns:
      True if this ontology supercedes the ontology represented by res

    • removePriorVersion

      void removePriorVersion(Resource res)

      Remove the statement that the given ontology is a prior version of this ontology. If this statement is not true of the current model, nothing happens.

      Parameters:
      res - A resource that represents an ontology that is no longer a prior version of this ontology

    • setIncompatibleWith

      void setIncompatibleWith(Resource res)

      Assert that this ontology is incompatible with the given ontology. Any existing statements for incompatibleWith will be removed.

      Parameters:
      res - Represents a resource that this ontology is incompatible with.
      Throws:
      ProfileException - If the Profile.INCOMPATIBLE_WITH() property is not supported in the current language profile.

    • addIncompatibleWith

      void addIncompatibleWith(Resource res)

      Add a resource representing an ontology that this ontology (strictly, the ontology represented by this node) is incompatible with.

      Parameters:
      res - Represents a resource that this ontology is incompatible with.
      Throws:
      ProfileException - If the Profile.INCOMPATIBLE_WITH() property is not supported in the current language profile.

    • getIncompatibleWith

      OntResource getIncompatibleWith()

      Answer a resource that represents an ontology that is incompatible with this ontology. If there is more than one such resource, an arbitrary selection is made.

      Returns:
      An OntResource representing an ontology that this ontology is incompatible with
      Throws:
      ProfileException - If the Profile.INCOMPATIBLE_WITH() property is not supported in the current language profile.

    • listIncompatibleWith

      ExtendedIterator<OntResource> listIncompatibleWith()

      Answer an iterator over all of the resources representing ontologies that this ontology is incompatible with.

      Returns:
      An iterator over the ontology resources that this ontology is incompatible with
      Throws:
      ProfileException - If the Profile.INCOMPATIBLE_WITH() property is not supported in the current language profile.

    • isIncompatibleWith

      boolean isIncompatibleWith(Resource res)

      Answer true if this ontology (the ontology represented by this resource) is incompatible with the given resource.

      Parameters:
      res - A resource to test against
      Returns:
      True if this ontology is incompatible with the ontology represented by res

    • removeIncompatibleWith

      void removeIncompatibleWith(Resource res)

      Remove the statement that the given ontology is incompatible with this ontology. If this statement is not true of the current model, nothing happens.

      Parameters:
      res - A resource that represents an ontology that is no longer incompatible with this ontology