org.da.sparqlhelper.sparql.model

Class AbstractSparqVariableFormExpression

java.lang.Object

org.da.sparqlhelper.sparql.model.AbstractSparqFormExpression

org.da.sparqlhelper.sparql.model.AbstractSparqVariableFormExpression

All Implemented Interfaces:

ISparqlFormExpression, ISparqVariableFormExpression

Direct Known Subclasses:

DeleteForm, InsertForm, WhereForm

public abstract class AbstractSparqVariableFormExpression
extends AbstractSparqFormExpression
implements ISparqVariableFormExpression

Since:

0.1

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,SparqlDistance>	distances
protected java.util.Map<java.lang.String,SparqlGeometry>	geometries
protected java.util.List<GraphPattern>	graphPatterns
protected java.util.Map<java.lang.String,SparqlTime>	owltimes
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,PropertyRef>>	propertyIndRefs
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<PropertyRef>>>	propertyRefs
protected java.util.Map<java.lang.String,java.util.List<Property>>	propertyValues
protected java.util.Set<WhereType>	whereTypes

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

parentRequest

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

TYPE_DELETE, TYPE_INSERT, TYPE_INSERT_DATA, TYPE_SELECT, TYPE_WHERE

Constructor Summary

Constructors

Constructor and Description
AbstractSparqVariableFormExpression(ISparqlRequestGroup parentRequest)

Method Summary

Modifier and Type	Method and Description
boolean	addDistance(java.lang.String var, java.lang.String fromVar, java.lang.String varDist, short unit, boolean isExact) 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.
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.
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.
boolean	addLabel(java.lang.String var, TripleElement type) Add a rdfs:label matching declaration in the WHERE part of the request.
boolean	addLabel(VariableOrIRI varOrIRI, TripleElement type) Add a rdfs:label matching declaration in the WHERE part of the request.
boolean	addProperty(TripleElement object, TripleElement property, TripleElement target, boolean optional) Add an object property reference declaration in the OPTIONAL construct.
boolean	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.
boolean	addPropertyIRIValue(java.lang.String iri, TripleElement type, java.lang.Object propertyValue, boolean optional) Add a property value declaration in the WHERE part of the request.
boolean	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.
boolean	addPropertyRef(VariableOrIRI varOrIRI, TripleElement type, java.lang.String varRef, boolean optional) Add an object property reference declaration in the OPTIONAL construct.
boolean	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.
boolean	addPropertyValue(VariableOrIRI varOrIRI, TripleElement type, java.lang.Object propertyValue, boolean optional) Add a property value declaration in the WHERE part of the request.
boolean	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	addSubClassOf(java.lang.String var, TripleElement type) Add a rdfs:subClassOf matching declaration in the WHERE part of the request.
boolean	addSubClassOf(VariableOrIRI varOrIRI, TripleElement type) Add a rdfs:subClassOf matching declaration in the WHERE part of the request.
boolean	addSubClassOfStar(java.lang.String var, TripleElement type) Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.
boolean	addSubClassOfStar(VariableOrIRI varOrIRI, 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.
boolean	addType(java.lang.String var, short exprKind, TripleElement type) Add a matching declaration in the WHERE part of the request.
boolean	addType(java.lang.String var, TripleElement type) Add a rdf:type matching declaration in the WHERE part of the request.
boolean	addType(VariableOrIRI varOrIRI, short exprKind, TripleElement type) Add a matching declaration in the WHERE part of the request.
boolean	addType(VariableOrIRI varOrIRI, TripleElement type) Add a rdf:type matching declaration in the WHERE part of the request.
boolean	addTypeSubClassOf(java.lang.String var, TripleElement type) Add a rdf:type/rdfs:subClassOf matching declaration in the WHERE part of the request.
boolean	addVariableSubClassOf(java.lang.String var, TripleElement typeVar) Add a rdfs:subClassOf matching declaration in the WHERE part of the request.
boolean	addVariableSubClassOfStar(java.lang.String var, TripleElement typeVar) Add a rdfs:subClassOf* matching declaration in the WHERE part of the request.
boolean	addVariableType(java.lang.String var, short exprKind, TripleElement typeVar) Add a matching declaration in the WHERE part of the request.
boolean	addVariableType(java.lang.String var, TripleElement element) Add a rdf:type matching declaration in the WHERE part of the request.
boolean	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.
java.util.Map<java.lang.String,SparqlDistance>	getDistances() Return the geosparql distances.
java.util.Map<java.lang.String,SparqlGeometry>	getGeometries() Return the geosparql geometries.
java.util.List<GraphPattern>	getGraphPatterns() Return the graph patterns.
java.util.Map<java.lang.String,SparqlTime>	getOwlTimes() Return the owl-time expressions.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,PropertyRef>>	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.
java.util.Set<WhereType>	getWhereTypes()

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

getSparqlRequest

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

addProperty, addPropertyIndividualRef, addPropertyIndividualRef, addPropertyIRIValue, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyRef, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValues, addPropertyValues, addPropertyValues

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

formExpressionTypeAsString, getFormExpressionType, getSparqlRequest

Field Detail

propertyValues

protected final java.util.Map<java.lang.String,java.util.List<Property>> propertyValues

propertyRefs

protected final java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<PropertyRef>>> propertyRefs

propertyIndRefs

protected final java.util.Map<java.lang.String,java.util.Map<java.lang.String,PropertyRef>> propertyIndRefs

graphPatterns

protected final java.util.List<GraphPattern> graphPatterns

distances

protected final java.util.Map<java.lang.String,SparqlDistance> distances

geometries

protected final java.util.Map<java.lang.String,SparqlGeometry> geometries

owltimes

protected final java.util.Map<java.lang.String,SparqlTime> owltimes

whereTypes

protected final java.util.Set<WhereType> whereTypes

Constructor Detail

AbstractSparqVariableFormExpression

public AbstractSparqVariableFormExpression(ISparqlRequestGroup parentRequest)

Method Detail

getWhereTypes

public java.util.Set<WhereType> getWhereTypes()

getPropertyValues

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

Return the property values.

Specified by:

getPropertyValues in interface ISparqVariableFormExpression

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 ISparqVariableFormExpression

Returns:

the property references

getPropertyIndRefs

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

Return the property individual references.

Specified by:

getPropertyIndRefs in interface ISparqVariableFormExpression

Returns:

the property individual references

getGraphPatterns

public java.util.List<GraphPattern> getGraphPatterns()

Return the graph patterns.

Specified by:

getGraphPatterns in interface ISparqVariableFormExpression

Returns:

the graph patterns

getDistances

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

Return the geosparql distances.

Specified by:

getDistances in interface ISparqVariableFormExpression

Returns:

the geosparql distances

getGeometries

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

Return the geosparql geometries.

Specified by:

getGeometries in interface ISparqVariableFormExpression

Returns:

the geosparql geometries

getOwlTimes

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

Return the owl-time expressions.

Specified by:

getOwlTimes in interface ISparqVariableFormExpression

Returns:

the owl-time expressions

addSubClassOf

public boolean 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 ISparqVariableFormExpression

Parameters:

var - the variable name

type - the type

Returns:

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

addSubClassOf

public boolean addSubClassOf(VariableOrIRI varOrIRI,
                             TripleElement type)

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

Specified by:

addSubClassOf in interface ISparqVariableFormExpression

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)

addLabel

public boolean 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 ISparqVariableFormExpression

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 boolean addLabel(VariableOrIRI varOrIRI,
                        TripleElement type)

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

Specified by:

addLabel in interface ISparqVariableFormExpression

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)

addSubClassOfStar

public boolean 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 ISparqVariableFormExpression

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 boolean addSubClassOfStar(VariableOrIRI varOrIRI,
                                 TripleElement type)

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

Specified by:

addSubClassOfStar in interface ISparqVariableFormExpression

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)

addTypeSubClassOf

public boolean 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 ISparqVariableFormExpression

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 boolean 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 ISparqVariableFormExpression

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 boolean addType(VariableOrIRI varOrIRI,
                       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 ISparqVariableFormExpression

Parameters:

varOrIRI - the variable or IRI

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 boolean 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 ISparqVariableFormExpression

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 boolean addType(VariableOrIRI varOrIRI,
                       TripleElement type)

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

Specified by:

addType in interface ISparqVariableFormExpression

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 boolean 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 ISparqVariableFormExpression

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 boolean 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 ISparqVariableFormExpression

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 boolean 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 ISparqVariableFormExpression

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 boolean 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 ISparqVariableFormExpression

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 boolean 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 ISparqVariableFormExpression

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)

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.

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)

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 ISparqVariableFormExpression

Parameters:

object - the object

property - the property

target - the target

optional - true for an optional pattern

Returns:

true

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 ISparqVariableFormExpression

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)

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.

Specified by:

addTime in interface ISparqVariableFormExpression

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 ISparqVariableFormExpression

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 ISparqVariableFormExpression

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)

addPropertyIRIValue

public boolean addPropertyIRIValue(java.lang.String iri,
                                   TripleElement type,
                                   java.lang.Object propertyValue,
                                   boolean optional)

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

Specified by:

addPropertyIRIValue in interface ISparqVariableFormExpression

Parameters:

iri - the iri

type - the property

propertyValue - the property value

optional - true for an optional pattern

Returns:

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

addPropertyValue

public boolean addPropertyValue(VariableOrIRI varOrIRI,
                                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 ISparqVariableFormExpression

Parameters:

varOrIRI - the variable or IRI

type - the property

propertyValue - the property value

optional - true for an optional pattern

Returns:

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

addPropertyValue

public boolean 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 ISparqVariableFormExpression

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 boolean 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 ISparqVariableFormExpression

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 boolean addPropertyRef(VariableOrIRI varOrIRI,
                              TripleElement type,
                              java.lang.String varRef,
                              boolean optional)

Add an object property reference declaration in the OPTIONAL construct.

Specified by:

addPropertyRef in interface ISparqVariableFormExpression

Parameters:

varOrIRI - the variable or IRI

type - the property

varRef - the variable to use for the reference

optional - true for an optional property

Returns:

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

addPropertyRef

public boolean 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 ISparqVariableFormExpression

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)

addPropertyIndividualRef

public boolean 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 ISparqVariableFormExpression

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)

checkValidity

public boolean checkValidity()

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

Returns:

true if the Sparql request is valid