fr.inria.lille.shexjava.validation

Interface ValidationAlgorithm

All Known Implementing Classes:

RecursiveValidation, RecursiveValidationWithMemorization, RefineValidation, SORBEBasedValidation, ValidationAlgorithmAbstract

@ApiStability.Stable
public interface ValidationAlgorithm

Allows to validate a graph against a ShEx schema. A ValidationAlgorithm must be initialized with an Graph and a ShexSchema. Then the validate(RDFTerm, Label) method tests whether a node satisfies the expression corresponding to a label. A call to validate(RDFTerm, Label) also constructs a Typing that allows to prove or disprove the result returned by the method, and that can be retrieved using getTyping(). Successive calls to validate(RDFTerm, Label) enrich the constructed Typing, unless it is reinitialized using resetTyping().

Author:

Iovka Boneva, Antonin Durey

Method Summary

Modifier and Type	Method and Description
void	addMatchingObserver(MatchingCollector o)
Typing	getTyping() The typing that proves the result returned by previous validations.
void	notifyMatchingFound(org.apache.commons.rdf.api.RDFTerm focusNode, Label label, LocalMatching matching) Notifies all observers that a matching was found, or that no matching is known for the given focusNode and label.
void	notifyStartValidation() Notifies all observers that a validation just started.
void	notifyValidationComplete() Notifies all observers that a validation just ended.
void	removeMatchingObserver(MatchingCollector o)
void	resetTyping() Resets the typing, thus erasing all previously computed validation results.
ResultShapeMap	validate(BaseShapeMap shapeMap) Constructs a shape map that allows to validate a focus node against a type.
ResultShapeMap	validate(BaseShapeMap shapeMap, ComputationController compController) Constructs a shape map that allows to validate a focus node against a type.
boolean	validate(org.apache.commons.rdf.api.RDFTerm focusNode, Label label) Constructs a shape map that allows to validate a focus node against a type.
boolean	validate(org.apache.commons.rdf.api.RDFTerm focusNode, Label label, ComputationController compController) Constructs a shape map that allows to validate a focus node against a type.

Method Detail

validate

@ApiStability.Stable
boolean validate(org.apache.commons.rdf.api.RDFTerm focusNode,
                                      Label label)

Constructs a shape map that allows to validate a focus node against a type. Returns true if the focus node is conformant with the expression which label is given, and returns false otherwise.

Parameters:

focusNode - The focus node for which the shape map is to be complete. The node must belong to the graph.

label - The label against which the node is being tested.

Returns:

true iff the subsequent call to Typing#getStatus returns Status.CONFORMANT

Throws:

IllegalArgumentException - if the label does not belong to the schema

validate

boolean validate(org.apache.commons.rdf.api.RDFTerm focusNode,
                 Label label,
                 ComputationController compController)
          throws Exception

Constructs a shape map that allows to validate a focus node against a type. Returns true if the focus node is conformant with the expression which label is given, and returns false otherwise.

Parameters:

focusNode - The focus node for which the shape map is to be complete. The node must belong to the graph.

label - The label against which the node is being tested.

time -

Returns:

true iff the subsequent call to Typing#getStatus returns Status.CONFORMANT

Throws:

IllegalArgumentException - if the label does not belong to the schema

Exception

validate

ResultShapeMap validate(BaseShapeMap shapeMap)

Constructs a shape map that allows to validate a focus node against a type. Returns a shape map with the results of the associations found in the shapeMap passed to the function.

Parameters:

shapeMap - The shapeMap with the asociations requested.

Returns:

a shape map with the result

Throws:

IllegalArgumentException - if the label does not belong to the schema

validate

ResultShapeMap validate(BaseShapeMap shapeMap,
                        ComputationController compController)
                 throws Exception

Constructs a shape map that allows to validate a focus node against a type. Returns a shape map with the results of the associations found in the shapeMap passed to the function.

Parameters:

shapeMap - The shapeMap with the asociations requested.

Returns:

a shape map with the result

Throws:

IllegalArgumentException - if the label does not belong to the schema

Exception

getTyping

@ApiStability.Stable
Typing getTyping()

The typing that proves the result returned by previous validations.

resetTyping

@ApiStability.Stable
void resetTyping()

Resets the typing, thus erasing all previously computed validation results.

notifyMatchingFound

void notifyMatchingFound(org.apache.commons.rdf.api.RDFTerm focusNode,
                         Label label,
                         LocalMatching matching)

Notifies all observers that a matching was found, or that no matching is known for the given focusNode and label. The matching provided by this notification is not guaranteed to be valid w.r.t. the eventually computed correct typing that will be returned by getTyping(). The ValidationAlgorithm guarantees however that for any given focusNode and label, the notification regarding these focusNode and label that is the last one between two consecutive calls of notifyStartValidation() and notifyValidationComplete(), contains a matching that is valid within the typing returned by getTyping().

Parameters:

focusNode -

label -

matching - null means that no matching is known

notifyStartValidation

void notifyStartValidation()

Notifies all observers that a validation just started. Is called at the begining of validate(RDFTerm, Label)

notifyValidationComplete

void notifyValidationComplete()

Notifies all observers that a validation just ended.

addMatchingObserver

void addMatchingObserver(MatchingCollector o)

removeMatchingObserver

void removeMatchingObserver(MatchingCollector o)