WhereHandler (Apache Jena - Extras - Query Builder 3.17.0)

java.lang.Object
- org.apache.jena.arq.querybuilder.handlers.WhereHandler

All Implemented Interfaces:

Handler
```
public class WhereHandler
extends Object
implements Handler
```
The where handler. Generally handles GroupGraphPattern.

See Also:

SPARQL 11 Query Language - Group Graph Pattern

Constructor Summary

Constructors
Constructor and Description

WhereHandler()
Creates a where handler with a new query.

WhereHandler(Query query)
Constructor.

Constructors
Constructor and Description
`WhereHandler()` Creates a where handler with a new query.
`WhereHandler(Query query)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAll(WhereHandler whereHandler)` Add all where attributes from the Where Handler argument.
`void`	`addBind(Expr expr, Var var)` Add a binding to the where clause.
`void`	`addBind(String expression, Var var)` Add a binding to the where clause.
`void`	`addFilter(Expr expr)` add an expression as a filter.
`void`	`addFilter(String expression)` Add an expression string as a filter.
`void`	`addGraph(Node graph, TriplePath subQuery)` Add a graph to the where clause.
`void`	`addGraph(Node graph, WhereHandler subQuery)` Add a graph to the where clause.
`void`	`addMinus(AbstractQueryBuilder<?> qb)` Add a minus operation to the where clause.
`void`	`addOptional(TriplePath t)` Add an optional triple to the where clause
`void`	`addOptional(WhereHandler whereHandler)` Add the contents of a where handler as an optional statement.
`void`	`addSubQuery(AbstractQueryBuilder<?> subQuery)` Add a subquery to the where clause.
`void`	`addUnion(AbstractQueryBuilder<?> subQuery)` Add a union to the where clause.
`void`	`addValueRow(PrefixMapping prefixMapping, Collection<?> values)`
`void`	`addValueRow(PrefixMapping prefixMapping, Object... values)`
`void`	`addValueVar(PrefixMapping prefixMapping, Object var)`
`void`	`addValueVar(PrefixMapping prefixMapping, Object var, Object... objects)`
`<K extends Collection<?>> void`	`addValueVars(PrefixMapping prefixMapping, Map<?,K> dataTable)`
`void`	`addWhere(TriplePath t)` Add the triple path to the where clause
`void`	`addWhere(ValuesHandler values)` Add the triple path to the where clause
`void`	`build()` Called by the build process for this handler to perform any adjustments to the query before the build completes.
`void`	`clearValues()`
`ElementGroup`	`getClause()` Get the element group for the clause.
`Element`	`getElement()` Get the base element from the where clause.
`Query`	`getQuery()`
`Element`	`getQueryPattern()` Get the query pattern from this where handler.
`Map<Var,List<Node>>`	`getValuesMap()`
`List<Var>`	`getValuesVars()`
`Node`	`list(Object... objs)` Create a list node from a list of objects as per RDF Collections.
`ElementSubQuery`	`makeSubQuery(AbstractQueryBuilder<?> subQuery)` Convert a subquery into a subquery element.
`void`	`setVars(Map<Var,Node> values)` Set the values for variables managed by the handler implementation.

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

- Constructor Detail
  - WhereHandler
```
public WhereHandler(Query query)
```
    Constructor.
    
    Parameters:
    
    query - The query to manipulate.
  - WhereHandler
```
public WhereHandler()
```
    Creates a where handler with a new query.
- Method Detail
  - getQueryPattern
```
public Element getQueryPattern()
```
    Get the query pattern from this where handler.
    
    Returns:
    
    the query pattern
  - getQuery
```
public Query getQuery()
```
    Returns:
    
    The query this where handler is using.
  - addAll
```
public void addAll(WhereHandler whereHandler)
```
    Add all where attributes from the Where Handler argument.
    
    Parameters:
    
    whereHandler - The Where Handler to copy from.
  - getElement
```
public Element getElement()
```
    Get the base element from the where clause. If the clause does not contain an element return the element group, otherwise return the enclosed element.
    
    Returns:
    
    the base element.
  - getClause
```
public ElementGroup getClause()
```
    Get the element group for the clause. if The element group is not set, create and set it. Public for ExprFactory use.
    
    Returns:
    
    The element group.
  - addWhere
```
public void addWhere(TriplePath t)
              throws IllegalArgumentException
```
    Add the triple path to the where clause
    
    Parameters:
    
    t - The triple path to add.
    
    Throws:
    
    IllegalArgumentException - If the triple path is not a valid triple path for a where clause.
  - addWhere
```
public void addWhere(ValuesHandler values)
              throws IllegalArgumentException
```
    Add the triple path to the where clause
    
    Parameters:
    
    values - The values to add to this where clause.
    
    Throws:
    
    IllegalArgumentException - If the triple path is not a valid triple path for a where clause.
  - addOptional
```
public void addOptional(TriplePath t)
                 throws IllegalArgumentException
```
    Add an optional triple to the where clause
    
    Parameters:
    
    t - The triple path to add.
    
    Throws:
    
    IllegalArgumentException - If the triple is not a valid triple for a where clause.
  - addOptional
```
public void addOptional(WhereHandler whereHandler)
```
    Add the contents of a where handler as an optional statement.
    
    Parameters:
    
    whereHandler - The where handler to use as the optional statement.
  - addFilter
```
public void addFilter(String expression)
               throws ParseException
```
    Add an expression string as a filter.
    
    Parameters:
    
    expression - The expression string to add.
    
    Throws:
    
    ParseException - If the expression can not be parsed.
  - addFilter
```
public void addFilter(Expr expr)
```
    add an expression as a filter.
    
    Parameters:
    
    expr - The expression to add.
  - addSubQuery
```
public void addSubQuery(AbstractQueryBuilder<?> subQuery)
```
    Add a subquery to the where clause.
    
    Parameters:
    
    subQuery - The sub query to add.
  - makeSubQuery
```
public ElementSubQuery makeSubQuery(AbstractQueryBuilder<?> subQuery)
```
    Convert a subquery into a subquery element.
    
    Parameters:
    
    subQuery - The sub query to convert
    
    Returns:
    
    THe converted element.
  - addUnion
```
public void addUnion(AbstractQueryBuilder<?> subQuery)
```
    Add a union to the where clause.
    
    Parameters:
    
    subQuery - The subquery to add as the union.
  - addGraph
```
public void addGraph(Node graph,
                     WhereHandler subQuery)
```
    Add a graph to the where clause.
    
    Parameters:
    
    graph - The name of the graph.
    
    subQuery - The where handler that defines the graph.
  - addGraph
```
public void addGraph(Node graph,
                     TriplePath subQuery)
```
    Add a graph to the where clause. Short hand for graph { s, p, o }
    
    Parameters:
    
    graph - The name of the graph.
    
    subQuery - A triple path to add to the graph.
  - addBind
```
public void addBind(Expr expr,
                    Var var)
```
    Add a binding to the where clause.
    
    Parameters:
    
    expr - The expression to bind.
    
    var - The variable to bind it to.
  - addBind
```
public void addBind(String expression,
                    Var var)
             throws ParseException
```
    Add a binding to the where clause.
    
    Parameters:
    
    expression - The expression to bind.
    
    var - The variable to bind it to.
    
    Throws:
    
    ParseException
  - setVars
```
public void setVars(Map<Var,Node> values)
```
    Description copied from interface: Handler
    
    Set the values for variables managed by the handler implementation. This method is called by the builder to set values handled by this Handler implementation.
    
    Specified by:
    
    setVars in interface Handler
    
    Parameters:
    
    values - The map of variable to node value.
  - build
```
public void build()
```
    Description copied from interface: Handler
    
    Called by the build process for this handler to perform any adjustments to the query before the build completes. The adjustments are made after setVars() has been called.
    
    Specified by:
    
    build in interface Handler
  - list
```
public Node list(Object... objs)
```
    Create a list node from a list of objects as per RDF Collections. http://www.w3.org/TR/2013/REC-sparql11-query-20130321/#collections
    
    Parameters:
    
    objs - the list of objects for the list.
    
    Returns:
    
    the first blank node in the list.
  - addMinus
```
public void addMinus(AbstractQueryBuilder<?> qb)
```
    Add a minus operation to the where clause. The prolog will be updated with the prefixes from the abstract query builder.
    
    Parameters:
    
    qb - the abstract builder that defines the data to subtract.
  - addValueVar
```
public void addValueVar(PrefixMapping prefixMapping,
                        Object var)
```
  - addValueVar
```
public void addValueVar(PrefixMapping prefixMapping,
                        Object var,
                        Object... objects)
```
  - addValueVars
```
public <K extends Collection<?>> void addValueVars(PrefixMapping prefixMapping,
                                                   Map<?,K> dataTable)
```
  - addValueRow
```
public void addValueRow(PrefixMapping prefixMapping,
                        Object... values)
```
  - addValueRow
```
public void addValueRow(PrefixMapping prefixMapping,
                        Collection<?> values)
```
  - getValuesVars
```
public List<Var> getValuesVars()
```
  - getValuesMap
```
public Map<Var,List<Node>> getValuesMap()
```
  - clearValues
```
public void clearValues()
```

Class WhereHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WhereHandler

WhereHandler

Method Detail

getQueryPattern

getQuery

addAll

getElement

getClause

addWhere

addWhere

addOptional

addOptional

addFilter

addFilter

addSubQuery

makeSubQuery

addUnion

addGraph

addGraph

addBind

addBind

setVars

build

list

addMinus

addValueVar

addValueVar

addValueVars

addValueRow

addValueRow

getValuesVars

getValuesMap

clearValues