Constraints

Each constraint is described by its semantic definition, xml representation and example usage.
Constraints are assigned to pre-defined validation gates Basic, Basic Plus, Standard, Extended and Strict to support different levels of validation strictness.
The REST API allows a validation to define constraints outside of the pre-set gates.

Constraint Name	Basic	Basic Plus	Standard	Extended	Strict
Mandatory Node
Mandatory Node if Parent Present
Code Value of Controlled Vocabulary
Descriptive Term of Controlled Vocabulary
Recommended Node
Fixed Value Node
Optional Node
Maximum Node Occurrence
Node in Profile
Compilable XPath
Predicate-less XPath

Mandatory Node

Definition 1

An XML node (element or attribute) described by a predicate-less XPath expression is mandatory to be used within the metadata document.
This constraint includes Not Blank Node constraint.
The metadata document is valid, only if the element is present at least once and the node is not blank, otherwise invalid.

Representation 1

DDI Profile

 <pr:Used xpath="/codeBook/docDscr/citation/titlStmt/titl" isRequired="true"/>

Example 1

Valid, because titl element is present and not blank

 <docDscr>
 <citation>
 <titlStmt>
 <titl>DDI2.5 XML CODEBOOK RECORD FOR STUDY NUMBER 2000</titl>
 </titlStmt>
 </citation>
 </docDscr>

Invalid, because titl element is not present

 <docDscr>
 <citation>
 <titlStmt>
 </titlStmt>
 </citation>
 </docDscr>

Invalid, because titl element is blank

 <docDscr>
 <citation>
 <titlStmt>
 <titl></titl>
 <!--or <titl> </titl> -->
 </titlStmt>
 </citation>
 </docDscr>

Recommended Node

Definition 2

An XML node (element or attribute) described by a predicate-less XPath expression is recommended to be used within the metadata document.
This constraint includes Not Blank Node constraint.
The metadata document is valid, only if the element is present at least once and the node is not blank, otherwise invalid.

Representation 2

DDI Profile

 <pr:Used xpath="/codeBook/stdyDscr/citation/rspStmt/AuthEnty" isRequired="false">
 <pr:Instructions>
 <r:Content>
 <![CDATA[<Constraints><RecommendedNodeConstraint/></Constraints>]]>
 </r:Content>
 </pr:Instructions>
 </pr:Used>

Example 2

Valid, because AuthEnty element is present and not blank

 <stdyDscr>
 <citation>
 <rspStmt>
 <AuthEnty>Lummis, T., University of Essex. Department of Sociology</AuthEnty>
 </rspStmt>
 </citation>
 </stdyDscr>

Invalid, because AuthEnty element is not present

 <stdyDscr>
 <citation>
 <rspStmt/>
 </citation>
 </stdyDscr>

Invalid, because AuthEnty element is blank

 <stdyDscr>
 <citation>
 <rspStmt>
 <AuthEnty></AuthEnty>
 <!--or <AuthEnty> </AuthEnty> -->
 </rspStmt>
 </citation>
 </stdyDscr>

Fixed Value Node

Definition 3

The metadata document is valid, only if the node value equals to the fixed value defined in the profile, otherwise invalid.

Representation 3

DDI Profile

 <pr:Used xpath="/codeBook/stdyDscr/stdyInfo/sumDscr/anlyUnit/concept/@vocab"
 defaultValue="DDI Analysis Unit"
 fixedValue="true">
 </pr:Used>

Example 3

Valid, because vocab attribute value equals to “DDI Analysis Unit”

 <sumDscr>
 <anlyUnit>
 <concept vocab="DDI Analysis Unit" />
 </anlyUnit>
 </sumDscr>

Invalid, because vocab attribute value does not equal to “DDI Analysis Unit”

 <sumDscr>
 <anlyUnit>
 <concept vocab="DDI Analyseeinheit" />
 </anlyUnit>
 </sumDscr>

Optional Node

Definition 4

An XML node (element or attribute) described by a predicate-less XPath expression is optional to be used within the metadata document.
This constraint does not include Not Blank Node constraint.
The metadata document is valid, only if the element is present at least once and the node is not blank, otherwise invalid.

Representation 4

DDI Profile

 <pr:Used xpath="/codeBook/stdyDscr/citation/rspStmt/AuthEnty" isRequired="false"/>

Example 4

Valid, because AuthEnty element is present

 <stdyDscr>
 <citation>
 <rspStmt>
 <AuthEnty>Lummis, T., University of Essex. Department of Sociology</AuthEnty>
 </rspStmt>
 </citation>
 </stdyDscr>

Invalid, because AuthEnty element is not present

 <stdyDscr>
 <citation>
 <rspStmt/>
 </citation>
 </stdyDscr>

Valid although AuthEnty element is blank, because Not Blank Node constraint is not included.

 <stdyDscr>
 <citation>
 <rspStmt>
 <AuthEnty></AuthEnty>
 <!--or <AuthEnty> </AuthEnty> -->
 </rspStmt>
 </citation>
 </stdyDscr>

Mandatory Node if Parent Present

Definition 5

A node may only be mandatory if the parent node is present.
The metadata document is valid, only if - provided the parent node is present - the node itself is present at least once and is not blank, otherwise invalid.
This constraint includes Not Blank Node constraint.

Representation 5

DDI Profile

 <pr:Used xpath="/codeBook/stdyDscr/citation/titlStmt/IDNo" isRequired="false"/>
 <pr:Used xpath="/codeBook/stdyDscr/citation/titlStmt/IDNo/@agency" isRequired="false">
 <pr:Instructions>
 <r:Content>
 <![CDATA[
 <Constraints>
 <MandatoryNodeIfParentPresentConstraint/>
 </Constraints>
 ]]>
 </r:Content>
 </pr:Instructions>
 </pr:Used>

Example 5

Valid, because agency element is present and not blank

 <stdyDscr>
 <citation>
 <titlStmt>
 <IDNo agency="GESIS">ZA2800</IDNo>
 </titlStmt>
 </citation>
 </stdyDscr>

Valid, because IDNo parent element is not present

 <stdyDscr>
 <citation>
 <titlStmt/>
 </citation>
 </stdyDscr>

Invalid, because agency attribute is not present

 <stdyDscr>
 <citation>
 <titlStmt>
 <IDNo>ZA2800</IDNo>
 </titlStmt>
 </citation>
 </stdyDscr>

Invalid, because agency attribute is blank

 <stdyDscr>
 <citation>
 <titlStmt>
 <IDNo agency="">ZA2800</IDNo>
 </titlStmt>
 </citation>
 </stdyDscr>

Code Value of Controlled Vocabulary

Definition 6

A field element in a metadata document uses a controlled vocabulary (CV).
The metadata document is valid, only if the field element is a codeValue of the given CV, otherwise invalid.

Representation 6

DDI Profile

 <pr:Used xpath="/codeBook/stdyDscr/stdyInfo/sumDscr/anlyUnit/concept">
 <pr:Instructions>
 <r:Content>
 <![CDATA[
 <Constraints>
 <CodeValueOfControlledVocabularyConstraint/>
 </Constraints>
 ]]>
 </r:Content>
 </pr:Instructions>
 </pr:Used>
 <pr:Used xpath="/codeBook/stdyDscr/stdyInfo/sumDscr/anlyUnit/concept/@vocabURI">
 <pr:Instructions>
 <r:Content>
 <![CDATA[
 <Constraints>
 <ControlledVocabularyRepositoryConstraint>
 <RepositoryUri>https://vocabularies.cessda.eu/v1/vocabulary-details/AnalysisUnit/en/2.0</RepositoryUri>
 <RepositoryType>eu.cessda.cmv.core.controlledvocabulary.CessdaControlledVocabularyRepository</RepositoryType>
 </ControlledVocabularyRepositoryConstraint>
 <ControlledVocabularyRepositoryConstraint>
 <RepositoryUri>https://vocabularies.cessda.eu/v1/vocabulary-details/AnalysisUnit/en/1.0</RepositoryUri>
 <RepositoryType>eu.cessda.cmv.core.controlledvocabulary.CessdaControlledVocabularyRepository</RepositoryType>
 </ControlledVocabularyRepositoryConstraint>
 </Constraints>
 ]]>
 </r:Content>
 </pr:Instructions>
 </pr:Used>

Example 6

Valid, because Individual is a codeValue of AnalysisUnit:2.0 and TextUnit is a codeValue of AnalysisUnit:1.0

 <stdyInfo>
 <sumDscr>
 <anlyUnit>
 <concept vocabURI="https://vocabularies.cessda.eu/v1/vocabulary-details/AnalysisUnit/en/2.0">Individual</concept>
 <concept vocabURI="https://vocabularies.cessda.eu/v1/vocabulary-details/AnalysisUnit/en/1.0">TextUnit</concept>
 </anlyUnit>
 </sumDscr>
 </stdyInfo>

Invalid, because Person is not a codeValue of AnalysisUnit:2.0

 <stdyInfo>
 <sumDscr>
 <anlyUnit>
 <concept vocabURI="https://vocabularies.cessda.eu/v1/vocabulary-details/AnalysisUnit/en/2.0">Person</concept>
 </anlyUnit>
 </sumDscr>
 </stdyInfo>

Descriptive Term of Controlled Vocabulary

Definition 7

A field element in a metadata document uses a controlled vocabulary (CV).
The metadata document is valid, only if the field element is a descriptive term of the given CV, otherwise invalid.

Representation 7

DDI Profile

 <pr:Used xpath="/codeBook/stdyDscr/stdyInfo/sumDscr/anlyUnit">
 <pr:Instructions>
 <r:Content>
 <![CDATA[
 <Constraints>
 <DescriptiveTermOfControlledVocabularyConstraint/>
 </Constraints>
 ]]>
 </r:Content>
 </pr:Instructions>
 </pr:Used>
 <pr:Used xpath="/codeBook/stdyDscr/stdyInfo/sumDscr/anlyUnit/concept/@vocabURI">
 <pr:Instructions>
 <r:Content>
 <![CDATA[
 <Constraints>
 <ControlledVocabularyRepositoryConstraint>
 <RepositoryUri>https://vocabularies.cessda.eu/v1/vocabulary-details/AnalysisUnit/en/2.0</RepositoryUri>
 <RepositoryType>eu.cessda.cmv.core.controlledvocabulary.CessdaControlledVocabularyRepository</RepositoryType>
 </ControlledVocabularyRepositoryConstraint>
 </Constraints>
 ]]>
 </r:Content>
 </pr:Instructions>
 </pr:Used>

Example 7

Valid, because Media unit: Sound is a descriptive term of AnalysisUnit:2.0

 <stdyInfo>
 <sumDscr>
 <anlyUnit xml:lang="en">Media unit: Sound
 <concept vocabURI="https://vocabularies.cessda.eu/v1/vocabulary-details/AnalysisUnit/en/2.0">MediaUnit.Sound</concept>
 </anlyUnit>
 </sumDscr>
 </stdyInfo>

Invalid, because Sound media unit is not a descriptive term of AnalysisUnit:2.0

 <stdyInfo>
 <sumDscr>
 <anlyUnit xml:lang="en">Sound media unit
 <concept vocabURI="https://vocabularies.cessda.eu/v1/vocabulary-details/AnalysisUnit/en/2.0">MediaUnit.Sound</concept>
 </anlyUnit>
 </sumDscr>
 </stdyInfo>

Maximum Node Occurrence

Node in Profile

Not Blank Node

Compilable XPath

An XPath expression must be compilable. This constraint is used only for profile document validation.

# valid
/some/compilable/xpath

# invalid
/some/not compilable/xpath/because-of-blank

Predicate-less XPath

An XPath expression must not contain predicates. This constraint is used only for profile document validation.

# valid
/some/xpath/without/precicate

# invalid
/some/xpath/with/precicate[@version='1.0']