ShEx.ex v0.1.1 ShEx.ShapeMap.Association View Source

A ShapeMap association specifies the shape a node must conform to and contains the results of a validation.

It is a structure consisting of the following fields:

  • node: an RDF node, or a triple pattern which is used to select RDF nodes
  • shape: label of a shape expression or the atom :start for the start shape expression

The following fields are just filled in the case of a result ShapeMap, i.e. after the validation:

  • status: :conformant if node conforms the shape, otherwise :nonconformant
  • reason: a list of ShEx.Violation structs stating the reasons for failure or success
  • app_info: currently not used

ShapeMap associations should not be created manually, but will be created implicitly on ShEx.ShapeMap.new/1 or ShEx.ShapeMap.add/2.

Link to this section Summary

Functions

Return true if association is a fixed ShapeMap association, i.e. doesn't have triple pattern as node or contains results.

Return true if association is a query ShapeMap association, i.e. does not contain results.

Return true if association is a result ShapeMap association, i.e. contains results.

Link to this section Types

Link to this type

status()

View Source
status() :: :conformant | :nonconformant | nil

Link to this section Functions

Return true if association is a fixed ShapeMap association, i.e. doesn't have triple pattern as node or contains results.

Return true if association is a query ShapeMap association, i.e. does not contain results.

Note: Every fixed ShapeMap association is also a query ShapeMap association.

Return true if association is a result ShapeMap association, i.e. contains results.