org.da.sparqlhelper.sparql.model

Class SparqlRequest

java.lang.Object

org.da.sparqlhelper.sparql.model.AbstractSparqlRequest

org.da.sparqlhelper.sparql.model.SparqlRequest

All Implemented Interfaces:

java.io.Serializable, DistanceUnits, ExpressionTypes, IndentableElement, ISparqlRequest, ISparqlRequestGroup

Direct Known Subclasses:

InvalidSparqlRequest

public class SparqlRequest
extends AbstractSparqlRequest
implements ISparqlRequest, java.io.Serializable

This class allows to create a SPARQL request. It contains the model of a SPARQL query.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.da.sparqlhelper.sparql.model.AbstractSparqlRequest

additionalVars, askForm, binds, coalesces, deleteForms, insertForms, iris, level, selectForm, variables, whereForm

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

Constructor Summary

Constructors

Constructor and Description
SparqlRequest(SparqlRequest parent) Constructor.
SparqlRequest(java.lang.String prefix) Constructor.
SparqlRequest(java.lang.String prefix, boolean checkVarsExistence) Constructor.
SparqlRequest(java.lang.String prefix, boolean checkVarsExistence, char prefixInclusionType) Constructor.
SparqlRequest(java.lang.String prefix, boolean checkVarsExistence, SparqlPrefixDeclarations prefixDecl) Constructor.
SparqlRequest(java.lang.String prefix, char prefixInclusionType) Constructor.
SparqlRequest(java.lang.String prefix, SparqlPrefixDeclarations prefixDecl) Constructor.Variables existence check will be performed.

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.
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.
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.
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.
Filter	addFilter() Add a FILTER clause.
boolean	addGeometry(java.lang.String var, java.lang.String varLat, java.lang.String varLon, boolean isExact) Add an object property reference declaration in the WHERE part of the request.
boolean	addGeometry(java.lang.String var, java.lang.String varLat, java.lang.String varLon, boolean isExact, boolean optional) Add a geometry declaration in the WHERE part of the request.
Filter	addHaving() Add a FILTER clause.
SparqlRequest	addInnerQuery() Add an inner query.
OperationResult<WhereExpression>	addLabel(java.lang.String var, TripleElement type) Add a rdfs:label matching declaration in the WHERE part of the request.
SparqlRequestGroup	addOptionalConstruct() Add an OPTIONAL construct with multiple expressions.
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.
OperationResult<PropertyRef>	addPropertyRef(java.lang.String var, TripleElement type, java.lang.String varRef, boolean optional) Add an object property reference declaration in the WHERE part of the request.
OperationResult<PropertyRef>	addPropertyRef(VariableOrIRI varOrIRI, TripleElement type, VariableOrIRI varOrIRIRef, boolean optional) Add an object property reference 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.
OperationResult<Property>	addPropertyValues(java.lang.String var, TripleElement type, java.util.List<? extends java.lang.Object> propValues, boolean optional) Add a property value declaration in the WHERE part of the request, for several values.
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.
OperationResult<WhereExpression>	addSubClassOf(java.lang.String var, TripleElement 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.
boolean	addTime(java.lang.String var, java.lang.String varTime, boolean isDateTime, boolean optional) Add a time 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.
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.
OperationResult<WhereExpression>	addTypeSubClassOf(java.lang.String var, TripleElement type) Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.
Union	addUnionConstruct() Add an UNION construct with multiple expressions.
OperationResult<WhereExpression>	addVariableSubClassOf(java.lang.String var, TripleElement 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.
OperationResult<WhereExpression>	addVariableType(java.lang.String var, short exprKind, TripleElement typeVar) Add a 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.
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	checkValidity() Check the validity of the SPARQL expression.
static SparqlRequest	createRequest(java.lang.String prefix, java.lang.String requestAsString)
static java.util.List<? extends java.lang.Object>	createValuesList(java.lang.Object... values) Creates a list of values.
Variable	createVariable(java.lang.String name) Create a variable with a specified name.
boolean	existsVariable(java.lang.String varName) Return true if a variable exists.
java.lang.String	getDefaultPrefix() Return the default prefix.
WhereForm	getEffectiveWhereForm() Return the effective WHERE form.
java.util.List<java.lang.String>	getGroupBy() Return the GROUP BY declaration.
java.util.List<SparqlRequest>	getInnerQueries() Return the inner queries.
int	getLimit() Return the LIMIT of the number of results.
int	getOffset() Return the OFFSET of the number of results.
java.util.List<SparqlRequestGroup>	getOptionals() Return the list of optional groups in this request.
Expression	getOrderBy() Return the limit of the number of results.
char	getOrderByType() Return the ORDER BY type.
Variable	getPreferredVariable() Return the preferred variable.
java.lang.String	getPreferredVariableName() Return the preferred variable name.
SparqlPrefixDeclarations	getPrefixDeclarations() Return the prefix declarations.
SparqlRequest	getRootRequest() Return the top level request.
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.lang.String	getSPARQL(boolean includeComments) Return the constructed sparql request.
java.util.List<Union>	getUnions() Return the list of unions in this 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	hasSelectVariable(java.lang.String var) Return true if a variable is added in the SELECT.
boolean	hasUnions() Return true if there are unions in this request.
boolean	isCheckingVariablesExistence() Return true if the variables existence if checked during the creation of the request.
boolean	isLoggingErrors() Return true if errors should be logged by the framework.
boolean	isSelect(java.lang.String var) Return true if a variable is in the SELECT list of variables.
boolean	isSelectAll() Return true if SELECT * is set.
boolean	isSelectDistinct() Return true if the SELECT expression should be SELECT DISTINCT.
void	logErrors(boolean logErrors) Set if errors should be logged by the framework.
void	resetSPARQLResult() Reset the SPARQL result used in serialization.
void	selectDistinct(boolean selectDistinct) Set if the SELECT expression should be SELECT DISTINCT.
void	setGroupBy(java.util.List<java.lang.String> groupBy) Set the GROUP BY declaration.
void	setGroupBy(java.lang.String... groupBy) Set the GROUP BY declaration.
void	setLimit(int limit) Set the limit of the number of results.
void	setOffset(int offset) Set the OFFSET of the number of results.
void	setOrderBy(Expression orderBy) Set the ORDER BY declaration.
void	setOrderBy(Expression orderBy, boolean isAscending) Set the ORDER BY declaration.
void	setOrderBy(Expression orderBy, char orderByType) Set the ORDER BY declaration.
void	setOrderBy(java.lang.String orderBy) Set the ORDER BY declaration.
void	setOrderBy(java.lang.String orderBy, boolean isAscending) Set the ORDER BY declaration.
void	setOrderBy(java.lang.String orderBy, char orderByType) Set the ORDER BY declaration.
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.
java.lang.String	toString()
boolean	variableExists(java.lang.String var) Return true if a variable is defined.

Methods inherited from class org.da.sparqlhelper.sparql.model.AbstractSparqlRequest

addAsk, addDelete, addInsert, addInsertData, addIRI, addProperty, addVariable, addVariableOrIRI, appendTypeExpression, checkVariableExistence, createAdditionalVariable, createIRI, getAdditionalVars, getAskForm, getBinds, getCoalesces, getDeleteForms, getDistances, getFilters, getGeometries, getGraphPatterns, getInsertForms, getIRI, getIRIs, getLastInsertForm, getLevel, getOwlTimes, getPrefix, getPrefix, getPropertyIndRefs, getPropertyRefs, getPropertyValues, getSelectForm, getVariable, getVariableOrIRI, getVariables, getVariablesIterator, getVariablesOrIRIIterator, getVariableType, getWhereExpressions, getWhereForm, hasAdditionalVariable, hasAskForm, hasIRI, hasVariable, hasVariableOrIRI

Methods inherited from class java.lang.Object

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

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

getSPARQL, isWellFormed

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

addAsk, addAutoVariable, addDelete, addInsert, addInsertData, addIRI, addLabel, addProperty, addProperty, addPropertyIndividualRef, addPropertyIndividualRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValues, addPropertyValues, addPropertyValues, addSubClassOf, addSubClassOfStar, addType, addType, addTypeSubClassOf, addVariable, addVariableOrIRI, addVariableSubClassOf, addVariableSubClassOfStar, addVariableType, addVariableType, addVariableTypeSubClassOf, checkVariableExistence, createAdditionalVariable, createIRI, getAdditionalVars, getAllVariables, getAskForm, getBinds, getCoalesces, getDeleteForms, getDistances, getFilters, getGeometries, getGraphPatterns, getInsertForms, getIRI, getIRIs, getOwlTimes, getPrefix, getPrefix, getPropertyIndRefs, getPropertyRefs, getPropertyValues, getSelectForm, getVariable, getVariableOrIRI, getVariables, getVariablesIterator, getVariablesOrIRIIterator, getVariableType, getWhereExpressions, getWhereForm, hasAdditionalVariable, hasAskForm, hasDeleteForms, hasInsertForms, hasIRI, hasVariable, hasVariableOrIRI, isFlat, removeSelect

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

getLevel, indent, indentMore, indentParent

Constructor Detail

SparqlRequest

public SparqlRequest(SparqlRequest parent)

Constructor.

Parameters:

parent - the parent request

SparqlRequest

public SparqlRequest(java.lang.String prefix,
                     char prefixInclusionType)

Constructor.

Parameters:

prefix - the default prefix

prefixInclusionType - specify how the prefix must be added

SparqlRequest

public SparqlRequest(java.lang.String prefix,
                     boolean checkVarsExistence,
                     char prefixInclusionType)

Constructor.

Parameters:

prefix - the default prefix

checkVarsExistence - true if variables existence will be checked to allow adding relations for these variables. If false, no check will be performed.

prefixInclusionType - specify how the prefix must be added

SparqlRequest

public SparqlRequest(java.lang.String prefix,
                     boolean checkVarsExistence,
                     SparqlPrefixDeclarations prefixDecl)

Constructor.

Parameters:

prefix - the default prefix

checkVarsExistence - true if variables existence will be checked to allow adding relations for these variables. If false, no check will be performed.

prefixDecl - the prefix declarations

SparqlRequest

public SparqlRequest(java.lang.String prefix,
                     boolean checkVarsExistence)

Constructor.

Parameters:

prefix - the default prefix

checkVarsExistence - true if variables existence will be checked to allow adding relations for these variables. If false, no check will be performed.

SparqlRequest

public SparqlRequest(java.lang.String prefix)

Constructor. Variables existence check will be performed.

Parameters:

prefix - the default prefix

SparqlRequest

public SparqlRequest(java.lang.String prefix,
                     SparqlPrefixDeclarations prefixDecl)

Constructor.Variables existence check will be performed.

Parameters:

prefix - the default prefix

prefixDecl - the prefix declarations

Method Detail

hasFilters

public boolean hasFilters()

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

Specified by:

hasFilters in interface ISparqlRequest

Specified by:

hasFilters in interface ISparqlRequestGroup

Returns:

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

hasBinds

public boolean hasBinds()

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

Specified by:

hasBinds in interface ISparqlRequest

Returns:

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

createRequest

public static SparqlRequest createRequest(java.lang.String prefix,
                                          java.lang.String requestAsString)

getRootRequest

public SparqlRequest getRootRequest()

Description copied from interface: ISparqlRequestGroup

Return the top level request.

Specified by:

getRootRequest in interface ISparqlRequestGroup

Returns:

the top level request

getEffectiveWhereForm

public WhereForm getEffectiveWhereForm()

Return the effective WHERE form.

Specified by:

getEffectiveWhereForm in interface ISparqlRequestGroup

Returns:

the effective WHERE form

getPrefixDeclarations

public SparqlPrefixDeclarations getPrefixDeclarations()

Return the prefix declarations.

Returns:

the prefix declarations

logErrors

public void logErrors(boolean logErrors)

Set if errors should be logged by the framework.

Parameters:

logErrors - true if errors should be logged by the framework

isLoggingErrors

public boolean isLoggingErrors()

Return true if errors should be logged by the framework.

Specified by:

isLoggingErrors in interface ISparqlRequestGroup

Returns:

true if errors should be logged by the framework

isCheckingVariablesExistence

public boolean isCheckingVariablesExistence()

Return true if the variables existence if checked during the creation of the request. If false, no existence check will be performed but you will still be able to use the checkValidity() before the generation.

Specified by:

isCheckingVariablesExistence in interface ISparqlRequestGroup

Returns:

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

existsVariable

public boolean existsVariable(java.lang.String varName)

Return true if a variable exists.

Parameters:

varName - the variable name

Returns:

true if the variable exists

getSelectMap

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

Return the map of SELECT items.

Specified by:

getSelectMap in interface ISparqlRequestGroup

Returns:

the map of SELECT items

getSelectList

public java.util.List<SelectItem> getSelectList()

Return the list of SELECT items.

Specified by:

getSelectList in interface ISparqlRequestGroup

Returns:

the list of SELECT items

getDefaultPrefix

public java.lang.String getDefaultPrefix()

Return the default prefix.

Specified by:

getDefaultPrefix in interface ISparqlRequestGroup

Returns:

the prefix

setLimit

public void setLimit(int limit)

Set the limit of the number of results.

Parameters:

limit - the limit of the number of results

getLimit

public int getLimit()

Return the LIMIT of the number of results.

Returns:

the LIMIT of the number of results

setOffset

public void setOffset(int offset)

Set the OFFSET of the number of results.

Parameters:

offset - the OFFSET of the number of results

getOffset

public int getOffset()

Return the OFFSET of the number of results.

Specified by:

getOffset in interface ISparqlRequestGroup

Returns:

the OFFSET declaration

setOrderBy

public void setOrderBy(java.lang.String orderBy)

Set the ORDER BY declaration.

Parameters:

orderBy - the ORDER BY declaration

setOrderBy

public void setOrderBy(java.lang.String orderBy,
                       boolean isAscending)

Set the ORDER BY declaration.

Parameters:

orderBy - the ORDER BY declaration

isAscending - true if the ORDER BY declaration is ascending

setOrderBy

public void setOrderBy(java.lang.String orderBy,
                       char orderByType)

Set the ORDER BY declaration.

Parameters:

orderBy - the ORDER BY declaration

orderByType - the type for the ORDER By DECLARATION

setOrderBy

public void setOrderBy(Expression orderBy)

Set the ORDER BY declaration.

Parameters:

orderBy - the ORDER BY declaration

setOrderBy

public void setOrderBy(Expression orderBy,
                       char orderByType)

Set the ORDER BY declaration.

Parameters:

orderBy - the ORDER BY declaration

orderByType - the type for the ORDER By DECLARATION

setOrderBy

public void setOrderBy(Expression orderBy,
                       boolean isAscending)

Set the ORDER BY declaration.

Parameters:

orderBy - the ORDER BY declaration

isAscending - true if the ORDER BY declaration is ascending

getOrderBy

public Expression getOrderBy()

Return the limit of the number of results.

Returns:

the ORDER BY declaration

getPreferredVariableName

public java.lang.String getPreferredVariableName()

Return the preferred variable name.

Returns:

the the preferred variable name

See Also:

getPreferredVariable()

getPreferredVariable

public Variable getPreferredVariable()

Return the preferred variable. It will be the variable specified in the ORDER By construct if there is one ORDER BY on a variable, and this variable is in the SELECT form else it will be the first variable in the SELECT form. Note that it can return null.

Returns:

the the preferred variable

setGroupBy

public void setGroupBy(java.lang.String... groupBy)

Set the GROUP BY declaration.

Parameters:

groupBy - the groupBy variables declaration

setGroupBy

public void setGroupBy(java.util.List<java.lang.String> groupBy)

Set the GROUP BY declaration.

Parameters:

groupBy - the groupBy variables declaration

getGroupBy

public java.util.List<java.lang.String> getGroupBy()

Return the GROUP BY declaration.

Returns:

the groupBy variables declaration

getOrderByType

public char getOrderByType()

Return the ORDER BY type.

Returns:

the ORDER BY type

selectDistinct

public void selectDistinct(boolean selectDistinct)

Set if the SELECT expression should be SELECT DISTINCT.

Parameters:

selectDistinct - true for SELECT DISTINCT

isSelectDistinct

public boolean isSelectDistinct()

Return true if the SELECT expression should be SELECT DISTINCT.

Returns:

true if the SELECT expression should be SELECT DISTINCT

getSPARQL

public java.lang.String getSPARQL(boolean includeComments)

Return the constructed sparql request.

Specified by:

getSPARQL in interface ISparqlRequest

Parameters:

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

Returns:

the request

checkValidity

public boolean checkValidity()

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

Specified by:

checkValidity in interface ISparqlRequest

Returns:

true if the Sparql request is valid

isSelect

public boolean isSelect(java.lang.String var)

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

Specified by:

isSelect in interface ISparqlRequest

Parameters:

var - the variable name

Returns:

true if the variable is in the SELECT list of variables

variableExists

public boolean variableExists(java.lang.String var)

Return true if a variable is defined.

Specified by:

variableExists in interface ISparqlRequest

Parameters:

var - the variable name

Returns:

true if the variable is defined

createValuesList

public static java.util.List<? extends java.lang.Object> createValuesList(java.lang.Object... values)

Creates a list of values.

Parameters:

values - the values array

Returns:

the list of values

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addInnerQuery

public SparqlRequest addInnerQuery()

Add an inner query.

Specified by:

addInnerQuery in interface ISparqlRequest

Returns:

the query

getInnerQueries

public java.util.List<SparqlRequest> getInnerQueries()

Return the inner queries.

Specified by:

getInnerQueries in interface ISparqlRequest

Returns:

the queries

hasInnerQueries

public boolean hasInnerQueries()

Return true if there are inner queries.

Specified by:

hasInnerQueries in interface ISparqlRequest

Returns:

true if there are inner queries

isSelectAll

public boolean isSelectAll()

Return true if SELECT * is set.

Specified by:

isSelectAll in interface ISparqlRequestGroup

Overrides:

isSelectAll in class AbstractSparqlRequest

Returns:

true if SELECT * is set

hasSelectVariable

public boolean hasSelectVariable(java.lang.String var)

Return true if a variable is added in the SELECT.

Specified by:

hasSelectVariable in interface ISparqlRequestGroup

Overrides:

hasSelectVariable in class AbstractSparqlRequest

Parameters:

var - the variable name

Returns:

true if the variable is added in the SELECT

setSelectAll

public boolean setSelectAll()

Set "*" for SELECT all variables.

Specified by:

setSelectAll in interface ISparqlRequest

Returns:

false if there where already variables in the select

setSelect

public 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 isSelectAll() property.

Specified by:

setSelect in interface ISparqlRequest

Parameters:

vars - the variables

addSelect

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

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

Specified by:

addSelect in interface ISparqlRequest

Parameters:

vars - the variables

Returns:

true if all the variables could be added

addSelect

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

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

Specified by:

addSelect in interface ISparqlRequest

Parameters:

expr - the expression

asVar - the AS variable

Returns:

true if the variable could be added

addSelect

public boolean addSelect(SelectExpression selectExpr)

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

Specified by:

addSelect in interface ISparqlRequest

Parameters:

selectExpr - the select expression

Returns:

true if the expression could be added

addSelect

public boolean addSelect(java.lang.String var)

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

Specified by:

addSelect in interface ISparqlRequest

Parameters:

var - the variable

Returns:

true if the variable could be added

addAutoVariable

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

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

Specified by:

addAutoVariable in interface ISparqlRequestGroup

Parameters:

radix - the variable radix

Returns:

the variable name

createVariable

public 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.

Specified by:

createVariable in interface ISparqlRequestGroup

Overrides:

createVariable in class AbstractSparqlRequest

Parameters:

name - the variable name

Returns:

the variable

addSelectVariable

public Variable addSelectVariable(SelectExpression selectExpr)

Add a variable for a select expression.

Specified by:

addSelectVariable in interface ISparqlRequest

Parameters:

selectExpr - the select expression

Returns:

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

addAdditionalVariable

public boolean addAdditionalVariable(Variable var)

Add an additional variable in the query.

Specified by:

addAdditionalVariable in interface ISparqlRequestGroup

Overrides:

addAdditionalVariable in class AbstractSparqlRequest

Parameters:

var - the variable

Returns:

true if the variable could be added

addAdditionalVariable

public boolean addAdditionalVariable(java.lang.String varName)

Add an additional variable in the query.

Specified by:

addAdditionalVariable in interface ISparqlRequestGroup

Overrides:

addAdditionalVariable in class AbstractSparqlRequest

Parameters:

varName - the variable name

Returns:

true if the variable could be added

addSubClassOf

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

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

Specified by:

addSubClassOf in interface ISparqlRequestGroup

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

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

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

Specified by:

addLabel in interface ISparqlRequestGroup

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

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

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

Specified by:

addSubClassOfStar in interface ISparqlRequestGroup

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

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

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

Specified by:

addTypeSubClassOf in interface ISparqlRequestGroup

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

public 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 rdf:type/rdfs:subClassOf expression

Specified by:

addType in interface ISparqlRequestGroup

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

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

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

Specified by:

addType in interface ISparqlRequestGroup

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

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

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

Specified by:

addType in interface ISparqlRequestGroup

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

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

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

Specified by:

addVariableSubClassOf in interface ISparqlRequestGroup

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

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

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

Specified by:

addVariableSubClassOfStar in interface ISparqlRequestGroup

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

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

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

Specified by:

addVariableTypeSubClassOf in interface ISparqlRequestGroup

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

public 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.TYPE_SUBCLASS_OF: a rdf:type/rdfs:subClassOf expression

Specified by:

addVariableType in interface ISparqlRequestGroup

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

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

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

Specified by:

addVariableType in interface ISparqlRequestGroup

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)

addPropertyValue

public 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.

Specified by:

addPropertyValue in interface ISparqlRequestGroup

Parameters:

var - the variable name

type - the type

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)

addPropertyValues

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

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

Specified by:

addPropertyValues in interface ISparqlRequestGroup

Parameters:

var - the variable name

type - the type

propValues - 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)

addFilter

public Filter addFilter()

Add a FILTER clause.

Specified by:

addFilter in interface ISparqlRequestGroup

Returns:

the FILTER clause

addHaving

public Filter addHaving()

Add a FILTER clause.

Specified by:

addHaving in interface ISparqlRequestGroup

Returns:

the FILTER clause

addBind

public Bind addBind()

Add a bind.

Specified by:

addBind in interface ISparqlRequestGroup

Returns:

the bind

addBind

public Bind addBind(java.lang.String var)

Add a bind.

Specified by:

addBind in interface ISparqlRequestGroup

Parameters:

var - the variable

Returns:

the bind

addCoalesce

public Coalesce addCoalesce()

Add a coalesce.

Specified by:

addCoalesce in interface ISparqlRequestGroup

Returns:

the coalesce

addTime

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

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

optional - true for an optional pattern

Returns:

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

addTime

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

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

Specified by:

addTime in interface ISparqlRequestGroup

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)

addGeometry

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

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

Specified by:

addGeometry in interface ISparqlRequestGroup

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)

addGeometry

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

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

optional - true for an optional pattern

Returns:

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

addDistance

public 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.

Specified by:

addDistance in interface ISparqlRequestGroup

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

Returns:

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

addDistance

public 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.

Specified by:

addDistance in interface ISparqlRequest

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)

addPropertyRef

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

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

Specified by:

addPropertyRef in interface ISparqlRequestGroup

Parameters:

var - the variable name

type - the type

varRef - the variable to use for the reference

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

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

Add an object property reference declaration in the OPTIONAL construct.

Specified by:

addPropertyRef in interface ISparqlRequestGroup

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)

addPropertyIndividualRef

public 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.

Specified by:

addPropertyIndividualRef in interface ISparqlRequestGroup

Parameters:

var - the variable name

type - the type

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)

addOptionalConstruct

public SparqlRequestGroup addOptionalConstruct()

Add an OPTIONAL construct with multiple expressions.

Specified by:

addOptionalConstruct in interface ISparqlRequest

Returns:

the OPTIONAL construct

getOptionals

public java.util.List<SparqlRequestGroup> getOptionals()

Return the list of optional groups in this request.

Specified by:

getOptionals in interface ISparqlRequestGroup

Returns:

the list of optional groups

addUnionConstruct

public Union addUnionConstruct()

Add an UNION construct with multiple expressions.

Specified by:

addUnionConstruct in interface ISparqlRequest

Returns:

the UNION construct

getUnions

public java.util.List<Union> getUnions()

Return the list of unions in this request.

Specified by:

getUnions in interface ISparqlRequestGroup

Returns:

the list of unions

hasUnions

public boolean hasUnions()

Return true if there are unions in this request.

Specified by:

hasUnions in interface ISparqlRequestGroup

Returns:

true if there are unions in this request

resetSPARQLResult

public void resetSPARQLResult()

Reset the SPARQL result used in serialization.

Specified by:

resetSPARQLResult in interface ISparqlRequestGroup