org.da.sparqlhelper.sparql.model

Interface ISparqlRequestGroup

All Superinterfaces:

DistanceUnits, ExpressionTypes, IndentableElement

All Known Subinterfaces:

ISparqlRequest

All Known Implementing Classes:

AbstractSparqlRequest, InvalidSparqlRequest, SparqlDistance, SparqlRequest, SparqlRequestGroup

public interface ISparqlRequestGroup
extends IndentableElement, ExpressionTypes, DistanceUnits

A Sparql request group interface.

Field Summary

Fields inherited from interface org.da.sparqlhelper.sparql.model.ExpressionTypes

LABEL, SUBCLASS_OF, SUBCLASS_OF_STAR, TYPE, TYPE_SUBCLASS_OF

Fields inherited from interface org.da.sparqlhelper.sparql.model.DistanceUnits

DISTANCE_FT, DISTANCE_KM, DISTANCE_M, DISTANCE_NM

Method Summary

Modifier and Type	Method and Description
boolean	addAdditionalVariable(java.lang.String varName) Add an additional variable in the query.
boolean	addAdditionalVariable(Variable var) Add an additional variable in the query.
AskForm	addAsk() Add an ASK form.
default java.lang.String	addAutoVariable() Add an additional variable in the query with a name chosen automatically.
java.lang.String	addAutoVariable(java.lang.String radix) Add an additional variable in the query with a name chosen automatically.
Bind	addBind() Add a bind.
Bind	addBind(java.lang.String var) Add a bind.
Coalesce	addCoalesce() Add a coalesce.
DeleteForm	addDelete() Add a DELETE form.
boolean	addDistance(java.lang.String var, java.lang.String fromVar, java.lang.String varDist, short unit, boolean isExact) Add a distance property reference declaration in the WHERE part of the request.
Filter	addFilter() Add a FILTER clause.
boolean	addGeometry(java.lang.String var, java.lang.String varLat, java.lang.String varLon, boolean isExact) Add a geometry declaration in the WHERE part of the request.
Filter	addHaving() Add a HAVING clause.
InsertForm	addInsert() Add an INSERT form.
InsertForm	addInsertData() Add an INSERT DATA form.
boolean	addIRI(IRI iri) Add an IRI.
default OperationResult<WhereExpression>	addLabel(java.lang.String var, java.lang.String type) Add a rdfs:label matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addLabel(java.lang.String var, TripleElement element) Add a rdfs:label matching declaration in the WHERE part of the request.
default OperationResult<GraphPattern>	addProperty(TripleElement object, TripleElement property, TripleElement target) Add an object property reference declaration in the OPTIONAL construct.
OperationResult<GraphPattern>	addProperty(TripleElement object, TripleElement property, TripleElement target, boolean optional) Add an object property reference declaration in the OPTIONAL construct.
default OperationResult<? extends SparqlElement>	addPropertyIndividualRef(java.lang.String var, java.lang.String propertyName, java.lang.String individual) Add an object property individual declaration in the WHERE part of the request.
default OperationResult<? extends SparqlElement>	addPropertyIndividualRef(java.lang.String var, TripleElement type, java.lang.String individual) Add an object property individual declaration in the WHERE part of the request.
OperationResult<? extends SparqlElement>	addPropertyIndividualRef(java.lang.String var, TripleElement type, java.lang.String individual, boolean optional) Add an object property individual declaration in the WHERE part of the request.
default OperationResult<PropertyRef>	addPropertyRef(java.lang.String var, PrefixedName propertyName, java.lang.String varRef) Add an object property reference declaration in the OPTIONAL construct.
default OperationResult<PropertyRef>	addPropertyRef(java.lang.String var, java.lang.String propertyName, java.lang.String varRef) Add an object property reference declaration in the OPTIONAL construct.
default OperationResult<PropertyRef>	addPropertyRef(java.lang.String var, java.lang.String propertyName, java.lang.String varRef, boolean optional) Add an object property reference declaration in the OPTIONAL construct.
default OperationResult<PropertyRef>	addPropertyRef(java.lang.String var, TripleElement type, java.lang.String varRef) Add an object property reference declaration in the OPTIONAL construct.
OperationResult<PropertyRef>	addPropertyRef(java.lang.String var, TripleElement type, java.lang.String varRef, boolean optional) Add an object property reference declaration in the OPTIONAL construct.
default OperationResult<PropertyRef>	addPropertyRef(java.lang.String var, TripleElement type, VariableOrIRI varOrIRIRef, boolean optional) Add an object property reference declaration in the OPTIONAL construct.
OperationResult<PropertyRef>	addPropertyRef(VariableOrIRI varOrIRI, TripleElement type, VariableOrIRI varOrIRIRef, boolean optional) Add an object property reference declaration in the OPTIONAL construct.
default OperationResult<? extends SparqlElement>	addPropertyValue(java.lang.String var, PrefixedName propertyName, java.lang.Object propertyValue) Add a property value declaration in the OPTIONAL construct.
default OperationResult<? extends SparqlElement>	addPropertyValue(java.lang.String var, java.lang.String propertyName, java.lang.Object propertyValue) Add a property value declaration in the OPTIONAL construct.
default OperationResult<? extends SparqlElement>	addPropertyValue(java.lang.String var, java.lang.String propertyName, java.lang.Object propertyValue, boolean optional) Add a property value declaration in the WHERE part of the request.
default OperationResult<? extends SparqlElement>	addPropertyValue(java.lang.String var, TripleElement type, java.lang.Object propertyValue) Add a property value declaration in the OPTIONAL construct.
OperationResult<? extends SparqlElement>	addPropertyValue(java.lang.String var, TripleElement type, java.lang.Object propertyValue, boolean optional) Add a property value declaration in the WHERE part of the request.
default OperationResult<Property>	addPropertyValues(java.lang.String var, java.util.List<? extends java.lang.Object> values) Add a property value declaration in the WHERE part of the request, for several values.
default OperationResult<Property>	addPropertyValues(java.lang.String var, java.lang.String propertyName, java.util.List<? extends java.lang.Object> values) Add a property value declaration in the WHERE part of the request, for several values.
default OperationResult<Property>	addPropertyValues(java.lang.String var, java.lang.String propertyName, java.util.List<? extends java.lang.Object> values, boolean optional) Add a property value declaration in the WHERE part of the request, for several values.
OperationResult<Property>	addPropertyValues(java.lang.String var, TripleElement type, java.util.List<? extends java.lang.Object> values, boolean optional) Add a property value declaration in the WHERE part of the request, for several values.
default OperationResult<WhereExpression>	addSubClassOf(java.lang.String var, java.lang.String type) Add a rdf:subClassOf matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addSubClassOf(java.lang.String var, TripleElement type) Add a rdf:subClassOf matching declaration in the WHERE part of the request.
default OperationResult<WhereExpression>	addSubClassOfStar(java.lang.String var, java.lang.String type) Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addSubClassOfStar(java.lang.String var, TripleElement type) Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.
boolean	addTime(java.lang.String var, java.lang.String varTime, boolean isDateTime) Add a time declaration in the WHERE part of the request.
default OperationResult<WhereExpression>	addType(java.lang.String var, short exprKind, java.lang.String type) Add a matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addType(java.lang.String var, short exprKind, TripleElement type) Add a matching declaration in the WHERE part of the request.
default OperationResult<WhereExpression>	addType(java.lang.String var, java.lang.String type) Add a rdf:type matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addType(java.lang.String var, TripleElement type) Add a rdf:type matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addType(VariableOrIRI varOrIRI, TripleElement type) Add a rdf:type matching declaration in the WHERE part of the request.
default OperationResult<WhereExpression>	addTypeSubClassOf(java.lang.String var, java.lang.String type) Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addTypeSubClassOf(java.lang.String var, TripleElement type) Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.
boolean	addVariable(Variable var) Add a variable.
boolean	addVariableOrIRI(VariableOrIRI varOrIRI) Add a variable or IRI.
default OperationResult<WhereExpression>	addVariableSubClassOf(java.lang.String var, java.lang.String typeVar) Add a rdf:subClassOf matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addVariableSubClassOf(java.lang.String var, TripleElement typeVar) Add a rdf:subClassOf matching declaration in the WHERE part of the request.
default OperationResult<WhereExpression>	addVariableSubClassOfStar(java.lang.String var, java.lang.String typeVar) Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addVariableSubClassOfStar(java.lang.String var, TripleElement typeVar) Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.
default OperationResult<WhereExpression>	addVariableType(java.lang.String var, short exprKind, java.lang.String typeVar) Add a matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addVariableType(java.lang.String var, short exprKind, TripleElement typeVar) Add a matching declaration in the WHERE part of the request.
default OperationResult<WhereExpression>	addVariableType(java.lang.String var, java.lang.String typeVar) Add a rdf:type matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addVariableType(java.lang.String var, TripleElement element) Add a rdf:type matching declaration in the WHERE part of the request.
default OperationResult<WhereExpression>	addVariableTypeSubClassOf(java.lang.String var, java.lang.String typeVar) Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addVariableTypeSubClassOf(java.lang.String var, TripleElement typeVar) Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.
boolean	checkVariableExistence(java.lang.String var) Check the existence of a variable.
Variable	createAdditionalVariable(java.lang.String name) Create an additional variable with a specified name.
IRI	createIRI(java.lang.String name) Create an IRI with a specified name.
Variable	createVariable(java.lang.String name) Create a variable with a specified name.
java.util.Map<java.lang.String,Variable>	getAdditionalVars() Return the additional variables.
default java.util.Map<java.lang.String,Variable>	getAllVariables() Return the map of all variables. it includes both variables in the SELECT part and the other variables.
AskForm	getAskForm() Return the ASK form.
java.util.List<Bind>	getBinds() Return the bindings.
java.util.List<Coalesce>	getCoalesces() Return the coalesce expressions.
java.lang.String	getDefaultPrefix() Return the prefix.
java.util.List<DeleteForm>	getDeleteForms() Return the DELETE forms.
java.util.Map<java.lang.String,SparqlDistance>	getDistances() Return the geosparql distances.
WhereForm	getEffectiveWhereForm() Return the effective WHERE form.
java.util.List<Filter>	getFilters() Return the filters.
java.util.Map<java.lang.String,SparqlGeometry>	getGeometries() Return the geosparql geometries.
java.util.List<GraphPattern>	getGraphPatterns() Return the graph patterns.
java.util.List<InsertForm>	getInsertForms() Return the INSERT forms.
IRI	getIRI(java.lang.String name) Return the IRI with a specified name.
java.util.Map<java.lang.String,IRI>	getIRIs() Return the map of IRIs.
int	getOffset() Return the OFFSET of the number of results.
java.util.List<SparqlRequestGroup>	getOptionals() Return the list of optional groups in this request.
java.util.Map<java.lang.String,SparqlTime>	getOwlTimes() Return the owl-time expressions.
java.lang.String	getPrefix(Property property) Return the prefix of a property.
java.lang.String	getPrefix(PropertyRef property) Return the prefix of a property reference.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,Individual>>	getPropertyIndRefs() Return the property individual references.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<PropertyRef>>>	getPropertyRefs() Return the property references.
java.util.Map<java.lang.String,java.util.List<Property>>	getPropertyValues() Return the property values.
SparqlRequest	getRootRequest() Return the top level request.
SelectForm	getSelectForm() Return the SELECT form.
java.util.List<SelectItem>	getSelectList() Return the list of SELECT items.
java.util.Map<java.lang.String,SelectItem>	getSelectMap() Return the map of SELECT items.
java.util.List<Union>	getUnions() Return the list of unions in this request.
Variable	getVariable(java.lang.String name) Return the variable with a specified name.
VariableOrIRI	getVariableOrIRI(java.lang.String name) Return the variable or IRI with a specified name.
java.util.Map<java.lang.String,Variable>	getVariables() Return the map of variables.
java.util.Iterator<Variable>	getVariablesIterator() Return an iterator on the variables.
java.util.Iterator<VariableOrIRI>	getVariablesOrIRIIterator() Return an iterator on the variables and IRIs.
char	getVariableType(java.lang.String name) Return the type of a variable.
java.util.List<WhereExpression>	getWhereExpressions() Return the where expressions in the request.
WhereForm	getWhereForm() Return the WHERE form.
boolean	hasAdditionalVariable(java.lang.String var) Return true if there is an additional variable with a specified name.
boolean	hasAskForm() Return true if there is an ASK form.
default boolean	hasDeleteForms() Return true if there are DELETE forms.
default boolean	hasFilters() Return true if there are FILTER and HAVING clauses.
default boolean	hasInsertForms() Return true if there are INSERT forms.
boolean	hasIRI(java.lang.String name) Return true if there is an IRI with a specified name.
boolean	hasSelectVariable(java.lang.String var) Return true if the SELECT part of the request has a specified variable.
boolean	hasUnions() Return true if there are unions in this request.
boolean	hasVariable(java.lang.String name) Return true if there is a variable with a specified name.
boolean	hasVariableOrIRI(java.lang.String name) Return true if there is variable or IRI with a specified name.
boolean	isCheckingVariablesExistence() Return true if the variables existence if checked during the creation of the request.
default boolean	isFlat() Return true if the group is flat.
boolean	isLoggingErrors() Return true if errors should be logged.
boolean	isSelectAll() Return true if the request is a SELECT ALL (*).
default SelectItem	removeSelect(java.lang.String varName) Remove a SELECT item.
void	resetSPARQLResult() Reset the SPARQL result used in serialization.

Methods inherited from interface org.da.sparqlhelper.sparql.model.IndentableElement

getLevel, indent, indentMore, indentParent

Method Detail

isFlat

default boolean isFlat()

Return true if the group is flat.

Returns:

true if the group is flat

getRootRequest

SparqlRequest getRootRequest()

Return the top level request.

Returns:

the top level request

addVariable

boolean addVariable(Variable var)

Add a variable.

Parameters:

var - the variable

Returns:

true if the variable could be added

addAdditionalVariable

boolean addAdditionalVariable(java.lang.String varName)

Add an additional variable in the query.

Parameters:

varName - the variable name

Returns:

true if the variable could be added

addAdditionalVariable

boolean addAdditionalVariable(Variable var)

Add an additional variable in the query.

Parameters:

var - the variable

Returns:

true if the variable could be added

getWhereExpressions

java.util.List<WhereExpression> getWhereExpressions()

Return the where expressions in the request.

Returns:

the where expressions

createVariable

Variable createVariable(java.lang.String name)

Create a variable with a specified name. Note that it will return the existing variable if there is already a variable with the specified name.

Parameters:

name - the variable name

Returns:

the variable

createAdditionalVariable

Variable createAdditionalVariable(java.lang.String name)

Create an additional variable with a specified name. Note that it will return the existing variable if there is already a variable with the specified name.

Parameters:

name - the variable name

Returns:

the variable

getVariable

Variable getVariable(java.lang.String name)

Return the variable with a specified name.

Parameters:

name - the variable name

Returns:

the variable

getVariableType

char getVariableType(java.lang.String name)

Return the type of a variable.

Parameters:

name - the variable name

Returns:

the type

See Also:

VariableType

hasVariable

boolean hasVariable(java.lang.String name)

Return true if there is a variable with a specified name.

Parameters:

name - the variable name

Returns:

true if there is a variable with the specified name

getVariables

java.util.Map<java.lang.String,Variable> getVariables()

Return the map of variables.

Returns:

the map of variables

getAllVariables

default java.util.Map<java.lang.String,Variable> getAllVariables()

Return the map of all variables. it includes both variables in the SELECT part and the other variables.

Returns:

the map of all variables

See Also:

getVariables(), getAdditionalVars()

getVariablesIterator

java.util.Iterator<Variable> getVariablesIterator()

Return an iterator on the variables.

Returns:

an iterator on the variables

getVariablesOrIRIIterator

java.util.Iterator<VariableOrIRI> getVariablesOrIRIIterator()

Return an iterator on the variables and IRIs.

Returns:

an iterator on the variables and IRIs

addIRI

boolean addIRI(IRI iri)

Add an IRI.

Parameters:

iri - the IRI

Returns:

true if the IRI could be added

createIRI

IRI createIRI(java.lang.String name)

Create an IRI with a specified name. Note that it will return the existing variable if there is already an IRI with the specified name.

Parameters:

name - the IRI name

Returns:

the IRI

getIRI

IRI getIRI(java.lang.String name)

Return the IRI with a specified name.

Parameters:

name - the IRI name

Returns:

the IRI

hasIRI

boolean hasIRI(java.lang.String name)

Return true if there is an IRI with a specified name.

Parameters:

name - the IRI name

Returns:

true if there is an IRI with the specified name

getIRIs

java.util.Map<java.lang.String,IRI> getIRIs()

Return the map of IRIs.

Returns:

the map of IRIs

getVariableOrIRI

VariableOrIRI getVariableOrIRI(java.lang.String name)

Return the variable or IRI with a specified name.

Parameters:

name - the variable or IRI name

Returns:

the variable or IRI

hasVariableOrIRI

boolean hasVariableOrIRI(java.lang.String name)

Return true if there is variable or IRI with a specified name.

Parameters:

name - the variable or IRI name

Returns:

true if there is variable or IRI with the specified name

addVariableOrIRI

boolean addVariableOrIRI(VariableOrIRI varOrIRI)

Add a variable or IRI.

Parameters:

varOrIRI - the variable or IRI

Returns:

true if the variable or IRI could be added

isSelectAll

boolean isSelectAll()

Return true if the request is a SELECT ALL (*).

Returns:

true if the request is a SELECT ALL

hasSelectVariable

boolean hasSelectVariable(java.lang.String var)

Return true if the SELECT part of the request has a specified variable.

Parameters:

var - the variable name

Returns:

true if the SELECT part of the request has the specified variable

hasAdditionalVariable

boolean hasAdditionalVariable(java.lang.String var)

Return true if there is an additional variable with a specified name.

Parameters:

var - the variable name

Returns:

true if there is an additional variable with thr specified name

getDeleteForms

java.util.List<DeleteForm> getDeleteForms()

Return the DELETE forms.

Returns:

the DELETE forms

hasDeleteForms

default boolean hasDeleteForms()

Return true if there are DELETE forms.

Returns:

true if there are DELETE forms

addDelete

DeleteForm addDelete()

Add a DELETE form.

Returns:

the DELETE form

getInsertForms

java.util.List<InsertForm> getInsertForms()

Return the INSERT forms.

Returns:

the INSERT forms

hasInsertForms

default boolean hasInsertForms()

Return true if there are INSERT forms.

Returns:

true if there are INSERT forms

addInsert

InsertForm addInsert()

Add an INSERT form.

Returns:

the INSERT form

getAskForm

AskForm getAskForm()

Return the ASK form.

Returns:

the ASK form

hasAskForm

boolean hasAskForm()

Return true if there is an ASK form.

Returns:

true if there is an ASK form

addAsk

AskForm addAsk()

Add an ASK form.

Returns:

the ASK form

addInsertData

InsertForm addInsertData()

Add an INSERT DATA form.

Returns:

the INSERT DATA form

getSelectForm

SelectForm getSelectForm()

Return the SELECT form.

Returns:

the SELECT form

getWhereForm

WhereForm getWhereForm()

Return the WHERE form.

Returns:

the WHERE form

hasFilters

default boolean hasFilters()

Return true if there are FILTER and HAVING clauses.

Returns:

true if there are FILTER and HAVING clauses

getEffectiveWhereForm

WhereForm getEffectiveWhereForm()

Return the effective WHERE form.

Returns:

the effective WHERE form

isCheckingVariablesExistence

boolean isCheckingVariablesExistence()

Return true if the variables existence if checked during the creation of the request.

Returns:

true if the variables existence if checked during the creation of the request

addAutoVariable

default java.lang.String addAutoVariable()

Add an additional variable in the query with a name chosen automatically.

Returns:

the variable name

addAutoVariable

java.lang.String addAutoVariable(java.lang.String radix)

Add an additional variable in the query with a name chosen automatically.

Parameters:

radix - the variable radix

Returns:

the variable name

getPropertyValues

java.util.Map<java.lang.String,java.util.List<Property>> getPropertyValues()

Return the property values.

Returns:

the property values

getPropertyRefs

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<PropertyRef>>> getPropertyRefs()

Return the property references.

Returns:

the property references

getPropertyIndRefs

java.util.Map<java.lang.String,java.util.Map<java.lang.String,Individual>> getPropertyIndRefs()

Return the property individual references.

Returns:

the property individual references

getGraphPatterns

java.util.List<GraphPattern> getGraphPatterns()

Return the graph patterns.

Returns:

the graph patterns

getDistances

java.util.Map<java.lang.String,SparqlDistance> getDistances()

Return the geosparql distances.

Returns:

the geosparql distances

getGeometries

java.util.Map<java.lang.String,SparqlGeometry> getGeometries()

Return the geosparql geometries.

Returns:

the geosparql geometries

getFilters

java.util.List<Filter> getFilters()

Return the filters.

Returns:

the filters

getBinds

java.util.List<Bind> getBinds()

Return the bindings.

Returns:

the bindings

getCoalesces

java.util.List<Coalesce> getCoalesces()

Return the coalesce expressions.

Returns:

the coalesce expressions

getOwlTimes

java.util.Map<java.lang.String,SparqlTime> getOwlTimes()

Return the owl-time expressions.

Returns:

the owl-time expressions

addGeometry

boolean addGeometry(java.lang.String var,
                    java.lang.String varLat,
                    java.lang.String varLon,
                    boolean isExact)

Add a geometry declaration in the WHERE part of the request.

Parameters:

var - the variable name

varLat - the latitude variable name

varLon - the longitude variable name

isExact - the name for an exact geometry

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addTime

boolean addTime(java.lang.String var,
                java.lang.String varTime,
                boolean isDateTime)

Add a time declaration in the WHERE part of the request.

Parameters:

var - the variable name

varTime - the time variable name

isDateTime - true for a dateTime property

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addDistance

boolean addDistance(java.lang.String var,
                    java.lang.String fromVar,
                    java.lang.String varDist,
                    short unit,
                    boolean isExact)

Add a distance property reference declaration in the WHERE part of the request.

Parameters:

var - the variable name

fromVar - the other elment variable name

varDist - the distance variable name

unit - the unit

isExact - the name for an exact geometry

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addProperty

OperationResult<GraphPattern> addProperty(TripleElement object,
                                          TripleElement property,
                                          TripleElement target,
                                          boolean optional)

Add an object property reference declaration in the OPTIONAL construct.

Parameters:

object - the object

property - the property

target - the target

optional - true for an optional pattern

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addProperty

default OperationResult<GraphPattern> addProperty(TripleElement object,
                                                  TripleElement property,
                                                  TripleElement target)

Add an object property reference declaration in the OPTIONAL construct.

Parameters:

object - the object

property - the property

target - the target

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyIndividualRef

default OperationResult<? extends SparqlElement> addPropertyIndividualRef(java.lang.String var,
                                                                          java.lang.String propertyName,
                                                                          java.lang.String individual)

Add an object property individual declaration in the WHERE part of the request.

Parameters:

var - the variable name

propertyName - the property name

individual - the individual name

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyIndividualRef

default OperationResult<? extends SparqlElement> addPropertyIndividualRef(java.lang.String var,
                                                                          TripleElement type,
                                                                          java.lang.String individual)

Add an object property individual declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the property

individual - the individual name

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyIndividualRef

OperationResult<? extends SparqlElement> addPropertyIndividualRef(java.lang.String var,
                                                                  TripleElement type,
                                                                  java.lang.String individual,
                                                                  boolean optional)

Add an object property individual declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the property

individual - the individual name

optional - true for an optional pattern

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyRef

default OperationResult<PropertyRef> addPropertyRef(java.lang.String var,
                                                    TripleElement type,
                                                    java.lang.String varRef)

Add an object property reference declaration in the OPTIONAL construct.

Parameters:

var - the variable name

type - the property

varRef - the variable to use for the reference

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyRef

OperationResult<PropertyRef> addPropertyRef(java.lang.String var,
                                            TripleElement type,
                                            java.lang.String varRef,
                                            boolean optional)

Add an object property reference declaration in the OPTIONAL construct.

Parameters:

var - the variable name

type - the property

varRef - the variable to use for the reference

optional - true for an optional property

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyRef

OperationResult<PropertyRef> addPropertyRef(VariableOrIRI varOrIRI,
                                            TripleElement type,
                                            VariableOrIRI varOrIRIRef,
                                            boolean optional)

Add an object property reference declaration in the OPTIONAL construct.

Parameters:

varOrIRI - the variable or IRI

type - the property

varOrIRIRef - the variable or IRI to use for the reference

optional - true for an optional property

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyRef

default OperationResult<PropertyRef> addPropertyRef(java.lang.String var,
                                                    TripleElement type,
                                                    VariableOrIRI varOrIRIRef,
                                                    boolean optional)

Add an object property reference declaration in the OPTIONAL construct.

Parameters:

var - the variable name

type - the property

varOrIRIRef - the variable or IRI to use for the reference

optional - true for an optional property

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyRef

default OperationResult<PropertyRef> addPropertyRef(java.lang.String var,
                                                    PrefixedName propertyName,
                                                    java.lang.String varRef)

Add an object property reference declaration in the OPTIONAL construct.

Parameters:

var - the variable name

propertyName - the property name

varRef - the variable to use for the reference

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyRef

default OperationResult<PropertyRef> addPropertyRef(java.lang.String var,
                                                    java.lang.String propertyName,
                                                    java.lang.String varRef)

Add an object property reference declaration in the OPTIONAL construct.

Parameters:

var - the variable name

propertyName - the property name

varRef - the variable to use for the reference

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyRef

default OperationResult<PropertyRef> addPropertyRef(java.lang.String var,
                                                    java.lang.String propertyName,
                                                    java.lang.String varRef,
                                                    boolean optional)

Add an object property reference declaration in the OPTIONAL construct.

Parameters:

var - the variable name

propertyName - the property name

varRef - the variable to use for the reference

optional - true for an optional property

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyValue

default OperationResult<? extends SparqlElement> addPropertyValue(java.lang.String var,
                                                                  PrefixedName propertyName,
                                                                  java.lang.Object propertyValue)

Add a property value declaration in the OPTIONAL construct.

Parameters:

var - the variable name

propertyName - the property name

propertyValue - the property value

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyValue

default OperationResult<? extends SparqlElement> addPropertyValue(java.lang.String var,
                                                                  java.lang.String propertyName,
                                                                  java.lang.Object propertyValue)

Add a property value declaration in the OPTIONAL construct.

Parameters:

var - the variable name

propertyName - the property name

propertyValue - the property value

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyValue

default OperationResult<? extends SparqlElement> addPropertyValue(java.lang.String var,
                                                                  TripleElement type,
                                                                  java.lang.Object propertyValue)

Add a property value declaration in the OPTIONAL construct.

Parameters:

var - the variable name

type - the property

propertyValue - the property value

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyValue

OperationResult<? extends SparqlElement> addPropertyValue(java.lang.String var,
                                                          TripleElement type,
                                                          java.lang.Object propertyValue,
                                                          boolean optional)

Add a property value declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the property

propertyValue - the property value

optional - true for an optional pattern

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyValue

default OperationResult<? extends SparqlElement> addPropertyValue(java.lang.String var,
                                                                  java.lang.String propertyName,
                                                                  java.lang.Object propertyValue,
                                                                  boolean optional)

Add a property value declaration in the WHERE part of the request.

Parameters:

var - the variable name

propertyName - the property name

propertyValue - the property value

optional - true for an optional construct

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyValues

default OperationResult<Property> addPropertyValues(java.lang.String var,
                                                    java.lang.String propertyName,
                                                    java.util.List<? extends java.lang.Object> values)

Add a property value declaration in the WHERE part of the request, for several values.

Parameters:

var - the variable name

propertyName - the property name

values - the property values

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyValues

default OperationResult<Property> addPropertyValues(java.lang.String var,
                                                    java.lang.String propertyName,
                                                    java.util.List<? extends java.lang.Object> values,
                                                    boolean optional)

Add a property value declaration in the WHERE part of the request, for several values.

Parameters:

var - the variable name

propertyName - the property name

values - the property values

optional - true for an optional construct

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyValues

default OperationResult<Property> addPropertyValues(java.lang.String var,
                                                    java.util.List<? extends java.lang.Object> values)

Add a property value declaration in the WHERE part of the request, for several values.

Parameters:

var - the variable name

values - the property values

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addPropertyValues

OperationResult<Property> addPropertyValues(java.lang.String var,
                                            TripleElement type,
                                            java.util.List<? extends java.lang.Object> values,
                                            boolean optional)

Add a property value declaration in the WHERE part of the request, for several values.

Parameters:

var - the variable name

type - the property

values - the property values

optional - true for an optional pattern

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addSubClassOf

default OperationResult<WhereExpression> addSubClassOf(java.lang.String var,
                                                       java.lang.String type)

Add a rdf:subClassOf matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addSubClassOf

OperationResult<WhereExpression> addSubClassOf(java.lang.String var,
                                               TripleElement type)

Add a rdf:subClassOf matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addLabel

OperationResult<WhereExpression> addLabel(java.lang.String var,
                                          TripleElement element)

Add a rdfs:label matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

element - the element

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addLabel

default OperationResult<WhereExpression> addLabel(java.lang.String var,
                                                  java.lang.String type)

Add a rdfs:label matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addSubClassOfStar

default OperationResult<WhereExpression> addSubClassOfStar(java.lang.String var,
                                                           java.lang.String type)

Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addSubClassOfStar

OperationResult<WhereExpression> addSubClassOfStar(java.lang.String var,
                                                   TripleElement type)

Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addTypeSubClassOf

default OperationResult<WhereExpression> addTypeSubClassOf(java.lang.String var,
                                                           java.lang.String type)

Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addTypeSubClassOf

OperationResult<WhereExpression> addTypeSubClassOf(java.lang.String var,
                                                   TripleElement type)

Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addType

default OperationResult<WhereExpression> addType(java.lang.String var,
                                                 short exprKind,
                                                 java.lang.String type)

Add a matching declaration in the WHERE part of the request. This can be:

• ExpressionTypes.TYPE: a rdf:type expression
• ExpressionTypes.SUBCLASS_OF: a rdfs:subClassOf expression
• ExpressionTypes.SUBCLASS_OF_STAR: a rdfs:subClassOf* expression
• ExpressionTypes.TYPE_SUBCLASS_OF: a rrdf:type/rdfs:subClassOf expression

Parameters:

var - the variable name

exprKind - the expression kind

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addType

OperationResult<WhereExpression> addType(java.lang.String var,
                                         short exprKind,
                                         TripleElement type)

Add a matching declaration in the WHERE part of the request. This can be:

• ExpressionTypes.TYPE: a rdf:type expression
• ExpressionTypes.SUBCLASS_OF: a rdfs:subClassOf expression
• ExpressionTypes.SUBCLASS_OF_STAR: a rdfs:subClassOf* expression
• ExpressionTypes.TYPE_SUBCLASS_OF: a rrdf:type/rdfs:subClassOf expression

Parameters:

var - the variable name

exprKind - the expression kind

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addType

default OperationResult<WhereExpression> addType(java.lang.String var,
                                                 java.lang.String type)

Add a rdf:type matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addType

OperationResult<WhereExpression> addType(java.lang.String var,
                                         TripleElement type)

Add a rdf:type matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addType

OperationResult<WhereExpression> addType(VariableOrIRI varOrIRI,
                                         TripleElement type)

Add a rdf:type matching declaration in the WHERE part of the request.

Parameters:

varOrIRI - the variable or IRI

type - the type

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableSubClassOf

default OperationResult<WhereExpression> addVariableSubClassOf(java.lang.String var,
                                                               java.lang.String typeVar)

Add a rdf:subClassOf matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

typeVar - the type variable

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableSubClassOf

OperationResult<WhereExpression> addVariableSubClassOf(java.lang.String var,
                                                       TripleElement typeVar)

Add a rdf:subClassOf matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

typeVar - the type variable

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableSubClassOfStar

default OperationResult<WhereExpression> addVariableSubClassOfStar(java.lang.String var,
                                                                   java.lang.String typeVar)

Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

typeVar - the type variable

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableSubClassOfStar

OperationResult<WhereExpression> addVariableSubClassOfStar(java.lang.String var,
                                                           TripleElement typeVar)

Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

typeVar - the type variable

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableTypeSubClassOf

default OperationResult<WhereExpression> addVariableTypeSubClassOf(java.lang.String var,
                                                                   java.lang.String typeVar)

Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

typeVar - the type variable

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableTypeSubClassOf

OperationResult<WhereExpression> addVariableTypeSubClassOf(java.lang.String var,
                                                           TripleElement typeVar)

Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

typeVar - the type variable

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableType

default OperationResult<WhereExpression> addVariableType(java.lang.String var,
                                                         short exprKind,
                                                         java.lang.String typeVar)

Add a matching declaration in the WHERE part of the request. This can be:

• ExpressionTypes.TYPE: a rdf:type expression
• ExpressionTypes.SUBCLASS_OF: a rdfs:subClassOf expression
• ExpressionTypes.SUBCLASS_OF_STAR: a rdfs:subClassOf* expression
• ExpressionTypes.SUBCLASS_OF_STAR: a rdf:type/rdfs:subClassOf expression

Parameters:

var - the variable name

exprKind - the expression kind

typeVar - the type variable

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableType

OperationResult<WhereExpression> addVariableType(java.lang.String var,
                                                 short exprKind,
                                                 TripleElement typeVar)

Add a matching declaration in the WHERE part of the request. This can be:

• ExpressionTypes.TYPE: a rdf:type expression
• ExpressionTypes.SUBCLASS_OF: a rdfs:subClassOf expression
• ExpressionTypes.SUBCLASS_OF_STAR: a rdfs:subClassOf* expression
• ExpressionTypes.SUBCLASS_OF_STAR: a rdf:type/rdfs:subClassOf expression

Parameters:

var - the variable name

exprKind - the expression kind

typeVar - the type variable

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableType

default OperationResult<WhereExpression> addVariableType(java.lang.String var,
                                                         java.lang.String typeVar)

Add a rdf:type matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

typeVar - the type variable

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

addVariableType

OperationResult<WhereExpression> addVariableType(java.lang.String var,
                                                 TripleElement element)

Add a rdf:type matching declaration in the WHERE part of the request.

Parameters:

var - the variable name

element - the triple element

Returns:

true if the variable exists (it is specified in the SELECT part or as an additional variable)

checkVariableExistence

boolean checkVariableExistence(java.lang.String var)

Check the existence of a variable.

Parameters:

var - the variable

Returns:

true if the vriable is defined

isLoggingErrors

boolean isLoggingErrors()

Return true if errors should be logged.

Returns:

true if errors should be logged

getAdditionalVars

java.util.Map<java.lang.String,Variable> getAdditionalVars()

Return the additional variables.

Returns:

the additional variables

getOptionals

java.util.List<SparqlRequestGroup> getOptionals()

Return the list of optional groups in this request.

Returns:

the list of optional groups

getSelectMap

java.util.Map<java.lang.String,SelectItem> getSelectMap()

Return the map of SELECT items.

Returns:

the map of SELECT items

removeSelect

default SelectItem removeSelect(java.lang.String varName)

Remove a SELECT item.

Parameters:

varName - the variable name

Returns:

true if the item could be removed

getSelectList

java.util.List<SelectItem> getSelectList()

Return the list of SELECT items.

Returns:

the list of SELECT items

getUnions

java.util.List<Union> getUnions()

Return the list of unions in this request.

Returns:

the list of unions

hasUnions

boolean hasUnions()

Return true if there are unions in this request.

Returns:

true if there are unions in this request

addFilter

Filter addFilter()

Add a FILTER clause.

Returns:

the FILTER clause

addHaving

Filter addHaving()

Add a HAVING clause.

Returns:

the HAVING clause

addBind

Bind addBind()

Add a bind.

Returns:

the bind

addBind

Bind addBind(java.lang.String var)

Add a bind.

Parameters:

var - the variable

Returns:

the bind

addCoalesce

Coalesce addCoalesce()

Add a coalesce.

Returns:

the coalesce

getOffset

int getOffset()

Return the OFFSET of the number of results.

Returns:

the OFFSET declaration

getPrefix

java.lang.String getPrefix(Property property)

Return the prefix of a property.

Parameters:

property - the property

Returns:

the prefix

getPrefix

java.lang.String getPrefix(PropertyRef property)

Return the prefix of a property reference.

Parameters:

property - the property reference

Returns:

the prefix

getDefaultPrefix

java.lang.String getDefaultPrefix()

Return the prefix.

Returns:

the prefix

resetSPARQLResult

void resetSPARQLResult()

Reset the SPARQL result used in serialization.