com.bigdata.rdf.sparql.ast

Class QueryBase

java.lang.Object

com.bigdata.bop.CoreBaseBOp

com.bigdata.bop.ModifiableBOpBase

com.bigdata.rdf.sparql.ast.ASTBase

com.bigdata.rdf.sparql.ast.QueryNodeBase

com.bigdata.rdf.sparql.ast.QueryBase

All Implemented Interfaces:

BOp, IBindingProducerNode, IGraphPatternContainer, IProjectionDecl, IQueryNode, IPropertySet, Serializable, Cloneable

Direct Known Subclasses:

QueryRoot, SubqueryBase

public abstract class QueryBase
extends QueryNodeBase
implements IBindingProducerNode, IGraphPatternContainer, IProjectionDecl

Contains the projection clause, where clause, and solution modified clauses.

See Also:

IGroupNode, ProjectionNode, GroupByNode, HavingNode, OrderByNode, SliceNode, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryBase.Annotations

Field Summary

Fields inherited from class com.bigdata.bop.CoreBaseBOp

DEFAULT_INITIAL_CAPACITY

Fields inherited from interface com.bigdata.bop.BOp

NOANNS, NOARGS

Constructor Summary

Constructors

Constructor and Description
QueryBase(BOp[] args, Map<String,Object> anns) Shallow copy constructor.
QueryBase(QueryBase queryBase) Deep copy constructor.
QueryBase(QueryType queryType)

Method Summary

Methods

Modifier and Type	Method and Description
BindingsClause	getBindingsClause() Return the BINDINGS.
ConstructNode	getConstruct() Return the construction -or- null if there is no construction.
GraphPatternGroup<IGroupMemberNode>	getGraphPattern() Return the graph pattern.
GroupByNode	getGroupBy() Return the GroupByNode -or- null if there is none.
HavingNode	getHaving() Return the HavingNode -or- null if there is none.
boolean	getIncludeInferred()
OrderByNode	getOrderBy() Return the order by clause -or- null if there is no order by.
Set<IVariable<?>>	getProjectedVars(Set<IVariable<?>> vars) Return the set of variables projected out of this query (this is a NOP if there is no ProjectionNode for the query, which can happen for an ASK query).
ProjectionNode	getProjection() Return the projection -or- null if there is no projection.
QueryType	getQueryType() Return the type of query.
Set<IVariable<?>>	getSelectExprVars(Set<IVariable<?>> vars) Return the set of variables on which the ProjectionNode for this query depends (this is a NOP if there is no ProjectionNode for the query, which can happen for an ASK query).
SliceNode	getSlice() Return the slice -or- null if there is no slice.
long	getTimeout()
GraphPatternGroup	getWhereClause() Return the GraphPatternGroup for the WHERE clause.
boolean	hasSlice() Return true iff there is a SliceNode and either the LIMIT and/or OFFSET has been specified with a non-default value.
boolean	hasWhereClause() Return true if this query has a WHERE clause, false if not.
void	setBindingsClause(BindingsClause bindings) Set the BINDINGS.
void	setConstruct(ConstructNode construct) Set or clear the construction.
void	setGraphPattern(GraphPatternGroup<IGroupMemberNode> graphPattern) Set the graph pattern.
void	setGroupBy(GroupByNode groupBy) Set or clear the GroupByNode.
void	setHaving(HavingNode having) Set or clear the HavingNode.
void	setIncludeInferred(boolean includeInferred)
void	setOrderBy(OrderByNode orderBy) Set or clear the OrderByNode.
void	setProjection(ProjectionNode projection) Set or clear the projection.
void	setQueryType(QueryType queryType) Set the type of query.
void	setSlice(SliceNode slice) Set or clear the slice.
void	setTimeout(long timeout) Set the timeout (milliseconds) for the query.
void	setWhereClause(GraphPatternGroup whereClause) Set the GraphPatternGroup for the WHERE clause.
String	toString(int indent) The contract of this method at this level is under-specified.

Methods inherited from class com.bigdata.rdf.sparql.ast.QueryNodeBase

getQueryHints, toString

Methods inherited from class com.bigdata.rdf.sparql.ast.ASTBase

addExplainHint, getExplainHints, getQueryHint, getQueryHint, getQueryHintAsBoolean, getQueryHintAsBoolean, getQueryHintAsInteger, replaceAllWith, setQueryHint, setQueryHints

Methods inherited from class com.bigdata.bop.ModifiableBOpBase

addArg, addArg, addArgIfAbsent, annotations, annotationsEqual, argIterator, args, arity, clearProperty, copyAll, get, getProperty, indexOf, removeArg, replaceWith, setArg, setArgs, setId, setProperty, setUnboundProperty, toArray, toArray

Methods inherited from class com.bigdata.bop.CoreBaseBOp

annotationsEqual, annotationsToString, annotationsToString, annotationValueToString, checkArgs, clone, equals, getEvaluationContext, getId, getProperty, getRequiredProperty, hashCode, indent, isController, mutation, shortenName, toShortString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.bigdata.bop.BOp

annotations, argIterator, args, arity, clone, get, getEvaluationContext, getId, getProperty, getRequiredProperty, isController, setProperty, toArray, toArray, toShortString, toString

Methods inherited from interface cutthecrap.utils.striterators.IPropertySet

getProperty

Constructor Detail

QueryBase

public QueryBase(QueryBase queryBase)

Deep copy constructor.

QueryBase

public QueryBase(BOp[] args,
         Map<String,Object> anns)

Shallow copy constructor.

QueryBase

public QueryBase(QueryType queryType)

Method Detail

getQueryType

public QueryType getQueryType()

Return the type of query. This provides access to information which may otherwise be difficult to determine by inspecting the generated AST or query plan.

setQueryType

public void setQueryType(QueryType queryType)

Set the type of query.

getConstruct

public ConstructNode getConstruct()

Return the construction -or- null if there is no construction.

setConstruct

public void setConstruct(ConstructNode construct)

Set or clear the construction.

Parameters:

construction - The construction (may be null).

setProjection

public void setProjection(ProjectionNode projection)

Description copied from interface: IProjectionDecl

Set or clear the projection.

Specified by:

setProjection in interface IProjectionDecl

Parameters:

projection - The projection (may be null).

getProjection

public ProjectionNode getProjection()

Description copied from interface: IProjectionDecl

Return the projection -or- null if there is no projection.

Specified by:

getProjection in interface IProjectionDecl

getProjectedVars

public Set<IVariable<?>> getProjectedVars(Set<IVariable<?>> vars)

Description copied from interface: IProjectionDecl

Return the set of variables projected out of this query (this is a NOP if there is no ProjectionNode for the query, which can happen for an ASK query). This DOES NOT report the variables which are used by the SELECT expressions, just the variables which are PROJECTED out by the BINDs.

Specified by:

getProjectedVars in interface IProjectionDecl

Parameters:

vars - The projected variables are added to this set.

Returns:

The caller's set.

getSelectExprVars

public Set<IVariable<?>> getSelectExprVars(Set<IVariable<?>> vars)

Return the set of variables on which the ProjectionNode for this query depends (this is a NOP if there is no ProjectionNode for the query, which can happen for an ASK query). This DOES NOT report the variables which are projected OUT of the query, just those used by the SELECT expressions.

Parameters:

vars - The variables used by the select expressions are added to this set.

Returns:

The caller's set.

getWhereClause

public GraphPatternGroup getWhereClause()

Return the GraphPatternGroup for the WHERE clause.

Returns:

The WHERE clause -or- null.

getGraphPattern

public GraphPatternGroup<IGroupMemberNode> getGraphPattern()

Description copied from interface: IGraphPatternContainer

Return the graph pattern.

Specified by:

getGraphPattern in interface IGraphPatternContainer

setGraphPattern

public void setGraphPattern(GraphPatternGroup<IGroupMemberNode> graphPattern)

Description copied from interface: IGraphPatternContainer

Set the graph pattern.

Specified by:

setGraphPattern in interface IGraphPatternContainer

setWhereClause

public void setWhereClause(GraphPatternGroup whereClause)

Set the GraphPatternGroup for the WHERE clause.

Parameters:

whereClause - The "WHERE" clause.

hasWhereClause

public boolean hasWhereClause()

Return true if this query has a WHERE clause, false if not.

getGroupBy

public GroupByNode getGroupBy()

Return the GroupByNode -or- null if there is none.

setGroupBy

public void setGroupBy(GroupByNode groupBy)

Set or clear the GroupByNode.

Parameters:

groupBy - The new value (may be null).

getHaving

public HavingNode getHaving()

Return the HavingNode -or- null if there is none.

setHaving

public void setHaving(HavingNode having)

Set or clear the HavingNode.

Parameters:

having - The new value (may be null).

getSlice

public SliceNode getSlice()

Return the slice -or- null if there is no slice.

setSlice

public void setSlice(SliceNode slice)

Set or clear the slice.

Parameters:

slice - The slice (may be null).

hasSlice

public boolean hasSlice()

Return true iff there is a SliceNode and either the LIMIT and/or OFFSET has been specified with a non-default value.

getOrderBy

public OrderByNode getOrderBy()

Return the order by clause -or- null if there is no order by.

setOrderBy

public void setOrderBy(OrderByNode orderBy)

Set or clear the OrderByNode.

Parameters:

orderBy - The order by (may be null).

getIncludeInferred

public boolean getIncludeInferred()

See Also:

QueryBase.Annotations.INCLUDE_INFERRED

setIncludeInferred

public void setIncludeInferred(boolean includeInferred)

See Also:

QueryBase.Annotations.INCLUDE_INFERRED

getTimeout

public long getTimeout()

See Also:

QueryBase.Annotations.TIMEOUT

setTimeout

public void setTimeout(long timeout)

Set the timeout (milliseconds) for the query.

See Also:

QueryBase.Annotations.TIMEOUT

setBindingsClause

public void setBindingsClause(BindingsClause bindings)

Set the BINDINGS.

Parameters:

bindings -

getBindingsClause

public BindingsClause getBindingsClause()

Return the BINDINGS.

toString

public String toString(int indent)

Description copied from class: CoreBaseBOp

The contract of this method at this level is under-specified. Sub-classes may choose between: - return a string representation of the object, similar to the use of CoreBaseBOp.toString() Or: - return a pretty-print representation of the object with indent Note that the former contract may or may not include recursive descent through a tree-like object, whereas the latter almost certainly does.

Specified by:

toString in interface BOp

Specified by:

toString in interface IQueryNode

Overrides:

toString in class CoreBaseBOp

Returns: