org.da.sparqlhelper.sparql.model

Interface ISparqlRequest

All Superinterfaces:

DistanceUnits, ExpressionTypes, IndentableElement, ISparqlRequestGroup

All Known Implementing Classes:

InvalidSparqlRequest, SparqlRequest

public interface ISparqlRequest
extends ISparqlRequestGroup

A Sparql request interface.

Since:

0.9.6

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	addDistance(java.lang.String var, java.lang.String fromVar, java.lang.String varDist, short unit, boolean isExact, boolean optional) Add a distance property reference declaration in the WHERE part of the request.
SparqlRequest	addInnerQuery() Add an inner query.
SparqlRequestGroup	addOptionalConstruct() Add an OPTIONAL construct with multiple expressions.
boolean	addSelect(Expression expr, java.lang.String asVar) Add an expression to use for the SELECT part of the Sparql request.
boolean	addSelect(SelectExpression selectExpr) Add an expression to use for the SELECT part of the Sparql request.
boolean	addSelect(java.lang.String... vars) Add several variables to use for the SELECT part of the Sparql request.
boolean	addSelect(java.lang.String var) Add a variable to use for the SELECT part of the Sparql request.
Variable	addSelectVariable(SelectExpression selectExpr) Add a variable for a select expression.
Union	addUnionConstruct() Add an UNION construct with multiple expressions.
boolean	checkValidity() Check the validity of the SPARQL expression.
java.util.List<SparqlRequest>	getInnerQueries() Return the inner queries.
default java.lang.String	getSPARQL() Return the constructed sparql request.
java.lang.String	getSPARQL(boolean includeComments) Return the constructed sparql request.
boolean	hasBinds() Return true if there are binds in the root request of all other children requests.
boolean	hasFilters() Return true if there are filters in the root request of all other children requests.
boolean	hasInnerQueries() Return true if there are inner queries.
boolean	isSelect(java.lang.String var) Return true if a variable is in the SELECT list of variables.
default boolean	isWellFormed() Return true if the request is well-formed.
void	setSelect(java.lang.String... vars) Set the variables to use for the SELECT part of the Sparql request.
boolean	setSelectAll() Set "*" for SELECT all variables.
boolean	variableExists(java.lang.String var) Return true if a variable is defined.

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

addAdditionalVariable, addAdditionalVariable, addAsk, addAutoVariable, addAutoVariable, addBind, addBind, addCoalesce, addDelete, addDistance, addFilter, addGeometry, addHaving, addInsert, addInsertData, addIRI, addLabel, addLabel, addProperty, addProperty, addPropertyIndividualRef, addPropertyIndividualRef, addPropertyIndividualRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValues, addPropertyValues, addPropertyValues, addPropertyValues, addSubClassOf, addSubClassOf, addSubClassOfStar, addSubClassOfStar, addTime, addType, addType, addType, addType, addType, addTypeSubClassOf, addTypeSubClassOf, addVariable, addVariableOrIRI, addVariableSubClassOf, addVariableSubClassOf, addVariableSubClassOfStar, addVariableSubClassOfStar, addVariableType, addVariableType, addVariableType, addVariableType, addVariableTypeSubClassOf, addVariableTypeSubClassOf, checkVariableExistence, createAdditionalVariable, createIRI, createVariable, getAdditionalVars, getAllVariables, getAskForm, getBinds, getCoalesces, getDefaultPrefix, getDeleteForms, getDistances, getEffectiveWhereForm, getFilters, getGeometries, getGraphPatterns, getInsertForms, getIRI, getIRIs, getOffset, getOptionals, getOwlTimes, getPrefix, getPrefix, getPropertyIndRefs, getPropertyRefs, getPropertyValues, getRootRequest, getSelectForm, getSelectList, getSelectMap, getUnions, getVariable, getVariableOrIRI, getVariables, getVariablesIterator, getVariablesOrIRIIterator, getVariableType, getWhereExpressions, getWhereForm, hasAdditionalVariable, hasAskForm, hasDeleteForms, hasInsertForms, hasIRI, hasSelectVariable, hasUnions, hasVariable, hasVariableOrIRI, isCheckingVariablesExistence, isFlat, isLoggingErrors, isSelectAll, removeSelect, resetSPARQLResult

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

getLevel, indent, indentMore, indentParent

Method Detail

isWellFormed

default boolean isWellFormed()

Return true if the request is well-formed. Return true by default.

Returns:

true if the request is well-formed

hasBinds

boolean hasBinds()

Return true if there are binds in the root request of all other children requests.

Returns:

true if there are binds in the root request of all other children requests

hasFilters

boolean hasFilters()

Return true if there are filters in the root request of all other children requests.

Specified by:

hasFilters in interface ISparqlRequestGroup

Returns:

true if there are filters in the root request of all other children requests

isSelect

boolean isSelect(java.lang.String var)

Return true if a variable is in the SELECT list of variables.

Parameters:

var - the variable name

Returns:

true if the variable is in the SELECT list of variables

setSelectAll

boolean setSelectAll()

Set "*" for SELECT all variables.

Returns:

false if there where already variables in the select

setSelect

void setSelect(java.lang.String... vars)

Set the variables to use for the SELECT part of the Sparql request. Note that it will unset the ISparqlRequestGroup.isSelectAll() property.

Parameters:

vars - the variables

addSelect

boolean addSelect(java.lang.String... vars)

Add several variables to use for the SELECT part of the Sparql request.

Parameters:

vars - the variables

Returns:

true if all the variables could be added

addSelect

boolean addSelect(Expression expr,
                  java.lang.String asVar)

Add an expression to use for the SELECT part of the Sparql request.

Parameters:

expr - the expression

asVar - the AS variable

Returns:

true if the variable could be added

addSelect

boolean addSelect(SelectExpression selectExpr)

Add an expression to use for the SELECT part of the Sparql request.

Parameters:

selectExpr - the select expression

Returns:

true if the expression could be added

addSelect

boolean addSelect(java.lang.String var)

Add a variable to use for the SELECT part of the Sparql request.

Parameters:

var - the variable

Returns:

true if the variable could be added

addSelectVariable

Variable addSelectVariable(SelectExpression selectExpr)

Add a variable for a select expression.

Parameters:

selectExpr - the select expression

Returns:

true if there is not variable for the select expression or the variable can be added

addDistance

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

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

Parameters:

var - the variable name

fromVar - the other element variable name

varDist - the distance variable name

unit - the distance unit

isExact - the name for an exact geometry

optional - true for an optional pattern

Returns:

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

addOptionalConstruct

SparqlRequestGroup addOptionalConstruct()

Add an OPTIONAL construct with multiple expressions.

Returns:

the OPTIONAL construct

addUnionConstruct

Union addUnionConstruct()

Add an UNION construct with multiple expressions.

Returns:

the UNION construct

variableExists

boolean variableExists(java.lang.String var)

Return true if a variable is defined.

Parameters:

var - the variable name

Returns:

true if the variable is defined

addInnerQuery

SparqlRequest addInnerQuery()

Add an inner query.

Returns:

the query

getInnerQueries

java.util.List<SparqlRequest> getInnerQueries()

Return the inner queries.

Returns:

the queries

hasInnerQueries

boolean hasInnerQueries()

Return true if there are inner queries.

Returns:

true if there are inner queries

checkValidity

boolean checkValidity()

Check the validity of the SPARQL expression. This can be called before generating it.

Returns:

true if the Sparql request is valid

getSPARQL

default java.lang.String getSPARQL()

Return the constructed sparql request. The comments will not be included in the serialization.

Returns:

the request

getSPARQL

java.lang.String getSPARQL(boolean includeComments)

Return the constructed sparql request.

Parameters:

includeComments - true if the comments should be included in the serialization

Returns:

the request