com.amazon.carbonado.qe

Class FilteredQueryExecutor<S extends Storable>

java.lang.Object

com.amazon.carbonado.qe.AbstractQueryExecutor<S>

com.amazon.carbonado.qe.FilteredQueryExecutor<S>

All Implemented Interfaces:

QueryExecutor<S>

public class FilteredQueryExecutor<S extends Storable>
extends AbstractQueryExecutor<S>

QueryExecutor which wraps another and filters results.

Author:

Brian S O'Neill

See Also:

FilteredCursor

Constructor Summary

Constructors

Constructor and Description
FilteredQueryExecutor(QueryExecutor<S> executor, Filter<S> filter)

Method Summary

Methods

Modifier and Type	Method and Description
Cursor<S>	fetch(FilterValues<S> values) Returns a new cursor using the given filter values.
Cursor<S>	fetch(FilterValues<S> values, Query.Controller controller) Returns a new cursor using the given filter values.
Filter<S>	getFilter() Returns the combined filter of the wrapped executor and the extra filter.
OrderingList<S>	getOrdering() Returns the result ordering of this QueryExecutor.
boolean	printNative(java.lang.Appendable app, int indentLevel, FilterValues<S> values) Prints native query of the wrapped executor.
boolean	printPlan(java.lang.Appendable app, int indentLevel, FilterValues<S> values) Prints the query plan to any appendable, if applicable.

Methods inherited from class com.amazon.carbonado.qe.AbstractQueryExecutor

count, count, fetchSlice, fetchSlice, getStorableType, increaseIndent, indent, newline

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredQueryExecutor

public FilteredQueryExecutor(QueryExecutor<S> executor,
                     Filter<S> filter)

Parameters:

executor - executor to wrap

filter - filter to apply to cursor

Throws:

java.lang.IllegalArgumentException - if any argument is null or filter is open or closed

Method Detail

fetch

public Cursor<S> fetch(FilterValues<S> values)
                                 throws FetchException

Description copied from interface: QueryExecutor

Returns a new cursor using the given filter values.

Throws:

FetchException

fetch

public Cursor<S> fetch(FilterValues<S> values,
              Query.Controller controller)
                                 throws FetchException

Description copied from interface: QueryExecutor

Returns a new cursor using the given filter values.

controller - optional controller which can abort query operation

Throws:

FetchException

getFilter

public Filter<S> getFilter()

Returns the combined filter of the wrapped executor and the extra filter.

Returns:

query filter, never null

getOrdering

public OrderingList<S> getOrdering()

Description copied from interface: QueryExecutor

Returns the result ordering of this QueryExecutor.

Returns:

query ordering in an unmodifiable list

printNative

public boolean printNative(java.lang.Appendable app,
                  int indentLevel,
                  FilterValues<S> values)
                    throws java.io.IOException

Prints native query of the wrapped executor.

Specified by:

printNative in interface QueryExecutor<S extends Storable>

Overrides:

printNative in class AbstractQueryExecutor<S extends Storable>

values - optional

Returns:

false if not implemented

Throws:

java.io.IOException

printPlan

public boolean printPlan(java.lang.Appendable app,
                int indentLevel,
                FilterValues<S> values)
                  throws java.io.IOException

Description copied from interface: QueryExecutor

Prints the query plan to any appendable, if applicable.

values - optional

Returns:

false if not implemented

Throws:

java.io.IOException