IndexedQueryExecutor (Carbonado 1.2.3 API)

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

+
+
All Implemented Interfaces:
+
QueryExecutor<S>
+
+
+
+
```
public class IndexedQueryExecutor<S extends Storable>
+extends AbstractQueryExecutor<S>
```
+
QueryExecutor which utilizes an index.
+
Author:
+
Brian S O'Neill
+

+ +

+ + +
Nested Class Summary
+ + + + + + + + + + +
Nested Classes
Modifier and Type Class and Description
static interface IndexedQueryExecutor.Support<S extends Storable> +
Provides support for IndexedQueryExecutor.
+
+

Nested Classes
Modifier and Type	Class and Description
`static interface`	`IndexedQueryExecutor.Support<S extends Storable>` + Provides support for `IndexedQueryExecutor`. +

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
IndexedQueryExecutor(IndexedQueryExecutor.Support<S> support, + StorableIndex<S> index, + CompositeScore<S> score)
+

Constructors
Constructor and Description
`IndexedQueryExecutor(IndexedQueryExecutor.Support<S> support, + StorableIndex<S> index, + CompositeScore<S> score)`

+ +

+ + +

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>`	`getCoveringFilter()`
`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`	`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, increaseIndent, indent, newline, printNative

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

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    IndexedQueryExecutor
    +
```
public IndexedQueryExecutor(IndexedQueryExecutor.Support<S> support,
+                    StorableIndex<S> index,
+                    CompositeScore<S> score)
+                     throws FetchException
```
    +
    Parameters:
    index - index to use, which may be a primary key index
    score - score determines how best to utilize the index
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if any parameter is null
    +
    FetchException
    +
  +
+ +
- + + +
  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>
    +
    Overrides:
    +
    getStorableType in class AbstractQueryExecutor<S extends Storable>
    +
    +
  + + + +
  - +
    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
    +
  + + + +
  - +
    getCoveringFilter
    +
```
public Filter<S> getCoveringFilter()
```
    +
    Returns:
    null if executor doesn't support or use a covering index
    +
  + + + +
  - +
    getFilter
    +
```
public Filter<S> getFilter()
```
    +
    Description copied from interface: QueryExecutor
    +
    Returns the filter used by this QueryExecutor.
    +
    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
    +
  + + + +
  - +
    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
    +
  +
+

Class IndexedQueryExecutor<S extends Storable>

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

IndexedQueryExecutor

Method Detail

getStorableType

fetch

fetch

getCoveringFilter

getFilter

getOrdering

printPlan