Module org.apache.jena.ontapi
Package org.apache.jena.ontapi.model

Interface OntDataRange.Restriction

All Superinterfaces:
org.apache.jena.graph.FrontsNode, OntDataRange, OntDataRange.Combination<OntFacetRestriction>, OntObject, org.apache.jena.rdf.model.RDFNode, org.apache.jena.rdf.model.Resource
All Known Implementing Classes:
OntDataRangeImpl.RestrictionImpl
Enclosing interface:
OntDataRange
public static interface OntDataRange.Restriction extends OntDataRange.Combination<OntFacetRestriction>
See Also:

  • Method Details

    • spec

      Stream<OntStatement> spec()
      Lists all characteristic statements of the ontology resource, i.e., all those statements which completely determine this object nature according to the OWL2 specification. For non-composite objects the result might contain only the root statement. For composite objects (usually anonymous resources: disjoint sections, class expression, etc.) the result would contain all statements in the graph directly related to the object but without statements that relate to the object components. The return stream is ordered and, in most cases, the expression this.spec().findFirst().get() returns the same statement as this.getRoot(). Object annotations are not included in the resultant stream.

      For OWL Entities the returned stream will contain only a single main statement (i.e. OntObject.getMainStatement()), or even will be empty for built-in entities and individuals. The result stream for Restriction Data Range also includes facet restrinction definition triples.

      Specified by:
      spec in interface OntObject
      Returns:
      Stream of OntStatements.
      See Also:

    • addFacet

      default OntDataRange.Restriction addFacet(Class<? extends OntFacetRestriction> type, org.apache.jena.rdf.model.Literal literal)
      Adds a facet restriction to the end of the []-list.
      Parameters:
      type - subclass of OntFacetRestriction, not null
      literal - value, not null
      Returns:
      this instance to allow cascading calls

    • getModel

      OntModel getModel()
      Returns the ontology model associated with this resource. If the Resource was not created by a Model, the result may be null.
      Specified by:
      getModel in interface org.apache.jena.rdf.model.RDFNode
      Returns:
      OntModel

    • isLocal

      boolean isLocal()
      Determines if this Ontology Resource is locally defined. This means that the resource definition (i.e., a the root statement) belongs to the base ontology graph. If the ontology contains subgraphs (which should match owl:imports in OWL) and the resource is defined in one of them, than this method called from top-level interface will return false.
      Returns:
      true if this resource is local to the base model graph.

    • getAs

      default <X extends org.apache.jena.rdf.model.RDFNode> X getAs(Class<X> type)
      Safely converts this RDF resource to the given type interface, if it is possible. Otherwise, returns null. A calling of this method is effectively equivalent to the expression this.canAs(type) ? this.as(type) : null.
      Type Parameters:
      X - any subtype of RDFNode
      Parameters:
      type - a Class-type of the desired RDF view (interface)
      Returns:
      an instance of the type X or null
      See Also:
      • RDFNode.as(Class)
      • RDFNode.canAs(Class)

    • setComponents

      default OntDataRange.Restriction setComponents(OntFacetRestriction... values)
      Replaces the existing []-list content with the specified one, that is given in the form of vararg array.
      Parameters:
      values - an Array of the type V
      Returns:
      this instance to allow cascading calls

    • setComponents

      default OntDataRange.Restriction setComponents(Collection<OntFacetRestriction> components)
      Replaces the existing []-list content with the specified one, that is given in the form of Collection. Nulls and self-references are not allowed.
      Parameters:
      components - a Collection of the type V
      Returns:
      this instance to allow cascading calls
      Throws:
      OntJenaException - in case of wrong input

    • getList

      OntList<OntFacetRestriction> getList()
      Gets a modifiable []-list with items of the type E.
      Returns:
      Ontology []-list with items of the type E

    • setValue

      OntDataRange.Restriction setValue(OntDataRange.Named value)
      Sets the specified value (a filler in OWL-API terms) into this class or data range expression.

      A value can be null if this is a Cardinality Restriction (the null-filler is considered as owl:Thing for an object restriction and as RDFS.Literal for a data restriction).

      Parameters:
      value - V, possible null in case of Cardinality Restriction
      Returns:
      this instance to allow cascading calls
      See Also:
      • HasValue.getValue()

    • getValue

      OntDataRange.Named getValue()
      Gets an RDF-value (a filler in OWL-API terms) encapsulated by this expression (that can be either class or data range expression).

      The result is not null even if it is an Unqualified Cardinality Restriction, that has no explicit filler in RDF (the filler is expected to be either owl:Thing for object restriction or RDFS.Literal for data restriction).

      Returns:
      V, not null
      See Also:
      • SetValue.setValue(RDFNode)