org.topbraid.shacl.model

Interface SHParameterizable

All Superinterfaces:

org.apache.jena.graph.FrontsNode, org.apache.jena.rdf.model.RDFNode, org.apache.jena.rdf.model.Resource, SHResource

All Known Subinterfaces:

SHConstraintComponent, SHFunction, SHJSFunction, SHSPARQLFunction

All Known Implementing Classes:

SHConstraintComponentImpl, SHJSFunctionImpl, SHParameterizableImpl, SHSPARQLFunctionImpl

public interface SHParameterizable
extends SHResource

Method Summary

Modifier and Type	Method and Description
String	getLabelTemplate()
List<SHParameter>	getOrderedParameters() Gets an ordered List of all declared SHParameters, based on sh:order values (if one of them exists), then the local names of the path predicates.
List<SHParameter>	getParameters() Gets an unordered List of all declared Parameters.
Map<String,SHParameter>	getParametersMap() Gets a Map of variable names to Parameters.
boolean	isOptionalParameter(org.apache.jena.rdf.model.Property predicate) Checks if one of the sh:parameters declaring a given predicate is also marked as sh:optional true.

Methods inherited from interface org.apache.jena.rdf.model.Resource

abort, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addProperty, addProperty, addProperty, addProperty, begin, commit, equals, getId, getLocalName, getNameSpace, getProperty, getProperty, getPropertyResourceValue, getRequiredProperty, getRequiredProperty, getURI, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasProperty, hasProperty, hasProperty, hasProperty, hasURI, inModel, listProperties, listProperties, listProperties, removeAll, removeProperties, toString

Methods inherited from interface org.apache.jena.rdf.model.RDFNode

as, asLiteral, asResource, canAs, getModel, isAnon, isLiteral, isResource, isURIResource, visitWith

Methods inherited from interface org.apache.jena.graph.FrontsNode

asNode

Method Detail

getParameters

List<SHParameter> getParameters()

Gets an unordered List of all declared Parameters.

Returns:

the (possibly empty) List of Parameters

getParametersMap

Map<String,SHParameter> getParametersMap()

Gets a Map of variable names to Parameters.

Returns:

a Map of variable names to Parameters

getLabelTemplate

String getLabelTemplate()

getOrderedParameters

List<SHParameter> getOrderedParameters()

Gets an ordered List of all declared SHParameters, based on sh:order values (if one of them exists), then the local names of the path predicates.

Returns:

the (possibly empty) List of SHParameters

isOptionalParameter

boolean isOptionalParameter(org.apache.jena.rdf.model.Property predicate)

Checks if one of the sh:parameters declaring a given predicate is also marked as sh:optional true.

Parameters:

predicate - the predicate to check

Returns:

true if there is an optional declaration for the given predicate