Model.hs

-- Note: this is an automatically generated file. Do not edit.

-- | A SHACL syntax model. See https://www.w3.org/TR/shacl

module Hydra.Shacl.Model where

import qualified Hydra.Core as Core
import qualified Hydra.Rdf.Syntax as Syntax
import Prelude hiding  (Enum, Ordering, decodeFloat, encodeFloat, fail, map, pure, sum)
import qualified Data.Scientific as Sci
import qualified Data.Set as S

-- | See https://www.w3.org/TR/shacl/#ClosedPatterConstraintComponent
data Closed =
  Closed {
    closedIsClosed :: Bool,
    closedIgnoredProperties :: (Maybe (S.Set Syntax.Property))}
  deriving (Eq, Ord, Read, Show)

_Closed = Core.Name "hydra.shacl.model.Closed"

_Closed_isClosed = Core.Name "isClosed"

_Closed_ignoredProperties = Core.Name "ignoredProperties"

-- | Any of a number of constraint parameters which can be applied either to node or property shapes
data CommonConstraint =
  -- | See https://www.w3.org/TR/shacl/#AndConstraintComponent
  CommonConstraintAnd (S.Set (Reference Shape)) |
  -- | See https://www.w3.org/TR/shacl/#ClosedConstraintComponent
  CommonConstraintClosed Closed |
  -- | See https://www.w3.org/TR/shacl/#ClassConstraintComponent
  CommonConstraintClass (S.Set Syntax.RdfsClass) |
  -- | See https://www.w3.org/TR/shacl/#DatatypeConstraintComponent
  CommonConstraintDatatype Syntax.Iri |
  -- | See https://www.w3.org/TR/shacl/#DisjointConstraintComponent
  CommonConstraintDisjoint (S.Set Syntax.Property) |
  -- | See https://www.w3.org/TR/shacl/#EqualsConstraintComponent
  CommonConstraintEquals (S.Set Syntax.Property) |
  -- | Specifies the condition that at least one value node is equal to the given RDF term. See https://www.w3.org/TR/shacl/#HasValueConstraintComponent
  CommonConstraintHasValue (S.Set Syntax.Node) |
  -- | Specifies the condition that each value node is a member of a provided SHACL list. See https://www.w3.org/TR/shacl/#InConstraintComponent
  CommonConstraintIn [Syntax.Node] |
  -- | See https://www.w3.org/TR/shacl/#LanguageInConstraintComponent
  CommonConstraintLanguageIn (S.Set Syntax.LanguageTag) |
  -- | See https://www.w3.org/TR/shacl/#NodeKindConstraintComponent
  CommonConstraintNodeKind NodeKind |
  -- | See https://www.w3.org/TR/shacl/#NodeConstraintComponent
  CommonConstraintNode (S.Set (Reference NodeShape)) |
  -- | See https://www.w3.org/TR/shacl/#NotConstraintComponent
  CommonConstraintNot (S.Set (Reference Shape)) |
  -- | See https://www.w3.org/TR/shacl/#MaxExclusiveConstraintComponent
  CommonConstraintMaxExclusive Syntax.Literal |
  -- | See https://www.w3.org/TR/shacl/#MaxInclusiveConstraintComponent
  CommonConstraintMaxInclusive Syntax.Literal |
  -- | See https://www.w3.org/TR/shacl/#MaxLengthConstraintComponent
  CommonConstraintMaxLength Integer |
  -- | See https://www.w3.org/TR/shacl/#MinExclusiveConstraintComponent
  CommonConstraintMinExclusive Syntax.Literal |
  -- | See https://www.w3.org/TR/shacl/#MinInclusiveConstraintComponent
  CommonConstraintMinInclusive Syntax.Literal |
  -- | See https://www.w3.org/TR/shacl/#MinLengthConstraintComponent
  CommonConstraintMinLength Integer |
  -- | See https://www.w3.org/TR/shacl/#PatternConstraintComponent
  CommonConstraintPattern Pattern |
  -- | See https://www.w3.org/TR/shacl/#PropertyConstraintComponent
  CommonConstraintProperty (S.Set (Reference PropertyShape)) |
  -- | See https://www.w3.org/TR/shacl/#OrConstraintComponent
  CommonConstraintOr (S.Set (Reference Shape)) |
  -- | See https://www.w3.org/TR/shacl/#XoneConstraintComponent
  CommonConstraintXone (S.Set (Reference Shape))
  deriving (Eq, Ord, Read, Show)

_CommonConstraint = Core.Name "hydra.shacl.model.CommonConstraint"

_CommonConstraint_and = Core.Name "and"

_CommonConstraint_closed = Core.Name "closed"

_CommonConstraint_class = Core.Name "class"

_CommonConstraint_datatype = Core.Name "datatype"

_CommonConstraint_disjoint = Core.Name "disjoint"

_CommonConstraint_equals = Core.Name "equals"

_CommonConstraint_hasValue = Core.Name "hasValue"

_CommonConstraint_in = Core.Name "in"

_CommonConstraint_languageIn = Core.Name "languageIn"

_CommonConstraint_nodeKind = Core.Name "nodeKind"

_CommonConstraint_node = Core.Name "node"

_CommonConstraint_not = Core.Name "not"

_CommonConstraint_maxExclusive = Core.Name "maxExclusive"

_CommonConstraint_maxInclusive = Core.Name "maxInclusive"

_CommonConstraint_maxLength = Core.Name "maxLength"

_CommonConstraint_minExclusive = Core.Name "minExclusive"

_CommonConstraint_minInclusive = Core.Name "minInclusive"

_CommonConstraint_minLength = Core.Name "minLength"

_CommonConstraint_pattern = Core.Name "pattern"

_CommonConstraint_property = Core.Name "property"

_CommonConstraint_or = Core.Name "or"

_CommonConstraint_xone = Core.Name "xone"

-- | Common constraint parameters and other properties for SHACL shapes
data CommonProperties =
  CommonProperties {
    -- | Common constraint parameters attached to this shape
    commonPropertiesConstraints :: (S.Set CommonConstraint),
    -- | See https://www.w3.org/TR/shacl/#deactivated
    commonPropertiesDeactivated :: (Maybe Bool),
    -- | See https://www.w3.org/TR/shacl/#message
    commonPropertiesMessage :: Syntax.LangStrings,
    -- | See https://www.w3.org/TR/shacl/#severity
    commonPropertiesSeverity :: Severity,
    -- | See https://www.w3.org/TR/shacl/#targetClass
    commonPropertiesTargetClass :: (S.Set Syntax.RdfsClass),
    -- | See https://www.w3.org/TR/shacl/#targetNode
    commonPropertiesTargetNode :: (S.Set Syntax.IriOrLiteral),
    -- | See https://www.w3.org/TR/shacl/#targetObjectsOf
    commonPropertiesTargetObjectsOf :: (S.Set Syntax.Property),
    -- | See https://www.w3.org/TR/shacl/#targetSubjectsOf
    commonPropertiesTargetSubjectsOf :: (S.Set Syntax.Property)}
  deriving (Eq, Ord, Read, Show)

_CommonProperties = Core.Name "hydra.shacl.model.CommonProperties"

_CommonProperties_constraints = Core.Name "constraints"

_CommonProperties_deactivated = Core.Name "deactivated"

_CommonProperties_message = Core.Name "message"

_CommonProperties_severity = Core.Name "severity"

_CommonProperties_targetClass = Core.Name "targetClass"

_CommonProperties_targetNode = Core.Name "targetNode"

_CommonProperties_targetObjectsOf = Core.Name "targetObjectsOf"

_CommonProperties_targetSubjectsOf = Core.Name "targetSubjectsOf"

-- | An instance of a type like sh:Shape or sh:NodeShape, together with a unique IRI for that instance
data Definition a =
  Definition {
    definitionIri :: Syntax.Iri,
    definitionTarget :: a}
  deriving (Eq, Ord, Read, Show)

_Definition = Core.Name "hydra.shacl.model.Definition"

_Definition_iri = Core.Name "iri"

_Definition_target = Core.Name "target"

data NodeKind =
  -- | A blank node
  NodeKindBlankNode  |
  -- | An IRI
  NodeKindIri  |
  -- | A literal
  NodeKindLiteral  |
  -- | A blank node or an IRI
  NodeKindBlankNodeOrIri  |
  -- | A blank node or a literal
  NodeKindBlankNodeOrLiteral  |
  -- | An IRI or a literal
  NodeKindIriOrLiteral
  deriving (Eq, Ord, Read, Show)

_NodeKind = Core.Name "hydra.shacl.model.NodeKind"

_NodeKind_blankNode = Core.Name "blankNode"

_NodeKind_iri = Core.Name "iri"

_NodeKind_literal = Core.Name "literal"

_NodeKind_blankNodeOrIri = Core.Name "blankNodeOrIri"

_NodeKind_blankNodeOrLiteral = Core.Name "blankNodeOrLiteral"

_NodeKind_iriOrLiteral = Core.Name "iriOrLiteral"

-- | A SHACL node shape. See https://www.w3.org/TR/shacl/#node-shapes
data NodeShape =
  NodeShape {
    nodeShapeCommon :: CommonProperties}
  deriving (Eq, Ord, Read, Show)

_NodeShape = Core.Name "hydra.shacl.model.NodeShape"

_NodeShape_common = Core.Name "common"

-- | A SHACL pattern. See https://www.w3.org/TR/shacl/#PatternConstraintComponent
data Pattern =
  Pattern {
    patternRegex :: String,
    patternFlags :: (Maybe String)}
  deriving (Eq, Ord, Read, Show)

_Pattern = Core.Name "hydra.shacl.model.Pattern"

_Pattern_regex = Core.Name "regex"

_Pattern_flags = Core.Name "flags"

-- | A SHACL property shape. See https://www.w3.org/TR/shacl/#property-shapes
data PropertyShape =
  PropertyShape {
    propertyShapeCommon :: CommonProperties,
    -- | Any property shape -specific constraint parameters
    propertyShapeConstraints :: (S.Set PropertyShapeConstraint),
    -- | See https://www.w3.org/TR/shacl/#defaultValue
    propertyShapeDefaultValue :: (Maybe Syntax.Node),
    -- | See https://www.w3.org/TR/shacl/#name
    propertyShapeDescription :: Syntax.LangStrings,
    -- | See https://www.w3.org/TR/shacl/#name
    propertyShapeName :: Syntax.LangStrings,
    -- | See https://www.w3.org/TR/shacl/#order
    propertyShapeOrder :: (Maybe Integer),
    propertyShapePath :: Syntax.Iri}
  deriving (Eq, Ord, Read, Show)

_PropertyShape = Core.Name "hydra.shacl.model.PropertyShape"

_PropertyShape_common = Core.Name "common"

_PropertyShape_constraints = Core.Name "constraints"

_PropertyShape_defaultValue = Core.Name "defaultValue"

_PropertyShape_description = Core.Name "description"

_PropertyShape_name = Core.Name "name"

_PropertyShape_order = Core.Name "order"

_PropertyShape_path = Core.Name "path"

-- | A number of constraint parameters which are specific to property shapes, and cannot be applied to node shapes
data PropertyShapeConstraint =
  -- | See https://www.w3.org/TR/shacl/#LessThanConstraintComponent
  PropertyShapeConstraintLessThan (S.Set Syntax.Property) |
  -- | See https://www.w3.org/TR/shacl/#LessThanOrEqualsConstraintComponent
  PropertyShapeConstraintLessThanOrEquals (S.Set Syntax.Property) |
  -- | The maximum cardinality. Node shapes cannot have any value for sh:maxCount. See https://www.w3.org/TR/shacl/#MaxCountConstraintComponent
  PropertyShapeConstraintMaxCount Integer |
  -- | The minimum cardinality. Node shapes cannot have any value for sh:minCount. See https://www.w3.org/TR/shacl/#MinCountConstraintComponent
  PropertyShapeConstraintMinCount Integer |
  -- | See https://www.w3.org/TR/shacl/#UniqueLangConstraintComponent
  PropertyShapeConstraintUniqueLang Bool |
  -- | See https://www.w3.org/TR/shacl/#QualifiedValueShapeConstraintComponent
  PropertyShapeConstraintQualifiedValueShape QualifiedValueShape
  deriving (Eq, Ord, Read, Show)

_PropertyShapeConstraint = Core.Name "hydra.shacl.model.PropertyShapeConstraint"

_PropertyShapeConstraint_lessThan = Core.Name "lessThan"

_PropertyShapeConstraint_lessThanOrEquals = Core.Name "lessThanOrEquals"

_PropertyShapeConstraint_maxCount = Core.Name "maxCount"

_PropertyShapeConstraint_minCount = Core.Name "minCount"

_PropertyShapeConstraint_uniqueLang = Core.Name "uniqueLang"

_PropertyShapeConstraint_qualifiedValueShape = Core.Name "qualifiedValueShape"

-- | See https://www.w3.org/TR/shacl/#QualifiedValueShapeConstraintComponent
data QualifiedValueShape =
  QualifiedValueShape {
    qualifiedValueShapeQualifiedValueShape :: (Reference Shape),
    qualifiedValueShapeQualifiedMaxCount :: Integer,
    qualifiedValueShapeQualifiedMinCount :: Integer,
    qualifiedValueShapeQualifiedValueShapesDisjoint :: (Maybe Bool)}
  deriving (Eq, Ord, Read, Show)

_QualifiedValueShape = Core.Name "hydra.shacl.model.QualifiedValueShape"

_QualifiedValueShape_qualifiedValueShape = Core.Name "qualifiedValueShape"

_QualifiedValueShape_qualifiedMaxCount = Core.Name "qualifiedMaxCount"

_QualifiedValueShape_qualifiedMinCount = Core.Name "qualifiedMinCount"

_QualifiedValueShape_qualifiedValueShapesDisjoint = Core.Name "qualifiedValueShapesDisjoint"

-- | Either an instance of a type like sh:Shape or sh:NodeShape, or an IRI which refers to an instance of that type
data Reference a =
  ReferenceNamed Syntax.Iri |
  -- | An anonymous instance
  ReferenceAnonymous a |
  -- | An inline definition
  ReferenceDefinition (Definition a)
  deriving (Eq, Ord, Read, Show)

_Reference = Core.Name "hydra.shacl.model.Reference"

_Reference_named = Core.Name "named"

_Reference_anonymous = Core.Name "anonymous"

_Reference_definition = Core.Name "definition"

data Severity =
  -- | A non-critical constraint violation indicating an informative message
  SeverityInfo  |
  -- | A non-critical constraint violation indicating a warning
  SeverityWarning  |
  -- | A constraint violation
  SeverityViolation
  deriving (Eq, Ord, Read, Show)

_Severity = Core.Name "hydra.shacl.model.Severity"

_Severity_info = Core.Name "info"

_Severity_warning = Core.Name "warning"

_Severity_violation = Core.Name "violation"

-- | A SHACL node or property shape. See https://www.w3.org/TR/shacl/#shapes
data Shape =
  ShapeNode NodeShape |
  ShapeProperty PropertyShape
  deriving (Eq, Ord, Read, Show)

_Shape = Core.Name "hydra.shacl.model.Shape"

_Shape_node = Core.Name "node"

_Shape_property = Core.Name "property"

-- | An RDF graph containing zero or more shapes that is passed into a SHACL validation process so that a data graph can be validated against the shapes
newtype ShapesGraph =
  ShapesGraph {
    unShapesGraph :: (S.Set (Definition Shape))}
  deriving (Eq, Ord, Read, Show)

_ShapesGraph = Core.Name "hydra.shacl.model.ShapesGraph"