Module org.apache.jena.querybuilder
Interface WhereClause<T extends AbstractQueryBuilder<T>>
- Type Parameters:
T
- The Builder type that the clause is part of.
- All Known Implementing Classes:
AskBuilder
,ConstructBuilder
,DescribeBuilder
,SelectBuilder
,WhereBuilder
public interface WhereClause<T extends AbstractQueryBuilder<T>>
Interface that defines the WhereClause as per
http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rWhereClause
-
Method Summary
Modifier and TypeMethodDescriptionAdd a bind statement to the query http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.Add a bind statement to the query * http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.Adds a filter to the where clauseaddFilter
(org.apache.jena.sparql.expr.Expr expression) Adds a filter to the where clause Use ExprFactory or NodeValue static or the AbstractQueryBuilder.makeExpr methods to create the expression.Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern.addGraph
(Object graph, Collection<org.apache.jena.sparql.core.TriplePath> collection) Adds a collection of triple paths as the optional clauses.addGraph
(Object graph, AbstractQueryBuilder<?> subQuery) Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern.Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern.Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern.Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern.addMinus
(AbstractQueryBuilder<?> t) Add a minus clause to the query.addOptional
(Object s, Object p, Object o) Adds an optional triple or triple path to the where clause.addOptional
(Collection<org.apache.jena.sparql.core.TriplePath> collection) Adds a collection of triple paths as the optional clauses.Adds an optional group pattern to the where clause.addOptional
(org.apache.jena.graph.FrontsTriple t) Adds an optional triple as to the where clause.addOptional
(org.apache.jena.graph.Triple t) Adds an optional triple to the where clause.addOptional
(org.apache.jena.sparql.core.TriplePath t) Adds an optional triple path to the where clause.addSubQuery
(AbstractQueryBuilder<?> subQuery) Add a sub query.addUnion
(AbstractQueryBuilder<?> union) Add a union.Adds a triple or triple path to the where clause.addWhere
(Collection<org.apache.jena.sparql.core.TriplePath> collection) Adds a collections of triple paths to the where clause.addWhere
(AbstractQueryBuilder<?> whereClause) Adds the elements from the whereClause to this where Clause.addWhere
(org.apache.jena.graph.FrontsTriple t) Adds a triple to the where clause.addWhere
(org.apache.jena.graph.Triple t) Adds a triple to the where clause.addWhere
(org.apache.jena.sparql.core.TriplePath t) Adds a triple path to the where clause.addWhereValueRow
(Object... values) Add objects as a row of values.addWhereValueRow
(Collection<?> values) Add a collection of objects as row of values.addWhereValueVar
(Object var) Add a variable or variable and values to the value statement.addWhereValueVar
(Object var, Object... values) Add a variable and values to the value statement.<K extends Collection<?>>
TaddWhereValueVars
(Map<?, K> dataTable) Add a data table to the value statement.Reset the values table in the where clause to the initial undefined state.Get the Where handler for this clause.Get an unmodifiable map of vars from the where clause values and their values.List<org.apache.jena.sparql.core.Var>
Get an unmodifiable list of vars from the where clause values in the order that they appear in the values table.org.apache.jena.graph.Node
Deprecated.
-
Method Details
-
addWhere
Adds a triple to the where clause.- Parameters:
t
- The triple to add- Returns:
- This Builder for chaining.
-
addWhere
Adds a triple path to the where clause.- Parameters:
t
- The triple path to add- Returns:
- This Builder for chaining.
-
addWhere
Adds a collections of triple paths to the where clause.- Parameters:
collection
- The collection of triple paths to add- Returns:
- This Builder for chaining.
-
addWhere
Adds a triple to the where clause.- Parameters:
t
- The triple to add- Returns:
- This Builder for chaining.
-
addWhere
Adds a triple or triple path to the where clause. SeeAbstractQueryBuilder.makeTriplePath(java.lang.Object, java.lang.Object, java.lang.Object)
for conversion of the param values.- Parameters:
s
- The subject.p
- The predicate.o
- The object.- Returns:
- This Builder for chaining.
-
addWhere
Adds the elements from the whereClause to this where Clause.- Parameters:
whereClause
- The whereClause to add to this statement.- Returns:
- This Builder for chaining.
-
addWhereValueVar
Add a variable or variable and values to the value statement. The first var (or first item in a collection) is converted to a variable using the makeVar strategy. A variable may be added multiple times, doing so will append values to the list of variable values. The order in which variables are added to the values table is preserved. Adding a collection as the var will use the first object in the collection as the var and the remaining objects as values. Values are created using makeNode() strategy except that null values are converted to UNDEF.- Parameters:
var
- The variable or collection to add.- Returns:
- The builder for chaining.
- See Also:
-
addWhereValueVar
Add a variable and values to the value statement. The var is converted to a variable using the makeVar strategy. A variable may be added multiple times, doing so will append values to the list of variable values. The order in which variables are added to the values table is preserved. Values are created using makeNode() strategy except that null values are converted to UNDEF.- Parameters:
var
- The variable to add.values
- The values for the variable- Returns:
- The builder for chaining.
- See Also:
-
addWhereValueVars
Add a data table to the value statement. Each key in the map is used converted into a variable using the makeVar strategy. The order in which variables are added to the values table is preserved. Variables are added in the iteration order for the map. It may be advisable to use a LinkedHashMap to preserver the insert order.- Parameters:
dataTable
- The data table to add.- Returns:
- The builder for chaining.
- See Also:
-
Each item in the value collection is converted into a node using makeNode() strategy except that null values are converted to UNDEF. If there are already values in the value statement the data table is adds as follows:
- If the variable already exists in the table the map values are appended to the list of values
- If the variable does not exist in the table and there are other variables defined, an appropriate number of nulls is added to the front of the map values to create UNDEF entries for the existing rows
- If there are variables in the value statement that are not specified in the map additional UNDEF entries are appended to them to account for new rows that are added.
AbstractQueryBuilder.makeNode(Object)
Converters.makeVar(Object)
-
addWhereValueRow
Add objects as a row of values. This method is different from the other methods in that the values are appended to each of the variables in the clause. There must be sufficient entries in the list to provide data for each variable in the table. Values objects are converted to nodes using the makeNode strategy. Variables will always be in the order added to the values table.- Parameters:
values
- the collection of values to add.- Returns:
- The builder for chaining.
- See Also:
-
addWhereValueRow
Add a collection of objects as row of values. This method is different from the other methods in that the values are appended to each of the variables in the clause. There must be sufficient entries in the list to provide data for each variable in the table. Values objects are converted to nodes using the makeNode strategy. Variables will always be in the order added to the values table.- Parameters:
values
- the collection of values to add.- Returns:
- The builder for chaining.
- See Also:
-
getWhereValuesVars
List<org.apache.jena.sparql.core.Var> getWhereValuesVars()Get an unmodifiable list of vars from the where clause values in the order that they appear in the values table.- Returns:
- an unmodifiable list of vars.
-
getWhereValuesMap
Get an unmodifiable map of vars from the where clause values and their values. Null values are considered as UNDEF values.- Returns:
- an unmodifiable map of vars and their values.
-
clearWhereValues
T clearWhereValues()Reset the values table in the where clause to the initial undefined state. Used primarily to reset the builder values table to a known state. -
addOptional
Adds an optional triple to the where clause.- Parameters:
t
- The triple to add- Returns:
- This Builder for chaining.
-
addOptional
Adds an optional triple path to the where clause.- Parameters:
t
- The triple path to add- Returns:
- This Builder for chaining.
-
addOptional
Adds a collection of triple paths as the optional clauses.- Parameters:
collection
- The collection of triple paths to add- Returns:
- This Builder for chaining.
-
addOptional
Adds an optional triple as to the where clause.- Parameters:
t
- The triple to add- Returns:
- This Builder for chaining.
-
addOptional
Adds an optional triple or triple path to the where clause. SeeAbstractQueryBuilder.makeTriplePath(java.lang.Object, java.lang.Object, java.lang.Object)
for conversion of the param values.- Parameters:
s
- The subject.p
- The predicate.o
- The object.- Returns:
- This Builder for chaining.
-
addOptional
Adds an optional group pattern to the where clause.- Parameters:
t
- The select builder to add as an optional pattern- Returns:
- This Builder for chaining.
-
addFilter
Adds a filter to the where clause- Parameters:
expression
- the expression to evaluate for the filter.- Returns:
- This Builder for chaining.
-
addFilter
Adds a filter to the where clause Use ExprFactory or NodeValue static or the AbstractQueryBuilder.makeExpr methods to create the expression.- Parameters:
expression
- the expression to evaluate for the filter.- Returns:
- This Builder for chaining.
- See Also:
-
addSubQuery
Add a sub query.- Parameters:
subQuery
- The subquery as defined by a SelectBuilder.- Returns:
- This builder for chaining.
-
addUnion
Add a union.- Parameters:
union
- The union as defined by a SelectBuilder.- Returns:
- This builder for chaining.
-
addGraph
Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. SeeAbstractQueryBuilder.makeNode(java.lang.Object)
for conversion of the graph param.- Parameters:
graph
- The iri or variable identifying the graph.subQuery
- The graph to add.- Returns:
- This builder for chaining.
-
addGraph
Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. SeeAbstractQueryBuilder.makeNode(java.lang.Object)
for conversion of the graph param.- Parameters:
graph
- The iri or variable identifying the graph.triple
- a single s, p, o triple for the query.- Returns:
- This builder for chaining.
-
addGraph
Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. SeeAbstractQueryBuilder.makeNode(java.lang.Object)
for conversion of the graph param.- Parameters:
graph
- The iri or variable identifying the graph.subject
- The subject for the graph querypredicate
- The predicate for the graph query.object
- The object for the graph query.- Returns:
- This builder for chaining.
-
addGraph
Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. SeeAbstractQueryBuilder.makeNode(java.lang.Object)
for conversion of the graph param.- Parameters:
graph
- The iri or variable identifying the graph.triple
- a single triple for the query.- Returns:
- This builder for chaining.
-
addGraph
Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. SeeAbstractQueryBuilder.makeNode(java.lang.Object)
for conversion of the graph param.- Parameters:
graph
- The iri or variable identifying the graph.triplePath
- a single triple path for the query.- Returns:
- This builder for chaining.
-
addGraph
Adds a collection of triple paths as the optional clauses.- Parameters:
graph
- The iri or variable identifying the graph.collection
- The collection of triple paths to add- Returns:
- This Builder for chaining.
-
addBind
Add a bind statement to the query * http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.- Parameters:
expression
- The expression to bind to the var.var
- The variable to bind to.- Returns:
- This builder for chaining.
-
addBind
Add a bind statement to the query http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.- Parameters:
expression
- The expression to bind to the var.var
- The variable to bind to.- Returns:
- This builder for chaining.
-
getWhereHandler
WhereHandler getWhereHandler()Get the Where handler for this clause.- Returns:
- The WhereHandler used by this clause.
-
list
Deprecated.useaddWhere(Converters.makeCollection(List.of(Object...)))
, or simply calladdWhere(Object, Object, Object)
passing the collection for one of the objects.Create a list node from a list of objects as per RDF Collections. http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#collections SeeAbstractQueryBuilder.makeNode(java.lang.Object)
for conversion of the param values.usage:
- list( param1, param2, param3, ... )
- addWhere( list( param1, param2, param3, ... ), p, o )
- addOptional( list( param1, param2, param3, ... ), p, o )
- Parameters:
objs
- the list of objects for the list.- Returns:
- the first blank node in the list.
-
addMinus
Add a minus clause to the query. https://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rMinusGraphPattern- Parameters:
t
- The select builder to add as a minus pattern- Returns:
- this builder for chaining
-
addWhere(Converters.makeCollection(List.of(Object...)))
, or simply calladdWhere(Object, Object, Object)
passing the collection for one of the objects.