WhereBuilder (Apache Jena - Extras - Query Builder 3.17.0)

java.lang.Object
- org.apache.jena.arq.querybuilder.AbstractQueryBuilder<WhereBuilder>
- - org.apache.jena.arq.querybuilder.WhereBuilder

All Implemented Interfaces:

Cloneable, PrologClause<WhereBuilder>, ValuesClause<WhereBuilder>, WhereClause<WhereBuilder>
```
public class WhereBuilder
extends AbstractQueryBuilder<WhereBuilder>
implements WhereClause<WhereBuilder>
```
A simple implementation of WhereClause for use in building complex sub queries where a SelectBuilder or similar implementation is more than is needed.

Constructor Summary

Constructors
Constructor and Description

WhereBuilder()
Constructor.

Constructors
Constructor and Description
`WhereBuilder()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WhereBuilder`	`addBind(Expr expression, Object var)` Add a bind statement to the query * http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.
`WhereBuilder`	`addBind(String expression, Object var)` Add a bind statement to the query http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.
`WhereBuilder`	`addFilter(Expr expr)` Adds a filter to the where clause Use ExprFactory or NodeValue static or the AbstractQueryBuilder.makeExpr methods to create the expression.
`WhereBuilder`	`addFilter(String s)` Adds a filter to the where clause
`WhereBuilder`	`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.
`WhereBuilder`	`addGraph(Object graph, FrontsTriple triple)` Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern.
`WhereBuilder`	`addGraph(Object graph, Object subject, Object predicate, Object object)` Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern.
`WhereBuilder`	`addGraph(Object graph, Triple triple)` Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern.
`WhereBuilder`	`addGraph(Object graph, TriplePath triplePath)` Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern.
`WhereBuilder`	`addMinus(AbstractQueryBuilder<?> t)` Add a minus clause to the query.
`WhereBuilder`	`addOptional(AbstractQueryBuilder<?> t)` Adds an optional group pattern to the where clause.
`WhereBuilder`	`addOptional(FrontsTriple t)` Adds an optional triple as to the where clause.
`WhereBuilder`	`addOptional(Object s, Object p, Object o)` Adds an optional triple or triple path to the where clause.
`WhereBuilder`	`addOptional(Triple t)` Adds an optional triple to the where clause.
`WhereBuilder`	`addOptional(TriplePath t)` Adds an optional triple path to the where clause.
`WhereBuilder`	`addSubQuery(AbstractQueryBuilder<?> subQuery)` Add a sub query.
`WhereBuilder`	`addUnion(AbstractQueryBuilder<?> subQuery)` Add a union.
`WhereBuilder`	`addWhere(FrontsTriple t)` Adds a triple to the where clause.
`WhereBuilder`	`addWhere(Object s, Object p, Object o)` Adds a triple or triple path to the where clause.
`WhereBuilder`	`addWhere(Triple t)` Adds a triple to the where clause.
`WhereBuilder`	`addWhere(TriplePath t)` Adds a triple path to the where clause.
`WhereBuilder`	`addWhereValueRow(Collection<?> values)` Add a collection of objects as row of values.
`WhereBuilder`	`addWhereValueRow(Object... values)` Add objects as a row of values.
`WhereBuilder`	`addWhereValueVar(Object var)` Add a variable or variable and values to the value statement.
`WhereBuilder`	`addWhereValueVar(Object var, Object... values)` Add a variable and values to the value statement.
`<K extends Collection<?>> WhereBuilder`	`addWhereValueVars(Map<?,K> dataTable)` Add a data table to the value statement.
`WhereBuilder`	`clearWhereValues()` Reset the values table in the where clause to the initial undefined state.
`HandlerBlock`	`getHandlerBlock()` Get the HandlerBlock for this query builder.
`Map<Var,List<Node>>`	`getWhereValuesMap()` Get an unmodifiable map of vars from the where clause values and their values.
`List<Var>`	`getWhereValuesVars()` Get an unmodifiable list of vars from the where clause values in the order that they appear in the values table.
`Node`	`list(Object... objs)` Create a list node from a list of objects as per RDF Collections.
`String`	`toString()`

Methods inherited from class org.apache.jena.arq.querybuilder.AbstractQueryBuilder
addPrefix, addPrefix, addPrefix, addPrefixes, addPrefixes, addValueRow, addValueRow, addValueVar, addValueVar, addValueVars, addWhere, asSubQuery, build, buildString, checkVar, clearValues, clone, getExprFactory, getPrologHandler, getValuesHandler, getValuesMap, getValuesVars, getWhereHandler, makeExpr, makeNode, makeNode, makeNodeOrPath, makeTriplePath, makeValueNodes, makeValueNodes, makeVar, quote, rewrite, setBase, setBase, setVar, setVar

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.jena.arq.querybuilder.clauses.WhereClause
addWhere, getWhereHandler

- Constructor Detail
  - WhereBuilder
```
public WhereBuilder()
```
    Constructor.
- Method Detail
  - addWhere
```
public WhereBuilder addWhere(Triple t)
```
    Description copied from interface: WhereClause
    
    Adds a triple to the where clause.
    
    Specified by:
    
    addWhere in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    t - The triple path to add
    
    Returns:
    
    This Builder for chaining.
  - addWhere
```
public WhereBuilder addWhere(TriplePath t)
```
    Description copied from interface: WhereClause
    
    Adds a triple path to the where clause.
    
    Specified by:
    
    addWhere in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    t - The triple path to add
    
    Returns:
    
    This Builder for chaining.
  - addWhere
```
public WhereBuilder addWhere(FrontsTriple t)
```
    Description copied from interface: WhereClause
    
    Adds a triple to the where clause.
    
    Specified by:
    
    addWhere in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    t - The triple to add
    
    Returns:
    
    This Builder for chaining.
  - addWhere
```
public WhereBuilder addWhere(Object s,
                             Object p,
                             Object o)
```
    Description copied from interface: WhereClause
    
    Adds a triple or triple path to the where clause. See AbstractQueryBuilder.makeTriplePath(java.lang.Object, java.lang.Object, java.lang.Object) for conversion of the param values.
    
    Specified by:
    
    addWhere in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    s - The subject.
    
    p - The predicate.
    
    o - The object.
    
    Returns:
    
    This Builder for chaining.
  - addWhereValueVar
```
public WhereBuilder addWhereValueVar(Object var)
```
    Description copied from interface: WhereClause
    
    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.
    
    Specified by:
    
    addWhereValueVar in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    var - The variable or collection to add.
    
    Returns:
    
    The builder for chaining.
    
    See Also:
    
    AbstractQueryBuilder.makeNode(Object), Converters.makeVar(Object)
  - addWhereValueVar
```
public WhereBuilder addWhereValueVar(Object var,
                                     Object... values)
```
    Description copied from interface: WhereClause
    
    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.
    
    Specified by:
    
    addWhereValueVar in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    var - The variable to add.
    
    values - The values for the variable
    
    Returns:
    
    The builder for chaining.
    
    See Also:
    
    AbstractQueryBuilder.makeNode(Object), Converters.makeVar(Object)
  - addWhereValueVars
```
public <K extends Collection<?>> WhereBuilder addWhereValueVars(Map<?,K> dataTable)
```
    Description copied from interface: WhereClause
    
    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.
    Specified by:
    
    addWhereValueVars in interface WhereClause<WhereBuilder>
    
    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
```
public WhereBuilder addWhereValueRow(Object... values)
```
    Description copied from interface: WhereClause
    
    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.
    
    Specified by:
    
    addWhereValueRow in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    values - the collection of values to add.
    
    Returns:
    
    The builder for chaining.
    
    See Also:
    
    AbstractQueryBuilder.makeNode(Object)
  - addWhereValueRow
```
public WhereBuilder addWhereValueRow(Collection<?> values)
```
    Description copied from interface: WhereClause
    
    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.
    
    Specified by:
    
    addWhereValueRow in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    values - the collection of values to add.
    
    Returns:
    
    The builder for chaining.
    
    See Also:
    
    AbstractQueryBuilder.makeNode(Object)
  - getWhereValuesVars
```
public List<Var> getWhereValuesVars()
```
    Description copied from interface: WhereClause
    
    Get an unmodifiable list of vars from the where clause values in the order that they appear in the values table.
    
    Specified by:
    
    getWhereValuesVars in interface WhereClause<WhereBuilder>
    
    Returns:
    
    an unmodifiable list of vars.
  - getWhereValuesMap
```
public Map<Var,List<Node>> getWhereValuesMap()
```
    Description copied from interface: WhereClause
    
    Get an unmodifiable map of vars from the where clause values and their values. Null values are considered as UNDEF values.
    
    Specified by:
    
    getWhereValuesMap in interface WhereClause<WhereBuilder>
    
    Returns:
    
    an unmodifiable map of vars and their values.
  - clearWhereValues
```
public WhereBuilder clearWhereValues()
```
    Description copied from interface: WhereClause
    
    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.
    
    Specified by:
    
    clearWhereValues in interface WhereClause<WhereBuilder>
  - addOptional
```
public WhereBuilder addOptional(TriplePath t)
```
    Description copied from interface: WhereClause
    
    Adds an optional triple path to the where clause.
    
    Specified by:
    
    addOptional in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    t - The triple path to add
    
    Returns:
    
    This Builder for chaining.
  - addOptional
```
public WhereBuilder addOptional(Triple t)
```
    Description copied from interface: WhereClause
    
    Adds an optional triple to the where clause.
    
    Specified by:
    
    addOptional in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    t - The triple to add
    
    Returns:
    
    This Builder for chaining.
  - addOptional
```
public WhereBuilder addOptional(FrontsTriple t)
```
    Description copied from interface: WhereClause
    
    Adds an optional triple as to the where clause.
    
    Specified by:
    
    addOptional in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    t - The triple to add
    
    Returns:
    
    This Builder for chaining.
  - addOptional
```
public WhereBuilder addOptional(Object s,
                                Object p,
                                Object o)
```
    Description copied from interface: WhereClause
    
    Adds an optional triple or triple path to the where clause. See AbstractQueryBuilder.makeTriplePath(java.lang.Object, java.lang.Object, java.lang.Object) for conversion of the param values.
    
    Specified by:
    
    addOptional in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    s - The subject.
    
    p - The predicate.
    
    o - The object.
    
    Returns:
    
    This Builder for chaining.
  - addOptional
```
public WhereBuilder addOptional(AbstractQueryBuilder<?> t)
```
    Description copied from interface: WhereClause
    
    Adds an optional group pattern to the where clause.
    
    Specified by:
    
    addOptional in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    t - The select builder to add as an optional pattern
    
    Returns:
    
    This Builder for chaining.
  - addFilter
```
public WhereBuilder addFilter(Expr expr)
```
    Description copied from interface: WhereClause
    
    Adds a filter to the where clause Use ExprFactory or NodeValue static or the AbstractQueryBuilder.makeExpr methods to create the expression.
    
    Specified by:
    
    addFilter in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    expr - the expression to evaluate for the filter.
    
    Returns:
    
    @return This Builder for chaining.
    
    See Also:
    
    ExprFactory, NodeValue, AbstractQueryBuilder.makeExpr(String)
  - addFilter
```
public WhereBuilder addFilter(String s)
                       throws ParseException
```
    Description copied from interface: WhereClause
    
    Adds a filter to the where clause
    
    Specified by:
    
    addFilter in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    s - the expression to evaluate for the filter.
    
    Returns:
    
    @return This Builder for chaining.
    
    Throws:
    
    ParseException - If the expression can not be parsed.
  - addSubQuery
```
public WhereBuilder addSubQuery(AbstractQueryBuilder<?> subQuery)
```
    Description copied from interface: WhereClause
    
    Add a sub query.
    
    Specified by:
    
    addSubQuery in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    subQuery - The subquery as defined by a SelectBuilder.
    
    Returns:
    
    This builder for chaining.
  - addUnion
```
public WhereBuilder addUnion(AbstractQueryBuilder<?> subQuery)
```
    Description copied from interface: WhereClause
    
    Add a union.
    
    Specified by:
    
    addUnion in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    subQuery - The union as defined by a SelectBuilder.
    
    Returns:
    
    This builder for chaining.
  - addGraph
```
public WhereBuilder addGraph(Object graph,
                             AbstractQueryBuilder<?> subQuery)
```
    Description copied from interface: WhereClause
    
    Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. See AbstractQueryBuilder.makeNode(java.lang.Object) for conversion of the graph param.
    
    Specified by:
    
    addGraph in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    graph - The iri or variable identifying the graph.
    
    subQuery - The graph to add.
    
    Returns:
    
    This builder for chaining.
  - addGraph
```
public WhereBuilder addGraph(Object graph,
                             FrontsTriple triple)
```
    Description copied from interface: WhereClause
    
    Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. See AbstractQueryBuilder.makeNode(java.lang.Object) for conversion of the graph param.
    
    Specified by:
    
    addGraph in interface WhereClause<WhereBuilder>
    
    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
```
public WhereBuilder addGraph(Object graph,
                             Object subject,
                             Object predicate,
                             Object object)
```
    Description copied from interface: WhereClause
    
    Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. See AbstractQueryBuilder.makeNode(java.lang.Object) for conversion of the graph param.
    
    Specified by:
    
    addGraph in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    graph - The iri or variable identifying the graph.
    
    subject - The subject for the graph query
    
    predicate - The predicate for the graph query.
    
    object - The object for the graph query.
    
    Returns:
    
    This builder for chaining.
  - addGraph
```
public WhereBuilder addGraph(Object graph,
                             Triple triple)
```
    Description copied from interface: WhereClause
    
    Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. See AbstractQueryBuilder.makeNode(java.lang.Object) for conversion of the graph param.
    
    Specified by:
    
    addGraph in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    graph - The iri or variable identifying the graph.
    
    triple - a single triple for the query.
    
    Returns:
    
    This builder for chaining.
  - addGraph
```
public WhereBuilder addGraph(Object graph,
                             TriplePath triplePath)
```
    Description copied from interface: WhereClause
    
    Add a graph statement to the query as per http://www.w3.org/TR/2013/REC-sparql11 -query-20130321/#rGraphGraphPattern. See AbstractQueryBuilder.makeNode(java.lang.Object) for conversion of the graph param.
    
    Specified by:
    
    addGraph in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    graph - The iri or variable identifying the graph.
    
    triplePath - a single triple path for the query.
    
    Returns:
    
    This builder for chaining.
  - addBind
```
public WhereBuilder addBind(Expr expression,
                            Object var)
```
    Description copied from interface: WhereClause
    
    Add a bind statement to the query * http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.
    
    Specified by:
    
    addBind in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    expression - The expression to bind to the var.
    
    var - The variable to bind to.
    
    Returns:
    
    This builder for chaining.
  - addBind
```
public WhereBuilder addBind(String expression,
                            Object var)
                     throws ParseException
```
    Description copied from interface: WhereClause
    
    Add a bind statement to the query http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rGraphGraphPattern.
    
    Specified by:
    
    addBind in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    expression - The expression to bind to the var.
    
    var - The variable to bind to.
    
    Returns:
    
    This builder for chaining.
    
    Throws:
    
    ParseException
  - list
```
public Node list(Object... objs)
```
    Description copied from interface: WhereClause
    Create a list node from a list of objects as per RDF Collections. http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#collections See AbstractQueryBuilder.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 )
    Specified by:
    
    list in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    objs - the list of objects for the list.
    
    Returns:
    
    the first blank node in the list.
  - addMinus
```
public WhereBuilder addMinus(AbstractQueryBuilder<?> t)
```
    Description copied from interface: WhereClause
    
    Add a minus clause to the query. https://www.w3.org/TR/2013/REC-sparql11-query-20130321/#rMinusGraphPattern
    
    Specified by:
    
    addMinus in interface WhereClause<WhereBuilder>
    
    Parameters:
    
    t - The select builder to add as a minus pattern
    
    Returns:
    
    this builder for chaining
  - getHandlerBlock
```
public HandlerBlock getHandlerBlock()
```
    Description copied from class: AbstractQueryBuilder
    
    Get the HandlerBlock for this query builder.
    
    Specified by:
    
    getHandlerBlock in class AbstractQueryBuilder<WhereBuilder>
    
    Returns:
    
    The associated handler block.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractQueryBuilder<WhereBuilder>

Class WhereBuilder

Constructor Summary

Method Summary

Methods inherited from class org.apache.jena.arq.querybuilder.AbstractQueryBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.jena.arq.querybuilder.clauses.WhereClause

Constructor Detail

WhereBuilder

Method Detail

addWhere

addWhere

addWhere

addWhere

addWhereValueVar

addWhereValueVar

addWhereValueVars

addWhereValueRow

addWhereValueRow

getWhereValuesVars

getWhereValuesMap

clearWhereValues

addOptional

addOptional

addOptional

addOptional

addOptional

addFilter

addFilter

addSubQuery

addUnion

addGraph

addGraph

addGraph

addGraph

addGraph

addBind

addBind

list

addMinus

getHandlerBlock

toString