org.da.sparqlhelper.sparql.model

Class SparqlRequestGroup

java.lang.Object

org.da.sparqlhelper.sparql.model.AbstractSparqlRequest

org.da.sparqlhelper.sparql.model.SparqlRequestGroup

All Implemented Interfaces:

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

Direct Known Subclasses:

SparqlDistance

public class SparqlRequestGroup
extends AbstractSparqlRequest
implements java.io.Serializable

A GROUP construct.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ISparqlRequestGroup	parentRequest The parent request.

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
SparqlRequestGroup(ISparqlRequestGroup parent)

Method Summary

Modifier and Type	Method and Description
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.
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.
OperationResult<WhereExpression>	addLabel(java.lang.String var, TripleElement type) Add a rdfs:label matching 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.
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 WHERE part of the request.
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.
OperationResult<WhereExpression>	addSubClassOf(java.lang.String var, TripleElement type) Add a rdf: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.
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.
OperationResult<WhereExpression>	addVariableSubClassOf(java.lang.String var, TripleElement type) Add a rdf:subClassOf matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addVariableSubClassOfStar(java.lang.String var, TripleElement type) Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addVariableType(java.lang.String var, short exprKind, TripleElement type) Add a matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addVariableType(java.lang.String var, TripleElement type) Add a rdf:type matching declaration in the WHERE part of the request.
OperationResult<WhereExpression>	addVariableTypeSubClassOf(java.lang.String var, TripleElement type) Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.
boolean	checkValidity() Check the validity of the SPARQL expression for the group expression.
java.util.Map<java.lang.String,Variable>	getAdditionalVars() Return the additional variables.
java.lang.String	getDefaultPrefix() Return the default prefix.
WhereForm	getEffectiveWhereForm() Return the WHERE form.
int	getOffset() Return the OFFSET of the number of results.
java.util.List<SparqlRequestGroup>	getOptionals() Return the list of optional groups in this request.
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.util.List<Union>	getUnions() Return the list of unions in this request.
boolean	hasAdditionalVariable(java.lang.String var) Return true if there is an additional variable with a specified name.
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.
void	resetSPARQLResult() Reset the SPARQL result used in serialization.
void	setLevel(int level) Return the level of the request.
void	writeSPARQLImpl(java.lang.StringBuilder buf)
void	writeSPARQLImpl(java.lang.StringBuilder buf, boolean inUnion)
void	writeSPARQLImpl(java.lang.StringBuilder buf, boolean inUnion, boolean includeComments)

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

addAdditionalVariable, addAdditionalVariable, addAsk, addDelete, addInsert, addInsertData, addIRI, addProperty, addVariable, addVariableOrIRI, appendTypeExpression, checkVariableExistence, createAdditionalVariable, createIRI, createVariable, 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, hasAskForm, hasIRI, hasSelectVariable, hasVariable, hasVariableOrIRI, isSelectAll

Methods inherited from class java.lang.Object

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

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

addAutoVariable, addLabel, addProperty, addPropertyIndividualRef, addPropertyIndividualRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValues, addPropertyValues, addPropertyValues, addSubClassOf, addSubClassOfStar, addType, addType, addTypeSubClassOf, addVariableSubClassOf, addVariableSubClassOfStar, addVariableType, addVariableType, addVariableTypeSubClassOf, getAllVariables, hasDeleteForms, hasFilters, hasInsertForms, isFlat, removeSelect

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

indent, indentMore, indentParent

Field Detail

parentRequest

protected ISparqlRequestGroup parentRequest

The parent request.

Constructor Detail

SparqlRequestGroup

public SparqlRequestGroup(ISparqlRequestGroup parent)

Method Detail

setLevel

public void setLevel(int level)

Return the level of the request.

Parameters:

level - the level of the request

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

getUnions

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

Description copied from interface: ISparqlRequestGroup

Return the list of unions in this request.

Specified by:

getUnions in interface ISparqlRequestGroup

Returns:

the list of unions

hasUnions

public boolean hasUnions()

Description copied from interface: ISparqlRequestGroup

Return true if there are unions in this request.

Specified by:

hasUnions in interface ISparqlRequestGroup

Returns:

true if there are unions in this request

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

getDefaultPrefix

public java.lang.String getDefaultPrefix()

Return the default prefix.

Specified by:

getDefaultPrefix in interface ISparqlRequestGroup

Returns:

the prefix

getOffset

public int getOffset()

Return the OFFSET of the number of results.

Specified by:

getOffset in interface ISparqlRequestGroup

Returns:

the OFFSET declaration

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

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

getOptionals

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

Description copied from interface: ISparqlRequestGroup

Return the list of optional groups in this request.

Specified by:

getOptionals in interface ISparqlRequestGroup

Returns:

the list of optional groups

getSelectMap

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

Description copied from interface: ISparqlRequestGroup

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

Description copied from interface: ISparqlRequestGroup

Return the list of SELECT items.

Specified by:

getSelectList in interface ISparqlRequestGroup

Returns:

the list of SELECT items

getEffectiveWhereForm

public WhereForm getEffectiveWhereForm()

Return the WHERE form.

Specified by:

getEffectiveWhereForm in interface ISparqlRequestGroup

Returns:

the WHERE form

getAdditionalVars

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

Return the additional variables.

Specified by:

getAdditionalVars in interface ISparqlRequestGroup

Overrides:

getAdditionalVars in class AbstractSparqlRequest

Returns:

the additional variables

hasAdditionalVariable

public boolean hasAdditionalVariable(java.lang.String var)

Description copied from class: AbstractSparqlRequest

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

Specified by:

hasAdditionalVariable in interface ISparqlRequestGroup

Overrides:

hasAdditionalVariable in class AbstractSparqlRequest

Parameters:

var - the variable name

Returns:

true if there is an additional variable with thr specified name

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

addFilter

public Filter addFilter()

Add a FILTER clause.

Specified by:

addFilter in interface ISparqlRequestGroup

Returns:

the FILTER clause

addHaving

public Filter addHaving()

Add a HAVING clause.

Specified by:

addHaving in interface ISparqlRequestGroup

Returns:

the HAVING 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)

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 a geometry 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)

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)

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 WHERE part of the request.

Specified by:

addPropertyRef in interface ISparqlRequestGroup

Parameters:

varOrIRI - the variable or IRI

type - the type

varOrIRIRef - the variable or IRI 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)

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)

addSubClassOf

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

Add a rdf: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)

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)

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,
                                                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 type)

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

Specified by:

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

addVariableSubClassOfStar

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

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

Specified by:

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

addVariableType

public OperationResult<WhereExpression> addVariableType(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:

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

addVariableTypeSubClassOf

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

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

type - the type

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

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

Specified by:

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

checkValidity

public boolean checkValidity()

Check the validity of the SPARQL expression for the group expression.

Returns:

true if the Sparql request is valid

resetSPARQLResult

public void resetSPARQLResult()

Description copied from interface: ISparqlRequestGroup

Reset the SPARQL result used in serialization.

Specified by:

resetSPARQLResult in interface ISparqlRequestGroup

writeSPARQLImpl

public void writeSPARQLImpl(java.lang.StringBuilder buf)

writeSPARQLImpl

public void writeSPARQLImpl(java.lang.StringBuilder buf,
                            boolean inUnion)

writeSPARQLImpl

public void writeSPARQLImpl(java.lang.StringBuilder buf,
                            boolean inUnion,
                            boolean includeComments)