org.apache.phoenix.execute

Class BaseQueryPlan

java.lang.Object

org.apache.phoenix.execute.BaseQueryPlan

All Implemented Interfaces:

QueryPlan, StatementPlan

Direct Known Subclasses:

AggregatePlan, DegenerateQueryPlan, EmptyTableQueryPlan, ScanPlan

public abstract class BaseQueryPlan
extends Object
implements QueryPlan

Query plan that has no child plans

Since:

0.1

Field Summary

Fields

Modifier and Type	Field and Description
protected StatementContext	context
protected static long	DEFAULT_ESTIMATED_SIZE
protected GroupByCompiler.GroupBy	groupBy
protected Integer	limit
protected OrderByCompiler.OrderBy	orderBy
protected ParallelIteratorFactory	parallelIteratorFactory
protected ParameterMetaData	paramMetaData
protected RowProjector	projection
protected FilterableStatement	statement
protected TableRef	tableRef

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseQueryPlan(StatementContext context, FilterableStatement statement, TableRef table, RowProjector projection, ParameterMetaData paramMetaData, Integer limit, OrderByCompiler.OrderBy orderBy, GroupByCompiler.GroupBy groupBy, ParallelIteratorFactory parallelIteratorFactory)

Method Summary

Methods

Modifier and Type	Method and Description
StatementContext	getContext()
long	getEstimatedSize()
ExplainPlan	getExplainPlan()
GroupByCompiler.GroupBy	getGroupBy()
Integer	getLimit()
OrderByCompiler.OrderBy	getOrderBy()
ParameterMetaData	getParameterMetaData() Returns the ParameterMetaData for the statement
RowProjector	getProjector() Returns projector used to formulate resultSet row
FilterableStatement	getStatement()
TableRef	getTableRef()
boolean	isDegenerate()
boolean	isRowKeyOrdered()
ResultIterator	iterator() Get a result iterator to iterate over the results
ResultIterator	iterator(List<? extends SQLCloseable> dependencies, ParallelScanGrouper scanGrouper)
ResultIterator	iterator(ParallelScanGrouper scanGrouper)
protected abstract ResultIterator	newIterator(ParallelScanGrouper scanGrouper)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.phoenix.compile.QueryPlan

getScans, getSplits, useRoundRobinIterator

Field Detail

DEFAULT_ESTIMATED_SIZE

protected static final long DEFAULT_ESTIMATED_SIZE

See Also:

Constant Field Values

tableRef

protected final TableRef tableRef

context

protected final StatementContext context

statement

protected final FilterableStatement statement

projection

protected final RowProjector projection

paramMetaData

protected final ParameterMetaData paramMetaData

limit

protected final Integer limit

orderBy

protected final OrderByCompiler.OrderBy orderBy

groupBy

protected final GroupByCompiler.GroupBy groupBy

parallelIteratorFactory

protected final ParallelIteratorFactory parallelIteratorFactory

Constructor Detail

BaseQueryPlan

protected BaseQueryPlan(StatementContext context,
             FilterableStatement statement,
             TableRef table,
             RowProjector projection,
             ParameterMetaData paramMetaData,
             Integer limit,
             OrderByCompiler.OrderBy orderBy,
             GroupByCompiler.GroupBy groupBy,
             ParallelIteratorFactory parallelIteratorFactory)

Method Detail

isDegenerate

public boolean isDegenerate()

Specified by:

isDegenerate in interface QueryPlan

getGroupBy

public GroupByCompiler.GroupBy getGroupBy()

Specified by:

getGroupBy in interface QueryPlan

getOrderBy

public OrderByCompiler.OrderBy getOrderBy()

Specified by:

getOrderBy in interface QueryPlan

getTableRef

public TableRef getTableRef()

Specified by:

getTableRef in interface QueryPlan

getLimit

public Integer getLimit()

Specified by:

getLimit in interface QueryPlan

getProjector

public RowProjector getProjector()

Description copied from interface: QueryPlan

Returns projector used to formulate resultSet row

Specified by:

getProjector in interface QueryPlan

iterator

public final ResultIterator iterator(ParallelScanGrouper scanGrouper)
                              throws SQLException

Specified by:

iterator in interface QueryPlan

Throws:

SQLException

iterator

public final ResultIterator iterator()
                              throws SQLException

Description copied from interface: QueryPlan

Get a result iterator to iterate over the results

Specified by:

iterator in interface QueryPlan

Returns:

result iterator for iterating over the results

Throws:

SQLException

iterator

public final ResultIterator iterator(List<? extends SQLCloseable> dependencies,
                      ParallelScanGrouper scanGrouper)
                              throws SQLException

Throws:

SQLException

newIterator

protected abstract ResultIterator newIterator(ParallelScanGrouper scanGrouper)
                                       throws SQLException

Throws:

SQLException

getEstimatedSize

public long getEstimatedSize()

Specified by:

getEstimatedSize in interface QueryPlan

getParameterMetaData

public ParameterMetaData getParameterMetaData()

Description copied from interface: StatementPlan

Returns the ParameterMetaData for the statement

Specified by:

getParameterMetaData in interface StatementPlan

getStatement

public FilterableStatement getStatement()

Specified by:

getStatement in interface QueryPlan

getContext

public StatementContext getContext()

Specified by:

getContext in interface StatementPlan

getExplainPlan

public ExplainPlan getExplainPlan()
                           throws SQLException

Specified by:

getExplainPlan in interface StatementPlan

Throws:

SQLException

isRowKeyOrdered

public boolean isRowKeyOrdered()

Specified by:

isRowKeyOrdered in interface QueryPlan