AbstractSparqlRequest (sparqlHelper)

java.lang.Object
- org.da.sparqlhelper.sparql.model.AbstractSparqlRequest

All Implemented Interfaces:

DistanceUnits, ExpressionTypes, ISparqlRequestGroup

Direct Known Subclasses:

SparqlRequest, SparqlRequestGroup
```
public abstract class AbstractSparqlRequest
extends java.lang.Object
implements ISparqlRequestGroup
```
An abstract SPARQL request.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,Variable>`	`additionalVars`
`protected AskForm`	`askForm`
`protected java.util.List<Bind>`	`binds`
`protected java.util.List<Coalesce>`	`coalesces`
`protected java.util.List<DeleteForm>`	`deleteForms`
`protected java.util.List<Filter>`	`filters`
`protected java.util.List<InsertForm>`	`insertForms`
`protected java.util.Map<java.lang.String,IRI>`	`iris`
`protected SelectForm`	`selectForm`
`protected java.util.Map<java.lang.String,Variable>`	`variables`
`protected WhereForm`	`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

AbstractSparqlRequest()

Constructors
Constructor and Description
`AbstractSparqlRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`DeleteForm`	`addDelete()` Add a DELETE form.
`InsertForm`	`addInsert()` Add an INSERT form.
`InsertForm`	`addInsertData()` Add an INSERT DATA form.
`boolean`	`addIRI(IRI iri)` Add an IRI.
`boolean`	`addProperty(TripleElement object, TripleElement property, TripleElement target, boolean optional)` Add an object property reference declaration in the OPTIONAL construct.
`boolean`	`addVariable(Variable var)` Add a variable.
`boolean`	`addVariableOrIRI(VariableOrIRI varOrIRI)` Add a variable or IRI.
`protected void`	`appendTypeExpression(java.lang.StringBuilder buf, Variable elt, WhereExpression type)` Append a type expression.
`boolean`	`checkVariableExistence(java.lang.String varName)` 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.
`AskForm`	`getAskForm()` Return the ASK form.
`java.util.List<Bind>`	`getBinds()` Return the bindings.
`java.util.List<Coalesce>`	`getCoalesces()` Return the coalesce expressions.
`java.util.List<DeleteForm>`	`getDeleteForms()` Return the DELETE forms.
`java.util.Map<java.lang.String,SparqlDistance>`	`getDistances()` Return the geosparql distances.
`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.
`InsertForm`	`getLastInsertForm()` Return the last INSERT form.
`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.
`SelectForm`	`getSelectForm()` Return the SELECT form.
`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.
`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`	`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`	`isSelectAll()` Return true if the request is a SELECT ALL (*).

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, addAutoVariable, addBind, addBind, addCoalesce, addDistance, addFilter, addGeometry, addLabel, addLabel, 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, addVariableSubClassOf, addVariableSubClassOf, addVariableSubClassOfStar, addVariableSubClassOfStar, addVariableType, addVariableType, addVariableType, addVariableType, addVariableTypeSubClassOf, addVariableTypeSubClassOf, getAllVariables, getDefaultPrefix, getEffectiveWhereForm, getOffset, getOptionals, getRootRequest, getSelectList, getSelectMap, getUnions, hasDeleteForms, hasInsertForms, hasUnions, isCheckingVariablesExistence, isLoggingErrors, removeSelect, resetSPARQLResult

- Field Detail
  - selectForm
```
protected final SelectForm selectForm
```
  - whereForm
```
protected WhereForm whereForm
```
  - deleteForms
```
protected final java.util.List<DeleteForm> deleteForms
```
  - insertForms
```
protected final java.util.List<InsertForm> insertForms
```
  - askForm
```
protected AskForm askForm
```
  - filters
```
protected final java.util.List<Filter> filters
```
  - binds
```
protected final java.util.List<Bind> binds
```
  - coalesces
```
protected final java.util.List<Coalesce> coalesces
```
  - variables
```
protected final java.util.Map<java.lang.String,Variable> variables
```
  - additionalVars
```
protected final java.util.Map<java.lang.String,Variable> additionalVars
```
  - iris
```
protected final java.util.Map<java.lang.String,IRI> iris
```
- Constructor Detail
  - AbstractSparqlRequest
```
public AbstractSparqlRequest()
```
- Method Detail
  - addVariable
```
public boolean addVariable(Variable var)
```
    Add a variable.
    
    Specified by:
    
    addVariable in interface ISparqlRequestGroup
    
    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
    
    Parameters:
    
    varName - the variable name
    
    Returns:
    
    true if the variable could be added
  - addAdditionalVariable
```
public boolean addAdditionalVariable(Variable var)
```
    Add an additional variable in the query.
    
    Specified by:
    
    addAdditionalVariable in interface ISparqlRequestGroup
    
    Parameters:
    
    var - the variable
    
    Returns:
    
    true if the variable could be added
  - getAdditionalVars
```
public java.util.Map<java.lang.String,Variable> getAdditionalVars()
```
    Return the additional variables.
    
    Specified by:
    
    getAdditionalVars in interface ISparqlRequestGroup
    
    Returns:
    
    the additional variables
  - hasAdditionalVariable
```
public boolean hasAdditionalVariable(java.lang.String var)
```
    Return true if there is an additional variable with a specified name.
    
    Specified by:
    
    hasAdditionalVariable in interface ISparqlRequestGroup
    
    Parameters:
    
    var - the variable name
    
    Returns:
    
    true if there is an additional variable with thr specified 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
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the variable
  - createAdditionalVariable
```
public 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.
    
    Specified by:
    
    createAdditionalVariable in interface ISparqlRequestGroup
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the variable
  - getVariable
```
public Variable getVariable(java.lang.String name)
```
    Return the variable with a specified name.
    
    Specified by:
    
    getVariable in interface ISparqlRequestGroup
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the variable
  - getVariableType
```
public char getVariableType(java.lang.String name)
```
    Return the type of a variable.
    
    Specified by:
    
    getVariableType in interface ISparqlRequestGroup
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    the type
    
    See Also:
    
    VariableType
  - hasVariable
```
public boolean hasVariable(java.lang.String name)
```
    Return true if there is a variable with a specified name.
    
    Specified by:
    
    hasVariable in interface ISparqlRequestGroup
    
    Parameters:
    
    name - the variable name
    
    Returns:
    
    true if there is a variable with the specified name
  - getVariables
```
public java.util.Map<java.lang.String,Variable> getVariables()
```
    Return the map of variables.
    
    Specified by:
    
    getVariables in interface ISparqlRequestGroup
    
    Returns:
    
    the map of variables
  - addIRI
```
public boolean addIRI(IRI iri)
```
    Add an IRI.
    
    Specified by:
    
    addIRI in interface ISparqlRequestGroup
    
    Parameters:
    
    iri - the IRI
    
    Returns:
    
    true if the IRI could be added
  - createIRI
```
public 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.
    
    Specified by:
    
    createIRI in interface ISparqlRequestGroup
    
    Parameters:
    
    name - the IRI name
    
    Returns:
    
    the IRI
  - getIRI
```
public IRI getIRI(java.lang.String name)
```
    Return the IRI with a specified name.
    
    Specified by:
    
    getIRI in interface ISparqlRequestGroup
    
    Parameters:
    
    name - the IRI name
    
    Returns:
    
    the IRI
  - hasIRI
```
public boolean hasIRI(java.lang.String name)
```
    Return true if there is an IRI with a specified name.
    
    Specified by:
    
    hasIRI in interface ISparqlRequestGroup
    
    Parameters:
    
    name - the IRI name
    
    Returns:
    
    true if there is an IRI with the specified name
  - getIRIs
```
public java.util.Map<java.lang.String,IRI> getIRIs()
```
    Return the map of IRIs.
    
    Specified by:
    
    getIRIs in interface ISparqlRequestGroup
    
    Returns:
    
    the map of IRIs
  - getVariableOrIRI
```
public VariableOrIRI getVariableOrIRI(java.lang.String name)
```
    Return the variable or IRI with a specified name.
    
    Specified by:
    
    getVariableOrIRI in interface ISparqlRequestGroup
    
    Parameters:
    
    name - the variable or IRI name
    
    Returns:
    
    the variable or IRI
  - hasVariableOrIRI
```
public boolean hasVariableOrIRI(java.lang.String name)
```
    Return true if there is variable or IRI with a specified name.
    
    Specified by:
    
    hasVariableOrIRI in interface ISparqlRequestGroup
    
    Parameters:
    
    name - the variable or IRI name
    
    Returns:
    
    true if there is variable or IRI with the specified name
  - addVariableOrIRI
```
public boolean addVariableOrIRI(VariableOrIRI varOrIRI)
```
    Add a variable or IRI.
    
    Specified by:
    
    addVariableOrIRI in interface ISparqlRequestGroup
    
    Parameters:
    
    varOrIRI - the variable or IRI
    
    Returns:
    
    true if the variable or IRI could be added
  - isSelectAll
```
public boolean isSelectAll()
```
    Return true if the request is a SELECT ALL (*).
    
    Specified by:
    
    isSelectAll in interface ISparqlRequestGroup
    
    Returns:
    
    true if the request is a SELECT ALL
  - hasSelectVariable
```
public boolean hasSelectVariable(java.lang.String var)
```
    Return true if the SELECT part of the request has a specified variable.
    
    Specified by:
    
    hasSelectVariable in interface ISparqlRequestGroup
    
    Parameters:
    
    var - the variable name
    
    Returns:
    
    true if the SELECT part of the request has the specified variable
  - addDelete
```
public DeleteForm addDelete()
```
    Add a DELETE form.
    
    Specified by:
    
    addDelete in interface ISparqlRequestGroup
    
    Returns:
    
    the DELETE form
  - getDeleteForms
```
public java.util.List<DeleteForm> getDeleteForms()
```
    Return the DELETE forms.
    
    Specified by:
    
    getDeleteForms in interface ISparqlRequestGroup
    
    Returns:
    
    the DELETE forms
  - addInsert
```
public InsertForm addInsert()
```
    Add an INSERT form.
    
    Specified by:
    
    addInsert in interface ISparqlRequestGroup
    
    Returns:
    
    the INSERT form
  - addAsk
```
public AskForm addAsk()
```
    Add an ASK form.
    
    Specified by:
    
    addAsk in interface ISparqlRequestGroup
    
    Returns:
    
    the ASK form
  - hasAskForm
```
public boolean hasAskForm()
```
    Return true if there is an ASK form.
    
    Specified by:
    
    hasAskForm in interface ISparqlRequestGroup
    
    Returns:
    
    true if there is an ASK form
  - getAskForm
```
public AskForm getAskForm()
```
    Return the ASK form.
    
    Specified by:
    
    getAskForm in interface ISparqlRequestGroup
    
    Returns:
    
    the ASK form
  - addInsertData
```
public InsertForm addInsertData()
```
    Add an INSERT DATA form.
    
    Specified by:
    
    addInsertData in interface ISparqlRequestGroup
    
    Returns:
    
    the INSERT DATA form
  - getLastInsertForm
```
public InsertForm getLastInsertForm()
```
    Return the last INSERT form.
    
    Returns:
    
    the last INSERT form
  - getInsertForms
```
public java.util.List<InsertForm> getInsertForms()
```
    Return the INSERT forms.
    
    Specified by:
    
    getInsertForms in interface ISparqlRequestGroup
    
    Returns:
    
    the INSERT forms
  - getSelectForm
```
public SelectForm getSelectForm()
```
    Return the SELECT form.
    
    Specified by:
    
    getSelectForm in interface ISparqlRequestGroup
    
    Returns:
    
    the SELECT form
  - getWhereForm
```
public WhereForm getWhereForm()
```
    Return the WHERE form.
    
    Specified by:
    
    getWhereForm in interface ISparqlRequestGroup
    
    Returns:
    
    the WHERE form
  - getPropertyValues
```
public java.util.Map<java.lang.String,java.util.List<Property>> getPropertyValues()
```
    Return the property values.
    
    Specified by:
    
    getPropertyValues in interface ISparqlRequestGroup
    
    Returns:
    
    the property values
  - getPropertyRefs
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<PropertyRef>>> getPropertyRefs()
```
    Return the property references.
    
    Specified by:
    
    getPropertyRefs in interface ISparqlRequestGroup
    
    Returns:
    
    the property references
  - getPropertyIndRefs
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,Individual>> getPropertyIndRefs()
```
    Return the property individual references.
    
    Specified by:
    
    getPropertyIndRefs in interface ISparqlRequestGroup
    
    Returns:
    
    the property individual references
  - getWhereExpressions
```
public java.util.List<WhereExpression> getWhereExpressions()
```
    Return the where expressions in the request.
    
    Specified by:
    
    getWhereExpressions in interface ISparqlRequestGroup
    
    Returns:
    
    the where expressions
  - getGraphPatterns
```
public java.util.List<GraphPattern> getGraphPatterns()
```
    Return the graph patterns.
    
    Specified by:
    
    getGraphPatterns in interface ISparqlRequestGroup
    
    Returns:
    
    the graph patterns
  - getDistances
```
public java.util.Map<java.lang.String,SparqlDistance> getDistances()
```
    Return the geosparql distances.
    
    Specified by:
    
    getDistances in interface ISparqlRequestGroup
    
    Returns:
    
    the geosparql distances
  - getGeometries
```
public java.util.Map<java.lang.String,SparqlGeometry> getGeometries()
```
    Return the geosparql geometries.
    
    Specified by:
    
    getGeometries in interface ISparqlRequestGroup
    
    Returns:
    
    the geosparql geometries
  - getFilters
```
public java.util.List<Filter> getFilters()
```
    Return the filters.
    
    Specified by:
    
    getFilters in interface ISparqlRequestGroup
    
    Returns:
    
    the filters
  - getBinds
```
public java.util.List<Bind> getBinds()
```
    Return the bindings.
    
    Specified by:
    
    getBinds in interface ISparqlRequestGroup
    
    Returns:
    
    the bindings
  - getCoalesces
```
public java.util.List<Coalesce> getCoalesces()
```
    Return the coalesce expressions.
    
    Specified by:
    
    getCoalesces in interface ISparqlRequestGroup
    
    Returns:
    
    the coalesce expressions
  - getOwlTimes
```
public java.util.Map<java.lang.String,SparqlTime> getOwlTimes()
```
    Return the owl-time expressions.
    
    Specified by:
    
    getOwlTimes in interface ISparqlRequestGroup
    
    Returns:
    
    the owl-time expressions
  - addProperty
```
public boolean addProperty(TripleElement object,
                           TripleElement property,
                           TripleElement target,
                           boolean optional)
```
    Add an object property reference declaration in the OPTIONAL construct.
    
    Specified by:
    
    addProperty in interface ISparqlRequestGroup
    
    Parameters:
    
    object - the object
    
    property - the property
    
    target - the target
    
    optional - true for an optional pattern
    
    Returns:
    
    true
  - checkVariableExistence
```
public boolean checkVariableExistence(java.lang.String varName)
```
    Check the existence of a variable.
    
    Specified by:
    
    checkVariableExistence in interface ISparqlRequestGroup
    
    Parameters:
    
    varName - the variable name
    
    Returns:
    
    true if the vriable is defined
  - appendTypeExpression
```
protected void appendTypeExpression(java.lang.StringBuilder buf,
                                    Variable elt,
                                    WhereExpression type)
```
    Append a type expression.
    
    Parameters:
    
    buf - the String buffer
    
    elt - the variable
    
    type - the expression
  - getPrefix
```
public java.lang.String getPrefix(Property property)
```
    Return the prefix of a property.
    
    Specified by:
    
    getPrefix in interface ISparqlRequestGroup
    
    Parameters:
    
    property - the property
    
    Returns:
    
    the prefix
  - getPrefix
```
public java.lang.String getPrefix(PropertyRef property)
```
    Return the prefix of a property reference.
    
    Specified by:
    
    getPrefix in interface ISparqlRequestGroup
    
    Parameters:
    
    property - the property reference
    
    Returns:
    
    the prefix
  - getVariablesIterator
```
public java.util.Iterator<Variable> getVariablesIterator()
```
    Return an iterator on the variables.
    
    Specified by:
    
    getVariablesIterator in interface ISparqlRequestGroup
    
    Returns:
    
    an iterator on the variables
  - getVariablesOrIRIIterator
```
public java.util.Iterator<VariableOrIRI> getVariablesOrIRIIterator()
```
    Return an iterator on the variables and IRIs.
    
    Specified by:
    
    getVariablesOrIRIIterator in interface ISparqlRequestGroup
    
    Returns:
    
    an iterator on the variables and IRIs

Class AbstractSparqlRequest

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

selectForm

whereForm

deleteForms

insertForms

askForm

filters

binds

coalesces

variables

additionalVars

iris

Constructor Detail

AbstractSparqlRequest

Method Detail

addVariable

addAdditionalVariable

addAdditionalVariable

getAdditionalVars

hasAdditionalVariable

createVariable

createAdditionalVariable

getVariable

getVariableType

hasVariable

getVariables

addIRI

createIRI

getIRI

hasIRI

getIRIs

getVariableOrIRI

hasVariableOrIRI

addVariableOrIRI

isSelectAll

hasSelectVariable

addDelete

getDeleteForms

addInsert

addAsk

hasAskForm

getAskForm

addInsertData

getLastInsertForm

getInsertForms

getSelectForm

getWhereForm

getPropertyValues

getPropertyRefs

getPropertyIndRefs

getWhereExpressions

getGraphPatterns

getDistances

getGeometries

getFilters

getBinds

getCoalesces

getOwlTimes

addProperty

checkVariableExistence

appendTypeExpression

getPrefix

getPrefix

getVariablesIterator

getVariablesOrIRIIterator