QueryExecutor (Carbonado 1.2.3 API)

+
+
All Known Implementing Classes:
+
AbstractQueryExecutor, DelegatedQueryExecutor, FilteredQueryExecutor, FullScanQueryExecutor, IndexedQueryExecutor, IterableQueryExecutor, JoinedQueryExecutor, KeyQueryExecutor, SortedQueryExecutor, UnionQueryExecutor
+
+
+
+
```
public interface QueryExecutor<S extends Storable>
```
+
Performs all the actual work of executing a query. QueryExecutors are linked + together forming a query plan.
+
Author:
+
Brian S O'Neill
+
See Also:
QueryExecutorFactory
+

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`long`	`count(FilterValues<S> values)` + Counts the query results using the given filter values. +
`long`	`count(FilterValues<S> values, + Query.Controller controller)` + Counts the query results using the given filter values. +
`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. +
`Cursor<S>`	`fetchSlice(FilterValues<S> values, + long from, + java.lang.Long to)` + Returns a new cursor using the given filter values and slice. +
`Cursor<S>`	`fetchSlice(FilterValues<S> values, + long from, + java.lang.Long to, + Query.Controller controller)` + Returns a new cursor using the given filter values and slice. +
`Filter<S>`	`getFilter()` + Returns the filter used by this QueryExecutor. +
`OrderingList<S>`	`getOrdering()` + Returns the result ordering of this QueryExecutor. +
`java.lang.Class<S>`	`getStorableType()` + Returns the storable type that this executor operates on. +
`boolean`	`printNative(java.lang.Appendable app, + int indentLevel, + FilterValues<S> values)` + Prints the native query to any appendable, if applicable. +
`boolean`	`printPlan(java.lang.Appendable app, + int indentLevel, + FilterValues<S> values)` + Prints the query plan to any appendable, if applicable. +

+ +
- + + +
  Method Detail
  + + + +
  - +
    getStorableType
    +
```
java.lang.Class<S> getStorableType()
```
    +
    Returns the storable type that this executor operates on.
    +
  + + + +
  - +
    fetch
    +
```
Cursor<S> fetch(FilterValues<S> values)
+                                 throws FetchException
```
    +
    Returns a new cursor using the given filter values.
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    fetch
    +
```
Cursor<S> fetch(FilterValues<S> values,
+              Query.Controller controller)
+                                 throws FetchException
```
    +
    Returns a new cursor using the given filter values.
    +
    Parameters:
    controller - optional controller which can abort query operation
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    fetchSlice
    +
```
Cursor<S> fetchSlice(FilterValues<S> values,
+                   long from,
+                   java.lang.Long to)
+                                      throws FetchException
```
    +
    Returns a new cursor using the given filter values and slice.
    +
    Throws:
    +
    FetchException
    Since:
    +
    1.2
    +
  + + + +
  - +
    fetchSlice
    +
```
Cursor<S> fetchSlice(FilterValues<S> values,
+                   long from,
+                   java.lang.Long to,
+                   Query.Controller controller)
+                                      throws FetchException
```
    +
    Returns a new cursor using the given filter values and slice.
    +
    Parameters:
    controller - optional controller which can abort query operation
    +
    Throws:
    +
    FetchException
    Since:
    +
    1.2
    +
  + + + +
  - +
    count
    +
```
long count(FilterValues<S> values)
+           throws FetchException
```
    +
    Counts the query results using the given filter values.
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    count
    +
```
long count(FilterValues<S> values,
+         Query.Controller controller)
+           throws FetchException
```
    +
    Counts the query results using the given filter values.
    +
    Parameters:
    controller - optional controller which can abort query operation
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    getFilter
    +
```
Filter<S> getFilter()
```
    +
    Returns the filter used by this QueryExecutor.
    +
    Returns:
    query filter, never null
    +
  + + + +
  - +
    getOrdering
    +
```
OrderingList<S> getOrdering()
```
    +
    Returns the result ordering of this QueryExecutor.
    +
    Returns:
    query ordering in an unmodifiable list
    +
  + + + +
  - +
    printNative
    +
```
boolean printNative(java.lang.Appendable app,
+                  int indentLevel,
+                  FilterValues<S> values)
+                    throws java.io.IOException
```
    +
    Prints the native query to any appendable, if applicable.
    +
    Parameters:
    values - optional
    +
    Returns:
    false if not implemented
    +
    Throws:
    +
    java.io.IOException
    +
  + + + +
  - +
    printPlan
    +
```
boolean printPlan(java.lang.Appendable app,
+                int indentLevel,
+                FilterValues<S> values)
+                  throws java.io.IOException
```
    +
    Prints the query plan to any appendable, if applicable.
    +
    Parameters:
    values - optional
    +
    Returns:
    false if not implemented
    +
    Throws:
    +
    java.io.IOException
    +
  +
+

Interface QueryExecutor<S extends Storable>

Method Summary

Method Detail

getStorableType

fetch

fetch

fetchSlice

fetchSlice

count

count

getFilter

getOrdering

printNative

printPlan