From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../carbonado/qe/IndexedQueryExecutor.Support.html | 375 +++++++++++++++++++++ 1 file changed, 375 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html (limited to 'apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html') diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html new file mode 100644 index 0000000..e841803 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html @@ -0,0 +1,375 @@ + + + + + + +IndexedQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface IndexedQueryExecutor.Support<S extends Storable>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        indexEntryQuery

        +
        Query<?> indexEntryQuery(StorableIndex<S> index)
+                         throws FetchException
        +
        Returns an open query if the given index supports query access. If + not supported, return null. An index entry query might be used to + perform filtering and sorting of index entries prior to being + resolved into referenced Storables. + +

        If an index entry query is returned, the fetchSubset method is + never called by IndexedQueryExecutor.

        +
        Returns:
        index entry query or null if not supported
        +
        Throws:
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        fetchFromIndexEntryQuery

        +
        Cursor<S> fetchFromIndexEntryQuery(StorableIndex<S> index,
+                                 Query<?> indexEntryQuery)
+                                                    throws FetchException
        +
        Fetch Storables referenced by the given index entry query. This + method is only called if index supports query access.
        +
        Parameters:
        index - index to open
        indexEntryQuery - query with no blank parameters, derived from + the query returned by indexEntryQuery
        +
        Throws:
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        fetchFromIndexEntryQuery

        +
        Cursor<S> fetchFromIndexEntryQuery(StorableIndex<S> index,
+                                 Query<?> indexEntryQuery,
+                                 Query.Controller controller)
+                                                    throws FetchException
        +
        Fetch Storables referenced by the given index entry query. This + method is only called if index supports query access.
        +
        Parameters:
        index - index to open
        indexEntryQuery - query with no blank parameters, derived from + the query returned by indexEntryQuery
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        fetchSubset

        +
        Cursor<S> fetchSubset(StorableIndex<S> index,
+                    java.lang.Object[] identityValues,
+                    BoundaryType rangeStartBoundary,
+                    java.lang.Object rangeStartValue,
+                    BoundaryType rangeEndBoundary,
+                    java.lang.Object rangeEndValue,
+                    boolean reverseRange,
+                    boolean reverseOrder)
+                                       throws FetchException
        +
        Perform an index scan of a subset of Storables referenced by an + index. The identity values are aligned with the index properties at + property 0. An optional range start or range end aligns with the index + property following the last of the identity values. + +

        This method is only called if no index entry query was provided + for the given index.

        +
        Parameters:
        index - index to open, which may be a primary key index
        identityValues - optional list of exactly matching values to apply to index
        rangeStartBoundary - start boundary type
        rangeStartValue - value to start at if boundary is not open
        rangeEndBoundary - end boundary type
        rangeEndValue - value to end at if boundary is not open
        reverseRange - indicates that range operates on a property whose + natural order is descending. Only the code that opens the physical + cursor should examine this parameter. If true, then the range start and + end parameter pairs need to be swapped.
        reverseOrder - when true, iteration should be reversed from its + natural order
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        fetchSubset

        +
        Cursor<S> fetchSubset(StorableIndex<S> index,
+                    java.lang.Object[] identityValues,
+                    BoundaryType rangeStartBoundary,
+                    java.lang.Object rangeStartValue,
+                    BoundaryType rangeEndBoundary,
+                    java.lang.Object rangeEndValue,
+                    boolean reverseRange,
+                    boolean reverseOrder,
+                    Query.Controller controller)
+                                       throws FetchException
        +
        Perform an index scan of a subset of Storables referenced by an + index. The identity values are aligned with the index properties at + property 0. An optional range start or range end aligns with the index + property following the last of the identity values. + +

        This method is only called if no index entry query was provided + for the given index.

        +
        Parameters:
        index - index to open, which may be a primary key index
        identityValues - optional list of exactly matching values to apply to index
        rangeStartBoundary - start boundary type
        rangeStartValue - value to start at if boundary is not open
        rangeEndBoundary - end boundary type
        rangeEndValue - value to end at if boundary is not open
        reverseRange - indicates that range operates on a property whose + natural order is descending. Only the code that opens the physical + cursor should examine this parameter. If true, then the range start and + end parameter pairs need to be swapped.
        reverseOrder - when true, iteration should be reversed from its + natural order
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3