AbstractQueryExecutor (Carbonado 1.2.3 API)

java.lang.Object
+
- com.amazon.carbonado.qe.AbstractQueryExecutor<S>
+

+
+
All Implemented Interfaces:
+
QueryExecutor<S>
+
+
+
Direct Known Subclasses:
+
FilteredQueryExecutor, FullScanQueryExecutor, IndexedQueryExecutor, IterableQueryExecutor, JoinedQueryExecutor, KeyQueryExecutor, SortedQueryExecutor, UnionQueryExecutor
+
+
+
+
```
public abstract class AbstractQueryExecutor<S extends Storable>
+extends java.lang.Object
+implements QueryExecutor<S>
```
+
AbstractQueryExecutor implements a small set of common QueryExecutor methods.
+
Author:
+
Brian S O'Neill
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
AbstractQueryExecutor()
+

Constructors
Constructor and Description
`AbstractQueryExecutor()`

+ +

Method Summary

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

Methods
Modifier and Type	Method and Description
`long`	`count(FilterValues<S> values)` + Counts results by opening a cursor and skipping entries. +
`long`	`count(FilterValues<S> values, + Query.Controller controller)` + Counts results by opening a cursor and skipping entries. +
`Cursor<S>`	`fetchSlice(FilterValues<S> values, + long from, + java.lang.Long to)` + Produces a slice via skip and limit cursors. +
`Cursor<S>`	`fetchSlice(FilterValues<S> values, + long from, + java.lang.Long to, + Query.Controller controller)` + Produces a slice via skip and limit cursors. +
`java.lang.Class<S>`	`getStorableType()` + Returns the storable type that this executor operates on. +
`protected int`	`increaseIndent(int indentLevel)` + Adds a constant amount to the given indent level. +
`protected void`	`indent(java.lang.Appendable app, + int indentLevel)` + Appends spaces to the given appendable. +
`protected void`	`newline(java.lang.Appendable app)` + Appends a newline character. +
`boolean`	`printNative(java.lang.Appendable app, + int indentLevel, + FilterValues<S> values)` + Does nothing and returns false. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ + +
Methods inherited from interface com.amazon.carbonado.qe.QueryExecutor
+fetch, fetch, getFilter, getOrdering, printPlan

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    AbstractQueryExecutor
    +
```
public AbstractQueryExecutor()
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getStorableType
    +
```
public java.lang.Class<S> getStorableType()
```
    +
    Description copied from interface: QueryExecutor
    +
    Returns the storable type that this executor operates on.
    +
    +
    Specified by:
    +
    getStorableType in interface QueryExecutor<S extends Storable>
    +
    +
  + + + +
  - +
    fetchSlice
    +
```
public Cursor<S> fetchSlice(FilterValues<S> values,
+                   long from,
+                   java.lang.Long to)
+                                      throws FetchException
```
    +
    Produces a slice via skip and limit cursors. Subclasses are encouraged + to override with a more efficient implementation.
    +
    +
    Specified by:
    +
    fetchSlice in interface QueryExecutor<S extends Storable>
    +
    Throws:
    +
    FetchException
    Since:
    +
    1.2
    +
  + + + +
  - +
    fetchSlice
    +
```
public Cursor<S> fetchSlice(FilterValues<S> values,
+                   long from,
+                   java.lang.Long to,
+                   Query.Controller controller)
+                                      throws FetchException
```
    +
    Produces a slice via skip and limit cursors. Subclasses are encouraged + to override with a more efficient implementation.
    +
    +
    Specified by:
    +
    fetchSlice in interface QueryExecutor<S extends Storable>
    +
    controller - optional controller which can abort query operation
    +
    Throws:
    +
    FetchException
    Since:
    +
    1.2
    +
  + + + +
  - +
    count
    +
```
public long count(FilterValues<S> values)
+           throws FetchException
```
    +
    Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.
    +
    +
    Specified by:
    +
    count in interface QueryExecutor<S extends Storable>
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    count
    +
```
public long count(FilterValues<S> values,
+         Query.Controller controller)
+           throws FetchException
```
    +
    Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.
    +
    +
    Specified by:
    +
    count in interface QueryExecutor<S extends Storable>
    +
    controller - optional controller which can abort query operation
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    printNative
    +
```
public boolean printNative(java.lang.Appendable app,
+                  int indentLevel,
+                  FilterValues<S> values)
+                    throws java.io.IOException
```
    +
    Does nothing and returns false.
    +
    +
    Specified by:
    +
    printNative in interface QueryExecutor<S extends Storable>
    +
    values - optional
    +
    Returns:
    false if not implemented
    +
    Throws:
    +
    java.io.IOException
    +
  + + + +
  - +
    indent
    +
```
protected void indent(java.lang.Appendable app,
+          int indentLevel)
+               throws java.io.IOException
```
    +
    Appends spaces to the given appendable. Useful for implementing + printNative and printPlan.
    +
    Throws:
    +
    java.io.IOException
    +
  + + + +
  - +
    newline
    +
```
protected void newline(java.lang.Appendable app)
+                throws java.io.IOException
```
    +
    Appends a newline character.
    +
    Throws:
    +
    java.io.IOException
    +
  + + + +
  - +
    increaseIndent
    +
```
protected int increaseIndent(int indentLevel)
```
    +
    Adds a constant amount to the given indent level. Useful for + implementing printNative and printPlan.
    +
  +
+

Class AbstractQueryExecutor<S extends Storable>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazon.carbonado.qe.QueryExecutor

Constructor Detail

AbstractQueryExecutor

Method Detail

getStorableType

fetchSlice

fetchSlice

count

count

printNative

indent

newline

increaseIndent