Query (Apache Jena ARQ)

java.lang.Object
- com.hp.hpl.jena.sparql.core.Prologue
- - com.hp.hpl.jena.query.Query

All Implemented Interfaces:

Cloneable, Printable
```
public class Query
extends Prologue
implements Cloneable, Printable
```
The data structure for a query as presented externally. There are two ways of creating a query - use the parser to turn a string description of the query into the executable form, and the programmatic way (the parser is calling the programmatic operations driven by the quyery string). The declarative approach of passing in a string is preferred. Once a query is built, it can be passed to the QueryFactory to produce a query execution engine.

See Also:
QueryExecutionFactory, ResultSet

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`NOLIMIT`
`static int`	`ORDER_ASCENDING`
`static int`	`ORDER_DEFAULT`
`static int`	`ORDER_DESCENDING`
`static int`	`ORDER_UNKNOW`
`static int`	`QueryTypeAsk`
`static int`	`QueryTypeConstruct`
`static int`	`QueryTypeDescribe`
`static int`	`QueryTypeSelect`
`static int`	`QueryTypeUnknown`

Constructor Summary

Constructors
Constructor and Description

Query()
Creates a new empty query

Query(Prologue prologue)
Creates a new empty query with the given prologue

Constructors
Constructor and Description
`Query()` Creates a new empty query
`Query(Prologue prologue)` Creates a new empty query with the given prologue

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDescribeNode(Node node)`
`void`	`addGraphURI(String s)` Location of the source for the data.
`void`	`addGroupBy(Expr expr)`
`void`	`addGroupBy(Node v)`
`void`	`addGroupBy(String varName)`
`void`	`addGroupBy(Var v, Expr expr)`
`void`	`addHavingCondition(Expr expr)`
`void`	`addNamedGraphURI(String uri)` Location of the source for the data.
`void`	`addOrderBy(Expr expr, int direction)`
`void`	`addOrderBy(Node var, int direction)`
`void`	`addOrderBy(SortCondition condition)`
`void`	`addOrderBy(String varName, int direction)`
`void`	`addProjectVars(Collection<?> vars)` Add a collection of projection variables to a SELECT query
`void`	`addResultVar(Expr expr)` Add an to a SELECT query (a name will be created for it)
`void`	`addResultVar(Node v)`
`void`	`addResultVar(Node v, Expr expr)`
`void`	`addResultVar(String varName)` Add a projection variable to a SELECT query
`void`	`addResultVar(String varName, Expr expr)` Add a named expression to a SELECT query
`Expr`	`allocAggregate(Aggregator agg)`
`Object`	`clone()`
`Query`	`cloneQuery()` Makes a copy of this query.
`Query`	`cloneQuery(boolean useRawQuery)` Makes a copy of this query.
`boolean`	`equals(Object other)` Are two queries equals - tests shape and details.
`List<ExprAggregator>`	`getAggregators()`
`Template`	`getConstructTemplate()` Get the template pattern for a construct query
`DatasetDescription`	`getDatasetDescription()` Return a dataset description (FROM/FROM NAMED clauses) for the query.
`List<String>`	`getGraphURIs()` Return the list of URIs (strings) for the unnamed graph
`VarExprList`	`getGroupBy()`
`List<Expr>`	`getHavingExprs()`
`long`	`getLimit()`
`List<String>`	`getNamedGraphURIs()` Return the list of URIs (strings) for the named graphs (FROM NAMED clause)
`long`	`getOffset()`
`List<SortCondition>`	`getOrderBy()`
`VarExprList`	`getProject()`
`List<Var>`	`getProjectVars()` Return a list of the variables requested (SELECT)
`Prologue`	`getPrologue()`
`Element`	`getQueryPattern()`
`int`	`getQueryType()`
`List<Node>`	`getResultURIs()` Get the result list (things wanted - not the results themselves) of a DESCRIBE query.
`List<String>`	`getResultVars()` Return a list of the variables requested (SELECT)
`Syntax`	`getSyntax()`
`List<Binding>`	`getValuesData()` VALUES data - null for a Node means undef
`List<Var>`	`getValuesVariables()`
`boolean`	`hasAggregators()`
`boolean`	`hasDatasetDescription()` Return true if the query has either some graph URIs or some named graph URIs in its description.
`boolean`	`hasGroupBy()`
`boolean`	`hasHaving()`
`int`	`hashCode()`
`boolean`	`hasLimit()`
`boolean`	`hasOffset()`
`boolean`	`hasOrderBy()`
`boolean`	`hasValues()` Does the query have a VALUES trailing block?
`boolean`	`isAskType()`
`boolean`	`isConstructType()`
`boolean`	`isDescribeType()`
`boolean`	`isDistinct()`
`boolean`	`isOrdered()`
`boolean`	`isQueryResultStar()` Answer whether the query had SELECT/DESCRIBE/CONSTRUCT *
`boolean`	`isReduced()`
`boolean`	`isSelectType()`
`boolean`	`isStrict()`
`boolean`	`isUnknownType()`
`void`	`output(IndentedWriter out)`
`String`	`serialize()` Convert the query to a string
`void`	`serialize(IndentedLineBuffer buff)` Format the query into the buffer
`void`	`serialize(IndentedLineBuffer buff, Syntax outSyntax)` Format the query
`void`	`serialize(IndentedWriter writer)` Format the query
`void`	`serialize(IndentedWriter writer, Syntax outSyntax)` Format the query
`void`	`serialize(OutputStream out)` Output the query
`void`	`serialize(OutputStream out, Syntax syntax)` Output the query
`String`	`serialize(Syntax syntax)` Convert the query to a string in the given syntax
`void`	`setConstructTemplate(Template templ)` Set triple patterns for a construct query
`void`	`setDistinct(boolean b)`
`void`	`setLimit(long limit)`
`void`	`setOffset(long offset)`
`void`	`setQueryAskType()`
`void`	`setQueryConstructType()`
`void`	`setQueryDescribeType()`
`void`	`setQueryPattern(Element elt)`
`void`	`setQueryResultStar(boolean isQueryStar)` Set whether the query had SELECT/DESCRIBE * Strictly, this just means whether the projection is
`void`	`setQuerySelectType()`
`void`	`setReduced(boolean b)`
`void`	`setResultVars()` Fix up when the query has "" (when SELECT or DESCRIBE *) and for a construct query.
`void`	`setStrict(boolean isStrict)`
`void`	`setSyntax(Syntax syntax)`
`void`	`setValuesDataBlock(List<Var> variables, List<Binding> values)`
`String`	`toString()`
`String`	`toString(Syntax syntax)`
`boolean`	`usesGraphURI(String uri)` Test whether the query mentions a URI in forming the default graph (FROM clause)
`boolean`	`usesNamedGraphURI(String uri)` Test whether the query mentions a URI for a named graph.
`void`	`visit(QueryVisitor visitor)`

Methods inherited from class com.hp.hpl.jena.sparql.core.Prologue
copy, expandPrefixedName, explicitlySetBaseURI, getBaseURI, getPrefix, getPrefixMapping, getResolver, setBaseURI, setBaseURI, setPrefix, setPrefixMapping, setResolver, shortForm, sub, sub, sub, usePrologueFrom

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

- Field Detail
  - QueryTypeUnknown
```
public static final int QueryTypeUnknown
```
    See Also:
    Constant Field Values
  - QueryTypeSelect
```
public static final int QueryTypeSelect
```
    See Also:
    Constant Field Values
  - QueryTypeConstruct
```
public static final int QueryTypeConstruct
```
    See Also:
    Constant Field Values
  - QueryTypeDescribe
```
public static final int QueryTypeDescribe
```
    See Also:
    Constant Field Values
  - QueryTypeAsk
```
public static final int QueryTypeAsk
```
    See Also:
    Constant Field Values
  - NOLIMIT
```
public static final long NOLIMIT
```
    See Also:
    Constant Field Values
  - ORDER_ASCENDING
```
public static final int ORDER_ASCENDING
```
    See Also:
    Constant Field Values
  - ORDER_DESCENDING
```
public static final int ORDER_DESCENDING
```
    See Also:
    Constant Field Values
  - ORDER_DEFAULT
```
public static final int ORDER_DEFAULT
```
    See Also:
    Constant Field Values
  - ORDER_UNKNOW
```
public static final int ORDER_UNKNOW
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Query
```
public Query()
```
    Creates a new empty query
  - Query
```
public Query(Prologue prologue)
```
    Creates a new empty query with the given prologue
- Method Detail
  - setQuerySelectType
```
public void setQuerySelectType()
```
  - setQueryConstructType
```
public void setQueryConstructType()
```
  - setQueryDescribeType
```
public void setQueryDescribeType()
```
  - setQueryAskType
```
public void setQueryAskType()
```
  - getQueryType
```
public int getQueryType()
```
  - isSelectType
```
public boolean isSelectType()
```
  - isConstructType
```
public boolean isConstructType()
```
  - isDescribeType
```
public boolean isDescribeType()
```
  - isAskType
```
public boolean isAskType()
```
  - isUnknownType
```
public boolean isUnknownType()
```
  - getPrologue
```
public Prologue getPrologue()
```
  - setStrict
```
public void setStrict(boolean isStrict)
```
  - isStrict
```
public boolean isStrict()
```
  - setDistinct
```
public void setDistinct(boolean b)
```
  - isDistinct
```
public boolean isDistinct()
```
  - setReduced
```
public void setReduced(boolean b)
```
  - isReduced
```
public boolean isReduced()
```
  - getSyntax
```
public Syntax getSyntax()
```
    Returns:
    Returns the syntax.
  - setSyntax
```
public void setSyntax(Syntax syntax)
```
    Parameters:
    syntax - The syntax to set.
  - getLimit
```
public long getLimit()
```
  - setLimit
```
public void setLimit(long limit)
```
  - hasLimit
```
public boolean hasLimit()
```
  - getOffset
```
public long getOffset()
```
  - setOffset
```
public void setOffset(long offset)
```
  - hasOffset
```
public boolean hasOffset()
```
  - hasOrderBy
```
public boolean hasOrderBy()
```
  - isOrdered
```
public boolean isOrdered()
```
  - addOrderBy
```
public void addOrderBy(SortCondition condition)
```
  - addOrderBy
```
public void addOrderBy(Expr expr,
              int direction)
```
  - addOrderBy
```
public void addOrderBy(Node var,
              int direction)
```
  - addOrderBy
```
public void addOrderBy(String varName,
              int direction)
```
  - getOrderBy
```
public List<SortCondition> getOrderBy()
```
  - isQueryResultStar
```
public boolean isQueryResultStar()
```
    Answer whether the query had SELECT/DESCRIBE/CONSTRUCT *
    
    Returns:
    boolean as to whether a * result form was seen
  - setQueryResultStar
```
public void setQueryResultStar(boolean isQueryStar)
```
    Set whether the query had SELECT/DESCRIBE * Strictly, this just means whether the projection is
    
    Parameters:
    isQueryStar -
  - setQueryPattern
```
public void setQueryPattern(Element elt)
```
  - getQueryPattern
```
public Element getQueryPattern()
```
  - addGraphURI
```
public void addGraphURI(String s)
```
    Location of the source for the data. If the model is not set, then the QueryEngine will attempt to load the data from these URIs into the default (unamed) graph.
  - addNamedGraphURI
```
public void addNamedGraphURI(String uri)
```
    Location of the source for the data. If the model is not set, then the QueryEngine will attempt to load the data from these URIs as named graphs in the dataset.
  - getGraphURIs
```
public List<String> getGraphURIs()
```
    Return the list of URIs (strings) for the unnamed graph
    
    Returns:
    List of strings
  - usesGraphURI
```
public boolean usesGraphURI(String uri)
```
    Test whether the query mentions a URI in forming the default graph (FROM clause)
    
    Parameters:
    uri -
    
    Returns:
    boolean True if the URI used in a FROM clause
  - getNamedGraphURIs
```
public List<String> getNamedGraphURIs()
```
    Return the list of URIs (strings) for the named graphs (FROM NAMED clause)
    
    Returns:
    List of strings
  - usesNamedGraphURI
```
public boolean usesNamedGraphURI(String uri)
```
    Test whether the query mentions a URI for a named graph.
    
    Parameters:
    uri -
    
    Returns:
    True if the URI used in a FROM NAMED clause
  - hasDatasetDescription
```
public boolean hasDatasetDescription()
```
    Return true if the query has either some graph URIs or some named graph URIs in its description. This does not mean these URIs will be used - just that they are noted as part of the query.
  - getDatasetDescription
```
public DatasetDescription getDatasetDescription()
```
    Return a dataset description (FROM/FROM NAMED clauses) for the query.
  - getResultVars
```
public List<String> getResultVars()
```
    Return a list of the variables requested (SELECT)
  - getProjectVars
```
public List<Var> getProjectVars()
```
    Return a list of the variables requested (SELECT)
  - getProject
```
public VarExprList getProject()
```
  - addProjectVars
```
public void addProjectVars(Collection<?> vars)
```
    Add a collection of projection variables to a SELECT query
  - addResultVar
```
public void addResultVar(String varName)
```
    Add a projection variable to a SELECT query
  - addResultVar
```
public void addResultVar(Node v)
```
  - addResultVar
```
public void addResultVar(Node v,
                Expr expr)
```
  - addResultVar
```
public void addResultVar(Expr expr)
```
    Add an to a SELECT query (a name will be created for it)
  - addResultVar
```
public void addResultVar(String varName,
                Expr expr)
```
    Add a named expression to a SELECT query
  - hasGroupBy
```
public boolean hasGroupBy()
```
  - hasHaving
```
public boolean hasHaving()
```
  - getGroupBy
```
public VarExprList getGroupBy()
```
  - getHavingExprs
```
public List<Expr> getHavingExprs()
```
  - addGroupBy
```
public void addGroupBy(String varName)
```
  - addGroupBy
```
public void addGroupBy(Node v)
```
  - addGroupBy
```
public void addGroupBy(Expr expr)
```
  - addGroupBy
```
public void addGroupBy(Var v,
              Expr expr)
```
  - addHavingCondition
```
public void addHavingCondition(Expr expr)
```
  - hasAggregators
```
public boolean hasAggregators()
```
  - getAggregators
```
public List<ExprAggregator> getAggregators()
```
  - allocAggregate
```
public Expr allocAggregate(Aggregator agg)
```
  - hasValues
```
public boolean hasValues()
```
    Does the query have a VALUES trailing block?
  - getValuesVariables
```
public List<Var> getValuesVariables()
```
  - getValuesData
```
public List<Binding> getValuesData()
```
    VALUES data - null for a Node means undef
  - setValuesDataBlock
```
public void setValuesDataBlock(List<Var> variables,
                      List<Binding> values)
```
  - getConstructTemplate
```
public Template getConstructTemplate()
```
    Get the template pattern for a construct query
  - setConstructTemplate
```
public void setConstructTemplate(Template templ)
```
    Set triple patterns for a construct query
  - addDescribeNode
```
public void addDescribeNode(Node node)
```
  - getResultURIs
```
public List<Node> getResultURIs()
```
    Get the result list (things wanted - not the results themselves) of a DESCRIBE query.
  - setResultVars
```
public void setResultVars()
```
    Fix up when the query has "*" (when SELECT * or DESCRIBE *) and for a construct query. This operation is idempotent.
  - visit
```
public void visit(QueryVisitor visitor)
```
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - cloneQuery
```
public Query cloneQuery()
```
    Makes a copy of this query. Copies by parsing a query from the serialized form of this query
    
    Returns:
    Copy of this query
  - cloneQuery
```
public Query cloneQuery(boolean useRawQuery)
```
    Makes a copy of this query. May specify whether is cloned by parsing from original raw query or by parsing from serialized form of this query
    
    Parameters:
    useRawQuery - Copy from raw query if present
    
    Returns:
    Copy of this query
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(Syntax syntax)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Are two queries equals - tests shape and details. Equality means that the queries do the same thing, including same variables, in the same places. Being unequals does not mean the queries do different things. For example, reordering a group or union means that that a query is different. Two instances of a query parsed from the same string are equal.
    
    Overrides:
    
    equals in class Object
  - output
```
public void output(IndentedWriter out)
```
    Specified by:
    
    output in interface Printable
  - serialize
```
public String serialize()
```
    Convert the query to a string
  - serialize
```
public String serialize(Syntax syntax)
```
    Convert the query to a string in the given syntax
    
    Parameters:
    syntax -
  - serialize
```
public void serialize(OutputStream out)
```
    Output the query
    
    Parameters:
    out - OutputStream
  - serialize
```
public void serialize(OutputStream out,
             Syntax syntax)
```
    Output the query
    
    Parameters:
    out - OutputStream
    syntax - Syntax URI
  - serialize
```
public void serialize(IndentedLineBuffer buff)
```
    Format the query into the buffer
    
    Parameters:
    buff - IndentedLineBuffer
  - serialize
```
public void serialize(IndentedLineBuffer buff,
             Syntax outSyntax)
```
    Format the query
    
    Parameters:
    buff - IndentedLineBuffer in which to place the unparsed query
    outSyntax - Syntax URI
  - serialize
```
public void serialize(IndentedWriter writer)
```
    Format the query
    
    Parameters:
    writer - IndentedWriter
  - serialize
```
public void serialize(IndentedWriter writer,
             Syntax outSyntax)
```
    Format the query
    
    Parameters:
    writer - IndentedWriter
    outSyntax - Syntax URI

Class Query

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.hp.hpl.jena.sparql.core.Prologue

Methods inherited from class java.lang.Object

Field Detail

QueryTypeUnknown

QueryTypeSelect

QueryTypeConstruct

QueryTypeDescribe

QueryTypeAsk

NOLIMIT

ORDER_ASCENDING

ORDER_DESCENDING

ORDER_DEFAULT

ORDER_UNKNOW

Constructor Detail

Query

Query

Method Detail

setQuerySelectType

setQueryConstructType

setQueryDescribeType

setQueryAskType

getQueryType

isSelectType

isConstructType

isDescribeType

isAskType

isUnknownType

getPrologue

setStrict

isStrict

setDistinct

isDistinct

setReduced

isReduced

getSyntax

setSyntax

getLimit

setLimit

hasLimit

getOffset

setOffset

hasOffset

hasOrderBy

isOrdered

addOrderBy

addOrderBy

addOrderBy

addOrderBy

getOrderBy

isQueryResultStar

setQueryResultStar

setQueryPattern

getQueryPattern

addGraphURI

addNamedGraphURI

getGraphURIs

usesGraphURI

getNamedGraphURIs

usesNamedGraphURI

hasDatasetDescription

getDatasetDescription

getResultVars

getProjectVars

getProject

addProjectVars

addResultVar

addResultVar

addResultVar

addResultVar

addResultVar

hasGroupBy

hasHaving

getGroupBy

getHavingExprs

addGroupBy

addGroupBy