com.bigdata.rdf.sparql.ast

Class QueryRoot

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

com.bigdata.rdf.sparql.ast.QueryRoot

All Implemented Interfaces:

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

public class QueryRoot
extends QueryBase
implements IPrefixDecls, IDataSetNode

The top-level Query.

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryRoot.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
QueryRoot(BOp[] args, Map<String,Object> anns)
QueryRoot(QueryRoot queryRoot) Deep copy constructor.
QueryRoot(QueryType queryType)

Method Summary

Methods

Modifier and Type	Method and Description
DatasetNode	getDataset() Return the dataset.
NamedSubqueriesNode	getNamedSubqueries() Return the node for the named subqueries -or- null if it does not exist.
NamedSubqueriesNode	getNamedSubqueriesNotNull() Return the node for the named subqueries.
Map<String,String>	getPrefixDecls() The namespace prefix declarations map.
void	setDataset(DatasetNode dataset) Set the dataset.
void	setNamedSubqueries(NamedSubqueriesNode namedSubqueries) Set or clear the named subqueries node.
void	setParent(IGroupNode<?> parent) This is a root node.
void	setPrefixDecls(Map<String,String> prefixDecls) Set the namespace prefix declarations map.
String	toString(int indent) The contract of this method at this level is under-specified.
String	toString(int indent, IBindingSet[] bs)

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

getBindingsClause, getConstruct, getGraphPattern, getGroupBy, getHaving, getIncludeInferred, getOrderBy, getProjectedVars, getProjection, getQueryType, getSelectExprVars, getSlice, getTimeout, getWhereClause, hasSlice, hasWhereClause, setBindingsClause, setConstruct, setGraphPattern, setGroupBy, setHaving, setIncludeInferred, setOrderBy, setProjection, setQueryType, setSlice, setTimeout, setWhereClause

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

QueryRoot

public QueryRoot(QueryRoot queryRoot)

Deep copy constructor.

Parameters:

queryRoot -

QueryRoot

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

QueryRoot

public QueryRoot(QueryType queryType)

Method Detail

setParent

public void setParent(IGroupNode<?> parent)

This is a root node. It may not be attached as a child of another node.

Throws:

UnsupportedOperationException

getPrefixDecls

public Map<String,String> getPrefixDecls()

Description copied from interface: IPrefixDecls

The namespace prefix declarations map. This is a Map with String keys (prefix) and String values (the uri associated with that prefix).

Specified by:

getPrefixDecls in interface IPrefixDecls

Returns:

The namespace prefix declarations map. If this annotation was not set, then an empty map will be returned. The returned map is immutable to preserve the general contract for notification on mutation.

setPrefixDecls

public void setPrefixDecls(Map<String,String> prefixDecls)

Description copied from interface: IPrefixDecls

Set the namespace prefix declarations map. This is a Map with String keys (prefix) and String values (the uri associated with that prefix).

Specified by:

setPrefixDecls in interface IPrefixDecls

setDataset

public void setDataset(DatasetNode dataset)

Description copied from interface: IDataSetNode

Set the dataset.

Specified by:

setDataset in interface IDataSetNode

getDataset

public DatasetNode getDataset()

Description copied from interface: IDataSetNode

Return the dataset.

Specified by:

getDataset in interface IDataSetNode

getNamedSubqueries

public NamedSubqueriesNode getNamedSubqueries()

Return the node for the named subqueries -or- null if it does not exist.

See Also:

getNamedSubqueriesNotNull()

getNamedSubqueriesNotNull

public NamedSubqueriesNode getNamedSubqueriesNotNull()

Return the node for the named subqueries. If the node does not exist then it is created, set on the QueryRoot and returned. This helps out with what is otherwise an awkward conditional construction pattern.

setNamedSubqueries

public void setNamedSubqueries(NamedSubqueriesNode namedSubqueries)

Set or clear the named subqueries node.

Parameters:

namedSubqueries - The named subqueries not (may be null).

See Also:

getNamedSubqueriesNotNull()

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 QueryBase

Returns:

toString

public String toString(int indent,
              IBindingSet[] bs)