JoinedQueryExecutor (Carbonado 1.2.3 API)

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

+
Type Parameters:
S - source type
T - target type
+
+
All Implemented Interfaces:
+
QueryExecutor<T>
+
+
+
+
```
public class JoinedQueryExecutor<S extends Storable,T extends Storable>
+extends AbstractQueryExecutor<T>
```
+
QueryExecutor which joins a source and target executor, + producing results of target type. The source executor is called once per + fetch (outer loop), but the target executor is called once per source result + (inner loop).
+
Author:
+
Brian S O'Neill
+

+ +

Method Summary

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

Methods
Modifier and Type	Method and Description
`static <T extends Storable> QueryExecutor<T>`	`build(RepositoryAccess repoAccess, + ChainedProperty<T> targetToSourceProperty, + Filter<T> targetFilter, + OrderingList<T> targetOrdering, + QueryHints hints)` + Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins. +
`Cursor<T>`	`fetch(FilterValues<T> values)` + Returns a new cursor using the given filter values. +
`Cursor<T>`	`fetch(FilterValues<T> values, + Query.Controller controller)` + Returns a new cursor using the given filter values. +
`Filter<T>`	`getFilter()` + Returns the filter used by this QueryExecutor. +
`OrderingList<T>`	`getOrdering()` + Returns the result ordering of this QueryExecutor. +
`boolean`	`printPlan(java.lang.Appendable app, + int indentLevel, + FilterValues<T> 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, printNative

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

+ +
- + + +
  Method Detail
  + + + +
  - +
    build
    +
```
public static <T extends Storable> QueryExecutor<T> build(RepositoryAccess repoAccess,
+                                          ChainedProperty<T> targetToSourceProperty,
+                                          Filter<T> targetFilter,
+                                          OrderingList<T> targetOrdering,
+                                          QueryHints hints)
+                                               throws RepositoryException
```
    +
    Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins. Filtering and ordering may also be supplied, + in order to better distribute work throughout the join.
    +
    Parameters:
    repoAccess - used to create query executors for outer and inner loops
    targetToSourceProperty - join property of target type which maps + to instances of source type
    targetFilter - optional filter for fetching target instances
    targetOrdering - optional ordering to apply to target executor + & @param hints optional hints
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if any parameter is null or if join + property is not a Storable type
    +
    RepositoryException - from RepositoryAccess
    +
  + + + +
  - +
    fetch
    +
```
public Cursor<T> fetch(FilterValues<T> values)
+                                 throws FetchException
```
    +
    Description copied from interface: QueryExecutor
    +
    Returns a new cursor using the given filter values.
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    fetch
    +
```
public Cursor<T> fetch(FilterValues<T> 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<T> getFilter()
```
    +
    Description copied from interface: QueryExecutor
    +
    Returns the filter used by this QueryExecutor.
    +
    Returns:
    query filter, never null
    +
  + + + +
  - +
    getOrdering
    +
```
public OrderingList<T> 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<T> 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 JoinedQueryExecutor<S extends Storable,T extends Storable>

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

build

fetch

fetch

getFilter

getOrdering

printPlan