com.complexible.stardog.api.icv

Class EmbeddedICVConnection

java.lang.Object

com.complexible.stardog.api.impl.DelegatingConnection

com.complexible.stardog.icv.api.AbstractICVConnection

com.complexible.stardog.api.icv.EmbeddedICVConnection

All Implemented Interfaces:

Connection, ICVConnection, ICValidator, AutoCloseable

public final class EmbeddedICVConnection
extends AbstractICVConnection
implements ICVConnection

Since:

5.0

Version:

6.0

Author:

Michael Grove

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbeddedICVConnection.View

Field Summary

Fields inherited from class com.complexible.stardog.icv.api.AbstractICVConnection

LOGGER

Constructor Summary

Constructors

Constructor and Description
EmbeddedICVConnection(KernelDatabaseConnection theConnection, com.complexible.stardog.icv.ICVLimit theICVLimit)

Method Summary

Modifier and Type	Method and Description
protected KernelDatabaseConnection	getConnection()
Set<Constraint>	getConstraints() Return all of the constraints in the database
StatementIterator	getValidationReport(Collection<IRI> theActiveGraphs, Options theOptions, Constraint... theConstraints) Returns the SHACL validation report for the given SHACL constraints in the specified set of named graphs.
CloseableIterator<ConstraintViolation<BindingSet>>	getViolationBindings(Collection<IRI> theActiveGraphs, Constraint... theConstraints) Returns the violations for the given integrity constraints in the specified set of named graphs as binding sets.
boolean	isValid(Collection<IRI> theActiveGraphs, Constraint... theConstraints) Returns true if the given integrity constraints are violated in the specified set of named graphs.
ValidationReporter	reporter() Returns a validation reporter that can be used to retrieve the SHACL validation reports.

Methods inherited from class com.complexible.stardog.icv.api.AbstractICVConnection

assertOpen, isValid

Methods inherited from class com.complexible.stardog.api.impl.DelegatingConnection

add, admin, as, ask, ask, begin, close, commit, currentStatus, export, generateModel, get, getOption, getSchema, graph, graph, graphAliases, isOpen, isReasoningEnabled, name, namespaces, paths, paths, remove, rollback, select, select, selectPlan, selectPlan, size, transactions, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.complexible.stardog.api.Connection

add, admin, as, ask, ask, begin, close, commit, currentStatus, export, generateModel, get, getOption, getSchema, graph, graph, graphAliases, isOpen, isReasoningEnabled, name, namespaces, paths, paths, remove, rollback, select, select, selectPlan, selectPlan, size, transactions, update, update

Methods inherited from interface com.complexible.stardog.icv.ICValidator

close, getValidationReport, getValidationReport, getViolationBindings, isValid

Constructor Detail

EmbeddedICVConnection

public EmbeddedICVConnection(KernelDatabaseConnection theConnection,
                             com.complexible.stardog.icv.ICVLimit theICVLimit)

Method Detail

isValid

public boolean isValid(Collection<IRI> theActiveGraphs,
                       Constraint... theConstraints)
                throws StardogException

Returns true if the given integrity constraints are violated in the specified set of named graphs. If no constraints are given then all the current constraints in the database are used.

Specified by:

isValid in interface ICValidator

Parameters:

theActiveGraphs - the contexts to use in the validation. If the default context is to be used then ContextSets.DEFAULT_ONLY must be used. If all contexts are to be used, then ContextSets.LOCAL must be used

theConstraints - the constraints to check. If no constraints are given, the defined constraints will be used.

Returns:

true if the constraints are violated, false otherwise

Throws:

StardogException - if there was an error while checking the validity of the data in the database

getValidationReport

public StatementIterator getValidationReport(Collection<IRI> theActiveGraphs,
                                             Options theOptions,
                                             Constraint... theConstraints)
                                      throws StardogException

Description copied from interface: ICValidator

Returns the SHACL validation report for the given SHACL constraints in the specified set of named graphs. If no constraints are given then all the SHACL constraints in the database are used. Non-SHACL constraints are ignored by this function.

Specified by:

getValidationReport in interface ICValidator

Parameters:

theActiveGraphs - the contexts to use in the validation. If the default context is to be used then ContextSets.DEFAULT_ONLY must be used. If all contexts are to be used, then ContextSets.LOCAL must be used

theOptions - the options used to tune the validation process.

theConstraints - the SHACL constraints to validate. If no constraints are given, the constraints in the database will be used.

Returns:

a SHACL validation report as defined in the SHACL specification

Throws:

StardogException - if there was an error calculating the violations

reporter

public ValidationReporter reporter()

Description copied from interface: ICValidator

Returns a validation reporter that can be used to retrieve the SHACL validation reports.

Specified by:

reporter in interface ICValidator

Returns:

validation reporter

getViolationBindings

public CloseableIterator<ConstraintViolation<BindingSet>> getViolationBindings(Collection<IRI> theActiveGraphs,
                                                                               Constraint... theConstraints)
                                                                        throws StardogException

Returns the violations for the given integrity constraints in the specified set of named graphs as binding sets. If no constraints are given then all the current constraints in the database are used.

Specified by:

getViolationBindings in interface ICValidator

Parameters:

theActiveGraphs - the contexts to use in the validation. If the default context is to be used then ContextSets.DEFAULT_ONLY must be used. If all contexts are to be used, then ContextSets.LOCAL must be used

theConstraints - the constraints to check. If no constraints are given, the current constraints will be used.

Returns:

an iteration over the violations. An empty iteration will be returned if the data is valid

Throws:

StardogException - if there was an error calculating the violations

getConstraints

public Set<Constraint> getConstraints()
                               throws StardogException

Return all of the constraints in the database

Specified by:

getConstraints in interface ICValidator

Returns:

the constraints

Throws:

StardogException - if there was an error obtaining the constraints

getConnection

protected KernelDatabaseConnection getConnection()

Overrides:

getConnection in class AbstractICVConnection