public interface ValidationReporter
Interface to generate a SHACL validation report. Follows a builder pattern to configure the parameters of validation report generation and provides various different terminal functions for retrieving the report:
results()
- Returns an iterator of ValidationResult
sreport()
- Returns an iterator of triples the correspond to the RDF serialization of the reportreport(RDFHandler)
- Passes the RDF serialization of the report to a handlerAny of these functions can be called for processing the validation results. But each call will perform the validation again and subsequent values might return different results if the database and/or the constraints change between those two calls. The results are returned in a streaming fashion as reported by the server.
Modifier and Type | Method and Description |
---|---|
default ValidationReporter |
constraint(Constraint constraint)
Validate only the given constraint ignoring other constraints stored in the database.
|
ValidationReporter |
constraints(Collection<Constraint> theConstraints)
Validate only the given constraints ignoring other constraints stored in the database.
|
ValidationReporter |
countLimit(int limit)
Limits the number of validation results returned by the explainer.
|
ValidationReporter |
graphs(Collection<IRI> graphs)
Validate only the given named graphs ignoring information in other named graphs.
|
default ValidationReporter |
node(Value node)
Validate only the given RDF node ignoring other nodes stored in the database.
|
ValidationReporter |
nodes(Collection<Value> nodes)
Validate only the given RDF nodes ignoring other nodes stored in the database.
|
<T> ValidationReporter |
option(Option<T> option,
T value)
Set an configuration option for the validator.
|
ValidationReporter |
options(Options options)
Set configuration options for the reporter.
|
StatementIterator |
report()
Returns the triples for the validation report.
|
void |
report(RDFHandler handler)
Pass the triples of the validation report to the provided handler.
|
CloseableIterator<com.complexible.stardog.icv.shacl.ValidationResult> |
results()
Returns the
validation result s. |
default ValidationReporter |
shape(IRI shape)
Validate only the given shape ignoring any other shape.
|
ValidationReporter |
shapeGraphs(Collection<IRI> shapeGraphs)
Validate only the shapes with supplied contexts.
|
ValidationReporter |
shapes(Collection<IRI> shapes)
Validate only the given shapes ignoring any other shape.
|
ValidationReporter countLimit(int limit)
ValidationReporter graphs(Collection<IRI> graphs)
default ValidationReporter shape(IRI shape)
ValidationReporter shapes(Collection<IRI> shapes)
ValidationReporter shapeGraphs(Collection<IRI> shapeGraphs)
default ValidationReporter constraint(Constraint constraint)
ValidationReporter constraints(Collection<Constraint> theConstraints)
default ValidationReporter node(Value node)
ValidationReporter nodes(Collection<Value> nodes)
<T> ValidationReporter option(Option<T> option, T value)
T
- type of the option valueoption
- the option to setvalue
- the option valueValidationOptions
ValidationReporter options(Options options)
options
- options to setStatementIterator report() throws StardogException
StardogException
void report(RDFHandler handler) throws StardogException
RDFHandler.start()
and RDFHandler.end()
functions
should be called by the caller.StardogException
CloseableIterator<com.complexible.stardog.icv.shacl.ValidationResult> results()
validation result
s.Copyright © 2010-2016 Stardog Union. All Rights Reserved.