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 --- apidocs/com/amazon/carbonado/qe/AbstractQuery.html | 767 +++++++++++ .../amazon/carbonado/qe/AbstractQueryExecutor.html | 479 +++++++ apidocs/com/amazon/carbonado/qe/BoundaryType.html | 347 +++++ .../com/amazon/carbonado/qe/CompositeScore.html | 509 ++++++++ .../carbonado/qe/DelegatedQueryExecutor.html | 557 ++++++++ .../qe/DelegatedQueryExecutorFactory.html | 298 +++++ apidocs/com/amazon/carbonado/qe/EmptyQuery.html | 1051 +++++++++++++++ .../amazon/carbonado/qe/FilteredQueryExecutor.html | 404 ++++++ .../com/amazon/carbonado/qe/FilteringScore.html | 932 +++++++++++++ .../qe/FullScanQueryExecutor.Support.html | 297 +++++ .../amazon/carbonado/qe/FullScanQueryExecutor.html | 446 +++++++ .../carbonado/qe/IndexedQueryAnalyzer.Result.html | 518 ++++++++ .../amazon/carbonado/qe/IndexedQueryAnalyzer.html | 316 +++++ .../carbonado/qe/IndexedQueryExecutor.Support.html | 375 ++++++ .../amazon/carbonado/qe/IndexedQueryExecutor.html | 436 +++++++ .../amazon/carbonado/qe/IterableQueryExecutor.html | 386 ++++++ .../amazon/carbonado/qe/JoinedQueryExecutor.html | 374 ++++++ .../carbonado/qe/KeyQueryExecutor.Support.html | 254 ++++ .../com/amazon/carbonado/qe/KeyQueryExecutor.html | 421 ++++++ apidocs/com/amazon/carbonado/qe/OrderingList.html | 559 ++++++++ apidocs/com/amazon/carbonado/qe/OrderingScore.html | 547 ++++++++ apidocs/com/amazon/carbonado/qe/QueryEngine.html | 329 +++++ apidocs/com/amazon/carbonado/qe/QueryExecutor.html | 437 +++++++ .../amazon/carbonado/qe/QueryExecutorCache.html | 300 +++++ .../amazon/carbonado/qe/QueryExecutorFactory.html | 239 ++++ apidocs/com/amazon/carbonado/qe/QueryFactory.html | 241 ++++ apidocs/com/amazon/carbonado/qe/QueryHint.html | 320 +++++ apidocs/com/amazon/carbonado/qe/QueryHints.html | 387 ++++++ .../com/amazon/carbonado/qe/RepositoryAccess.html | 238 ++++ .../qe/SortedQueryExecutor.ArraySortSupport.html | 296 +++++ .../qe/SortedQueryExecutor.MergeSortSupport.html | 296 +++++ .../carbonado/qe/SortedQueryExecutor.Support.html | 241 ++++ .../amazon/carbonado/qe/SortedQueryExecutor.html | 494 +++++++ apidocs/com/amazon/carbonado/qe/StandardQuery.html | 1368 ++++++++++++++++++++ .../amazon/carbonado/qe/StandardQueryFactory.html | 535 ++++++++ .../com/amazon/carbonado/qe/StorableIndexSet.html | 565 ++++++++ apidocs/com/amazon/carbonado/qe/StorageAccess.html | 305 +++++ .../carbonado/qe/UnionQueryAnalyzer.Result.html | 271 ++++ .../amazon/carbonado/qe/UnionQueryAnalyzer.html | 350 +++++ .../amazon/carbonado/qe/UnionQueryExecutor.html | 434 +++++++ .../carbonado/qe/class-use/AbstractQuery.html | 167 +++ .../qe/class-use/AbstractQueryExecutor.html | 205 +++ .../carbonado/qe/class-use/BoundaryType.html | 206 +++ .../carbonado/qe/class-use/CompositeScore.html | 275 ++++ .../qe/class-use/DelegatedQueryExecutor.html | 117 ++ .../class-use/DelegatedQueryExecutorFactory.html | 117 ++ .../amazon/carbonado/qe/class-use/EmptyQuery.html | 117 ++ .../qe/class-use/FilteredQueryExecutor.html | 117 ++ .../carbonado/qe/class-use/FilteringScore.html | 246 ++++ .../class-use/FullScanQueryExecutor.Support.html | 173 +++ .../qe/class-use/FullScanQueryExecutor.html | 117 ++ .../qe/class-use/IndexedQueryAnalyzer.Result.html | 225 ++++ .../qe/class-use/IndexedQueryAnalyzer.html | 117 ++ .../qe/class-use/IndexedQueryExecutor.Support.html | 175 +++ .../qe/class-use/IndexedQueryExecutor.html | 117 ++ .../qe/class-use/IterableQueryExecutor.html | 117 ++ .../qe/class-use/JoinedQueryExecutor.html | 117 ++ .../qe/class-use/KeyQueryExecutor.Support.html | 175 +++ .../carbonado/qe/class-use/KeyQueryExecutor.html | 117 ++ .../carbonado/qe/class-use/OrderingList.html | 577 +++++++++ .../carbonado/qe/class-use/OrderingScore.html | 226 ++++ .../amazon/carbonado/qe/class-use/QueryEngine.html | 117 ++ .../carbonado/qe/class-use/QueryExecutor.html | 331 +++++ .../carbonado/qe/class-use/QueryExecutorCache.html | 117 ++ .../qe/class-use/QueryExecutorFactory.html | 213 +++ .../carbonado/qe/class-use/QueryFactory.html | 202 +++ .../amazon/carbonado/qe/class-use/QueryHint.html | 208 +++ .../amazon/carbonado/qe/class-use/QueryHints.html | 325 +++++ .../carbonado/qe/class-use/RepositoryAccess.html | 186 +++ .../SortedQueryExecutor.ArraySortSupport.html | 117 ++ .../SortedQueryExecutor.MergeSortSupport.html | 117 ++ .../qe/class-use/SortedQueryExecutor.Support.html | 193 +++ .../qe/class-use/SortedQueryExecutor.html | 117 ++ .../carbonado/qe/class-use/StandardQuery.html | 180 +++ .../qe/class-use/StandardQueryFactory.html | 161 +++ .../carbonado/qe/class-use/StorableIndexSet.html | 159 +++ .../carbonado/qe/class-use/StorageAccess.html | 162 +++ .../qe/class-use/UnionQueryAnalyzer.Result.html | 161 +++ .../carbonado/qe/class-use/UnionQueryAnalyzer.html | 117 ++ .../carbonado/qe/class-use/UnionQueryExecutor.html | 117 ++ apidocs/com/amazon/carbonado/qe/package-frame.html | 63 + .../com/amazon/carbonado/qe/package-summary.html | 398 ++++++ apidocs/com/amazon/carbonado/qe/package-tree.html | 223 ++++ apidocs/com/amazon/carbonado/qe/package-use.html | 265 ++++ 84 files changed, 25988 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/qe/AbstractQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/BoundaryType.html create mode 100644 apidocs/com/amazon/carbonado/qe/CompositeScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/EmptyQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/FilteringScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html create mode 100644 apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html create mode 100644 apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/OrderingList.html create mode 100644 apidocs/com/amazon/carbonado/qe/OrderingScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryEngine.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryHint.html create mode 100644 apidocs/com/amazon/carbonado/qe/QueryHints.html create mode 100644 apidocs/com/amazon/carbonado/qe/RepositoryAccess.html create mode 100644 apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html create mode 100644 apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html create mode 100644 apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/StandardQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/StorableIndexSet.html create mode 100644 apidocs/com/amazon/carbonado/qe/StorageAccess.html create mode 100644 apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html create mode 100644 apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html create mode 100644 apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html create mode 100644 apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html create mode 100644 apidocs/com/amazon/carbonado/qe/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/qe/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/qe/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/qe/package-use.html (limited to 'apidocs/com/amazon/carbonado/qe') diff --git a/apidocs/com/amazon/carbonado/qe/AbstractQuery.html b/apidocs/com/amazon/carbonado/qe/AbstractQuery.html new file mode 100644 index 0000000..a290d49 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/AbstractQuery.html @@ -0,0 +1,767 @@ + + + + + + +AbstractQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class AbstractQuery<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Query<S>, Appender
    +
    +
    +
    Direct Known Subclasses:
    +
    EmptyQuery, StandardQuery
    +
    +
    +
    +
    public abstract class AbstractQuery<S extends Storable>
+extends java.lang.Object
+implements Query<S>, Appender
    +
    AbstractQuery implements a small set of common Query methods. Subclasses + should consider overriding some of these methods, if it provides better + performance.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractQuery

        +
        protected AbstractQuery()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        and

        +
        public Query<S> and(java.lang.String filter)
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
        +
        +
        Specified by:
        +
        and in interface Query<S extends Storable>
        +
        Parameters:
        filter - query filter expression
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Query<S> or(java.lang.String filter)
+                             throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
        +
        +
        Specified by:
        +
        or in interface Query<S extends Storable>
        +
        Parameters:
        filter - query filter expression
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + + + +
        +
      • +

        fetchAfter

        +
        public <T extends S> Cursor<S> fetchAfter(T start)
+                                      throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit ordering. If not a total + ordering, then cursor may start at an earlier position. + +

        Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + +

        Calling fetchAfter(s) is equivalent to calling after(s).fetch().

        +
        +
        Specified by:
        +
        fetchAfter in interface Query<S extends Storable>
        +
        Parameters:
        start - storable to attempt to start after; if null, fetch all results
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel), +Query.after(T)
        +
        • +
      + + + + + +
        +
      • +

        fetchAfter

        +
        public <T extends S> Cursor<S> fetchAfter(T start,
+                                 Query.Controller controller)
+                                      throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit ordering. If not a total + ordering, then cursor may start at an earlier position. + +

        Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + +

        Calling fetchAfter(s) is equivalent to calling after(s).fetch().

        +
        +
        Specified by:
        +
        fetchAfter in interface Query<S extends Storable>
        +
        Parameters:
        start - storable to attempt to start after; if null, fetch all results
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel), +Query.after(T)
        +
        • +
      + + + +
        +
      • +

        loadOne

        +
        public S loadOne()
+                           throws FetchException
        +
        Description copied from interface: Query
        +
        Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.
        +
        +
        Specified by:
        +
        loadOne in interface Query<S extends Storable>
        +
        Returns:
        a single fetched object
        +
        Throws:
        +
        FetchNoneException - if no matching record found
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        loadOne

        +
        public S loadOne(Query.Controller controller)
+                           throws FetchException
        +
        Description copied from interface: Query
        +
        Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.
        +
        +
        Specified by:
        +
        loadOne in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        a single fetched object
        +
        Throws:
        +
        FetchNoneException - if no matching record found
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryLoadOne

        +
        public S tryLoadOne()
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.
        +
        +
        Specified by:
        +
        tryLoadOne in interface Query<S extends Storable>
        +
        Returns:
        null or a single fetched object
        +
        Throws:
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryLoadOne

        +
        public S tryLoadOne(Query.Controller controller)
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.
        +
        +
        Specified by:
        +
        tryLoadOne in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        null or a single fetched object
        +
        Throws:
        +
        FetchMultipleException - if more than one matching record found
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + + + + + +
        +
      • +

        deleteOne

        +
        public void deleteOne(Query.Controller controller)
+               throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        +
        Specified by:
        +
        deleteOne in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        PersistNoneException - if no matching record found
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative()
        +
        Description copied from interface: Query
        +
        Print the native query to standard out, which is useful for performance + analysis. Not all repositories have a native query format. An example + native format is SQL.
        +
        +
        Specified by:
        +
        printNative in interface Query<S extends Storable>
        +
        Returns:
        false if not implemented
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app)
+                    throws java.io.IOException
        +
        Description copied from interface: Query
        +
        Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.
        +
        +
        Specified by:
        +
        printNative in interface Query<S extends Storable>
        +
        Parameters:
        app - append results here
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan()
        +
        Description copied from interface: Query
        +
        Prints the query excecution plan to standard out, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.
        +
        +
        Specified by:
        +
        printPlan in interface Query<S extends Storable>
        +
        Returns:
        false if not implemented
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app)
+                  throws java.io.IOException
        +
        Description copied from interface: Query
        +
        Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.
        +
        +
        Specified by:
        +
        printPlan in interface Query<S extends Storable>
        +
        Parameters:
        app - append results here
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Implementation calls appendTo.
        +
        +
        Specified by:
        +
        toString in interface Query<S extends Storable>
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public abstract int hashCode()
        +
        +
        Specified by:
        +
        hashCode in interface Query<S extends Storable>
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public abstract boolean equals(java.lang.Object obj)
        +
        +
        Specified by:
        +
        equals in interface Query<S extends Storable>
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        checkSliceArguments

        +
        protected boolean checkSliceArguments(long from,
+                          java.lang.Long to)
        +
        Called by sliced fetch to ensure that arguments are valid.
        +
        Returns:
        false if from is 0 and to is null
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if arguments are invalid
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html new file mode 100644 index 0000000..8da05d4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html @@ -0,0 +1,479 @@ + + + + + + +AbstractQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class AbstractQueryExecutor<S extends Storable>

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      longcount(FilterValues<S> values) +
      Counts results by opening a cursor and skipping entries.
      +
      longcount(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 intincreaseIndent(int indentLevel) +
      Adds a constant amount to the given indent level.
      +
      protected voidindent(java.lang.Appendable app, + int indentLevel) +
      Appends spaces to the given appendable.
      +
      protected voidnewline(java.lang.Appendable app) +
      Appends a newline character.
      +
      booleanprintNative(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
        • +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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>
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        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.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/BoundaryType.html b/apidocs/com/amazon/carbonado/qe/BoundaryType.html new file mode 100644 index 0000000..e9fdeb2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/BoundaryType.html @@ -0,0 +1,347 @@ + + + + + + +BoundaryType (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Enum BoundaryType

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<BoundaryType>
    +
    +
    +
    +
    public enum BoundaryType
+extends java.lang.Enum<BoundaryType>
    +
    Describes a value range boundary.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      EXCLUSIVE +
      Range boundary is exclusive
      +
      INCLUSIVE +
      Range boundary is inclusive
      +
      OPEN +
      Range boundary is open
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static BoundaryTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static BoundaryType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        OPEN

        +
        public static final BoundaryType OPEN
        +
        Range boundary is open
        +
        • +
      + + + +
        +
      • +

        INCLUSIVE

        +
        public static final BoundaryType INCLUSIVE
        +
        Range boundary is inclusive
        +
        • +
      + + + +
        +
      • +

        EXCLUSIVE

        +
        public static final BoundaryType EXCLUSIVE
        +
        Range boundary is exclusive
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static BoundaryType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (BoundaryType c : BoundaryType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static BoundaryType valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/CompositeScore.html b/apidocs/com/amazon/carbonado/qe/CompositeScore.html new file mode 100644 index 0000000..55e6ffc --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/CompositeScore.html @@ -0,0 +1,509 @@ + + + + + + +CompositeScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class CompositeScore<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class CompositeScore<S extends Storable>
+extends java.lang.Object
    +
    Evaluates an index for how well it matches a query's desired filtering and + ordering. A composite score is not a single absolute value – instead it + has a relative weight when compared to other scores.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    FilteringScore, +OrderingScore
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> CompositeScore<S> evaluate(StorableIndex<S> index,
+                                              Filter<S> filter,
+                                              OrderingList<S> ordering)
        +
        Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.
        +
        Parameters:
        index - index to evaluate
        filter - optional filter which cannot contain any logical 'or' operations.
        ordering - optional properties which define desired ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> CompositeScore<S> evaluate(OrderedProperty<S>[] indexProperties,
+                                              boolean unique,
+                                              boolean clustered,
+                                              Filter<S> filter,
+                                              OrderingList<S> ordering)
        +
        Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.
        +
        Parameters:
        indexProperties - index properties to evaluate
        unique - true if index is unique
        clustered - true if index is clustered
        filter - optional filter which cannot contain any logical 'or' operations.
        ordering - optional properties which define desired ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        localForeignComparator

        +
        public static java.util.Comparator<CompositeScore<?>> localForeignComparator()
        +
        Returns a partial comparator suited for comparing local indexes to + foreign indexes. It determines which CompositeScores are better by + examining identity matches, range matches and ordering. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        localForeignComparator

        +
        public static java.util.Comparator<CompositeScore<?>> localForeignComparator(QueryHints hints)
        +
        Returns a partial comparator suited for comparing local indexes to + foreign indexes. It determines which CompositeScores are better by + examining identity matches, range matches and ordering. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        Parameters:
        hints - optional hints
        +
        • +
      + + + +
        +
      • +

        fullComparator

        +
        public static java.util.Comparator<CompositeScore<?>> fullComparator()
        +
        Returns a comparator which determines which CompositeScores are + better. It compares identity matches, range matches, ordering, open + range matches, property arrangement and index cost estimate. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        fullComparator

        +
        public static java.util.Comparator<CompositeScore<?>> fullComparator(QueryHints hints)
        +
        Returns a comparator which determines which CompositeScores are + better. It compares identity matches, range matches, ordering, open + range matches, property arrangement and index cost estimate. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        Parameters:
        hints - optional hints
        +
        • +
      + + + +
        +
      • +

        getFilteringScore

        +
        public FilteringScore<S> getFilteringScore()
        +
        Returns the score on how well the evaluated index performs the desired + filtering.
        +
        • +
      + + + +
        +
      • +

        getOrderingScore

        +
        public OrderingScore<S> getOrderingScore()
        +
        Returns the score on how well the evaluated index performs the desired + ordering.
        +
        • +
      + + + +
        +
      • +

        canMergeRemainder

        +
        public boolean canMergeRemainder(CompositeScore<S> other)
        +
        Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderFilter

        +
        public Filter<S> mergeRemainderFilter(CompositeScore<S> other)
        +
        Merges the remainder filter of this score with the one given using an + 'or' operation. Call canMergeRemainder first to verify if the merge + makes any sense.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderOrdering

        +
        public OrderingList<S> mergeRemainderOrdering(CompositeScore<S> other)
        +
        Merges the remainder orderings of this score with the one given. Call + canMergeRemainder first to verify if the merge makes any sense.
        +
        • +
      + + + +
        +
      • +

        withRemainderFilter

        +
        public CompositeScore<S> withRemainderFilter(Filter<S> filter)
        +
        Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated. Other matches are not recalculated.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        withRemainderOrdering

        +
        public CompositeScore<S> withRemainderOrdering(OrderingList<S> ordering)
        +
        Returns a new CompositeScore with the ordering remainder + replaced. Handled count is not recalculated.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html new file mode 100644 index 0000000..3805e4b --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html @@ -0,0 +1,557 @@ + + + + + + +DelegatedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class DelegatedQueryExecutor<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutor<S>
    +
    +
    +
    +
    public class DelegatedQueryExecutor<S extends Storable>
+extends java.lang.Object
+implements QueryExecutor<S>
    +
    QueryExecutor which delegates by executing a Query on a Storage.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html new file mode 100644 index 0000000..dad3e85 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html @@ -0,0 +1,298 @@ + + + + + + +DelegatedQueryExecutorFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class DelegatedQueryExecutorFactory<S extends Storable>

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      QueryExecutor<S>executor(Filter<S> filter, + OrderingList<S> ordering, + QueryHints hints) +
      Returns an executor that handles the given query specification.
      +
      java.lang.Class<S>getStorableType() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/EmptyQuery.html b/apidocs/com/amazon/carbonado/qe/EmptyQuery.html new file mode 100644 index 0000000..2a8af3d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/EmptyQuery.html @@ -0,0 +1,1051 @@ + + + + + + +EmptyQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class EmptyQuery<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Query<S>, Appender
    +
    +
    +
    +
    public final class EmptyQuery<S extends Storable>
+extends AbstractQuery<S>
    +
    Special query implementation that fetches nothing.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EmptyQuery

        +
        public EmptyQuery(QueryFactory<S> factory,
+          OrderingList<S> ordering)
        +
        Parameters:
        factory - required query factory, used by 'or' and 'not' methods
        ordering - optional order-by properties
        +
        • +
      + + + +
        +
      • +

        EmptyQuery

        +
        public EmptyQuery(QueryFactory<S> factory,
+          java.lang.String ordering)
        +
        Parameters:
        factory - required query factory, used by 'or' and 'not' methods
        ordering - optional order-by property
        +
        • +
      + + + +
        +
      • +

        EmptyQuery

        +
        public EmptyQuery(QueryFactory<S> factory,
+          java.lang.String... orderings)
        +
        Parameters:
        factory - required query factory, used by 'or' and 'not' methods
        orderings - optional order-by properties
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Description copied from interface: Query
        +
        Returns the specific type of Storable managed by this object.
        +
        • +
      + + + + + + + +
        +
      • +

        getFilterValues

        +
        public FilterValues<S> getFilterValues()
        +
        Always returns null.
        +
        • +
      + + + +
        +
      • +

        getBlankParameterCount

        +
        public int getBlankParameterCount()
        +
        Always returns zero.
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(int value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(long value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(float value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(double value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(boolean value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(char value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(byte value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(short value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(java.lang.Object value)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        withValues

        +
        public Query<S> withValues(java.lang.Object... values)
        +
        Throws an IllegalStateException unless no values passed in.
        +
        Parameters:
        values - parameter values to fill in; if null or empty, this + Query instance is returned
        +
        • +
      + + + +
        +
      • +

        and

        +
        public Query<S> and(Filter<S> filter)
        +
        Always throws an IllegalStateException.
        +
        Parameters:
        filter - query filter
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Query<S> or(Filter<S> filter)
+                             throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
        +
        Parameters:
        filter - query filter
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        not

        +
        public Query<S> not()
+                              throws FetchException
        +
        Returns a query that fetches everything, possibly in a specified order.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        public Query<S> orderBy(java.lang.String property)
+                                  throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a copy of this query ordered by a specific property value. The + property name may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        Parameters:
        property - name of property to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        public Query<S> orderBy(java.lang.String... properties)
+                                  throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a copy of this query ordered by specific property values. The + property names may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        Parameters:
        properties - names of properties to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + + + +
        +
      • +

        after

        +
        public <T extends S> Query<S> after(T start)
        +
        Description copied from interface: Query
        +
        Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor. This is only + effective when query has been given an explicit ordering. If not a total ordering, then query may start at an earlier + position. + +

        Note: The returned query can be very expensive to fetch from + repeatedly, if the query needs to perform a sort operation. Ideally, the + query ordering should match the natural ordering of an index or key.

        +
        Parameters:
        start - storable to attempt to start after; if null, this query is + returned
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        fetchSlice

        +
        public Cursor<S> fetchSlice(long from,
+                   java.lang.Long to)
        +
        Always returns an EmptyCursor.
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        +
        Returns:
        fetch results
        +
        • +
      + + + +
        +
      • +

        fetchSlice

        +
        public Cursor<S> fetchSlice(long from,
+                   java.lang.Long to,
+                   Query.Controller controller)
        +
        Always returns an EmptyCursor.
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        tryDeleteOne

        +
        public boolean tryDeleteOne()
        +
        Always returns false.
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        • +
      + + + +
        +
      • +

        tryDeleteOne

        +
        public boolean tryDeleteOne(Query.Controller controller)
        +
        Always returns false.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll()
        +
        Does nothing.
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll(Query.Controller controller)
        +
        Does nothing.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        • +
      + + + +
        +
      • +

        count

        +
        public long count()
        +
        Always returns zero.
        +
        Returns:
        count of matches
        +
        • +
      + + + +
        +
      • +

        count

        +
        public long count(Query.Controller controller)
        +
        Always returns zero.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        count of matches
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists()
        +
        Always returns false.
        +
        Returns:
        true if any matches
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(Query.Controller controller)
        +
        Always returns false.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if any matches
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Description copied from interface: Appender
        +
        Append the string representation of this object to the given Appendable.
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app,
+                  int indentLevel)
        +
        Always returns false.
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app,
+                int indentLevel)
        +
        Always returns false.
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html new file mode 100644 index 0000000..7153d87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html @@ -0,0 +1,404 @@ + + + + + + +FilteredQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class FilteredQueryExecutor<S extends Storable>

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

      Constructor Detail

      + + + +
        +
      • +

        FilteredQueryExecutor

        +
        public FilteredQueryExecutor(QueryExecutor<S> executor,
+                     Filter<S> filter)
        +
        Parameters:
        executor - executor to wrap
        filter - filter to apply to cursor
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any argument is null or filter is open or closed
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        getFilter

        +
        public Filter<S> getFilter()
        +
        Returns the combined filter of the wrapped executor and the extra filter.
        +
        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
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app,
+                  int indentLevel,
+                  FilterValues<S> values)
+                    throws java.io.IOException
        +
        Prints native query of the wrapped executor.
        +
        +
        Specified by:
        +
        printNative in interface QueryExecutor<S extends Storable>
        +
        Overrides:
        +
        printNative in class AbstractQueryExecutor<S extends Storable>
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/FilteringScore.html b/apidocs/com/amazon/carbonado/qe/FilteringScore.html new file mode 100644 index 0000000..e646914 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FilteringScore.html @@ -0,0 +1,932 @@ + + + + + + +FilteringScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class FilteringScore<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class FilteringScore<S extends Storable>
+extends java.lang.Object
    +
    Evaluates an index for how well it matches a query's desired filtering. A + filtering score is not a single absolute value – instead it has a + relative weight when compared to other scores. + +

    An index matches a desired filtering if the arrangement of properties and + its relational operator matches. A matching = operator is + an identity match. A range match is determined by a matching operator of + >, >=, <, or <=. Filters with a != operator are + ignored. Although not all index properties need to be used, the first must + be and no gaps are allowed. + +

    A FilteringScore measures the number of filter properties that are + matched and the number that are remaining. If there are remainder + properties, then the user of the evaluated index will need to perform an + additional filtering operation to achieve the desired results. + +

    In general, a FilteringScore is better than another if it has more + matched properties and fewer remainder properties. Matching more identity + properties is given preference over matching range properties. Index + clustering is also considered for score comparison.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    OrderingScore, +CompositeScore
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancanMergeRemainderFilter(FilteringScore<S> other) +
      Returns true if the given score uses an index exactly the same as this + one.
      +
      static <S extends Storable> 
      FilteringScore<S>      		evaluate(OrderedProperty<S>[] indexProperties, + boolean unique, + boolean clustered, + Filter<S> filter) +
      Evaluates the given index properties for its filtering capabilities + against the given filter.
      +
      static <S extends Storable> 
      FilteringScore<S>      		evaluate(StorableIndex<S> index, + Filter<S> filter) +
      Evaluates the given index for its filtering capabilities against the + given filter.
      +
      static java.util.Comparator<FilteringScore<?>>fullComparator() +
      Returns a comparator which determines which FilteringScores are + better.
      +
      intgetArrangementScore() +
      Returns a value which indicates how well the index property order + matches the property filter specification order.
      +
      intgetCoveringCount() +
      Returns number of covering property filters which are supported by the + evaluated index.
      +
      Filter<S>getCoveringFilter() +
      Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.
      +
      java.util.List<? extends Filter<S>>getCoveringFilters() +
      Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.
      +
      Filter<S>getCoveringRemainderFilter() +
      Returns the composite remainder filter without including the covering + filter.
      +
      java.util.List<PropertyFilter<S>>getExclusiveRangeEndFilters() +
      Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LT.
      +
      java.util.List<PropertyFilter<S>>getExclusiveRangeStartFilters() +
      Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GT.
      +
      intgetHandledCount() +
      Returns the count of all handled property filters.
      +
      Filter<S>getHandledFilter() +
      Returns the composite handled filter, or null if no matches at all.
      +
      intgetIdentityCount() +
      Returns number of consecutive left-aligned index properties which match + property filters with an operator of RelOp.EQ.
      +
      Filter<S>getIdentityFilter() +
      Returns the composite identity filter, or null if no identity property + filters.
      +
      java.util.List<PropertyFilter<S>>getIdentityFilters() +
      Returns the identity property filters supported by the evaluated + index.
      +
      java.util.List<PropertyFilter<S>>getInclusiveRangeEndFilters() +
      Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LE.
      +
      java.util.List<PropertyFilter<S>>getInclusiveRangeStartFilters() +
      Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GE.
      +
      intgetIndexPropertyCount() +
      Returns the amount of properties in the evaluated index.
      +
      java.lang.ComparablegetPreferenceScore() +
      Returns a value which indicates user index preference, based on the + original ordering of elements in the filter.
      +
      java.util.List<PropertyFilter<S>>getRangeEndFilters() +
      Returns the range end property filters supported by the evaluated + index.
      +
      java.util.List<PropertyFilter<S>>getRangeStartFilters() +
      Returns the range start property filters supported by the evaluated + index.
      +
      intgetRemainderCount() +
      Returns number of property filters not supported by the evaluated index.
      +
      Filter<S>getRemainderFilter() +
      Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.
      +
      java.util.List<? extends Filter<S>>getRemainderFilters() +
      Returns the filters not supported by the evaluated index.
      +
      booleanhasAnyMatches() +
      Returns true if the identity count is greater than zero or if there is a + range match.
      +
      booleanhasRangeEnd() +
      Returns true if any property filter with an operator of RelOp.LT + or RelOp.LE matches an index property.
      +
      booleanhasRangeMatch() +
      Returns true if there is both a range start and range end.
      +
      booleanhasRangeStart() +
      Returns true if any property filter with an operator of RelOp.GT + or RelOp.GE matches an index property.
      +
      booleanisIndexClustered() +
      Returns true if evaluated index is clustered.
      +
      booleanisIndexUnique() +
      Returns true if evaluated index is unique.
      +
      booleanisKeyMatch() +
      Returns true if evaluated index is unique and each of its properties has + an identity match.
      +
      Filter<S>mergeRemainderFilter(FilteringScore<S> other) +
      Merges the remainder filter of this score with the one given using an + 'or' operation.
      +
      static java.util.Comparator<FilteringScore<?>>rangeComparator() +
      Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches.
      +
      booleanshouldReverseRange() +
      Returns true if there is a range start or end match, but natural order + of matching property is descending.
      +
      java.lang.StringtoString() 
      FilteringScore<S>withRemainderFilter(Filter<S> filter) +
      Returns a new FilteringScore with the remainder replaced and covering + matches recalculated.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> FilteringScore<S> evaluate(StorableIndex<S> index,
+                                              Filter<S> filter)
        +
        Evaluates the given index for its filtering capabilities against the + given filter.
        +
        Parameters:
        index - index to evaluate
        filter - filter which cannot contain any logical 'or' operations.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> FilteringScore<S> evaluate(OrderedProperty<S>[] indexProperties,
+                                              boolean unique,
+                                              boolean clustered,
+                                              Filter<S> filter)
        +
        Evaluates the given index properties for its filtering capabilities + against the given filter.
        +
        Parameters:
        indexProperties - index properties to evaluate
        unique - true if index is unique
        clustered - true if index is clustered
        filter - filter which cannot contain any logical 'or' operations.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        rangeComparator

        +
        public static java.util.Comparator<FilteringScore<?>> rangeComparator()
        +
        Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches. It does not matter + if the scores were evaluated for different indexes or storable + types. The comparator returns <0 if first score is better, + 0 if equal, or >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        fullComparator

        +
        public static java.util.Comparator<FilteringScore<?>> fullComparator()
        +
        Returns a comparator which determines which FilteringScores are + better. It compares identity matches, range matches, open range matches + and property arrangement. It does not matter if the scores were + evaluated for different indexes or storable types. The comparator + returns <0 if first score is better, 0 if equal, or + >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        isIndexClustered

        +
        public boolean isIndexClustered()
        +
        Returns true if evaluated index is clustered. Scans of clustered indexes + are generally faster.
        +
        • +
      + + + +
        +
      • +

        isIndexUnique

        +
        public boolean isIndexUnique()
        +
        Returns true if evaluated index is unique.
        +
        • +
      + + + +
        +
      • +

        getIndexPropertyCount

        +
        public int getIndexPropertyCount()
        +
        Returns the amount of properties in the evaluated index.
        +
        • +
      + + + +
        +
      • +

        getIdentityCount

        +
        public int getIdentityCount()
        +
        Returns number of consecutive left-aligned index properties which match + property filters with an operator of RelOp.EQ.
        +
        • +
      + + + +
        +
      • +

        getIdentityFilters

        +
        public java.util.List<PropertyFilter<S>> getIdentityFilters()
        +
        Returns the identity property filters supported by the evaluated + index. The order of the list matches the order in which the properties + appear in the index. The operator of each filter is RelOp.EQ.
        +
        • +
      + + + +
        +
      • +

        getIdentityFilter

        +
        public Filter<S> getIdentityFilter()
        +
        Returns the composite identity filter, or null if no identity property + filters.
        +
        • +
      + + + +
        +
      • +

        hasRangeStart

        +
        public boolean hasRangeStart()
        +
        Returns true if any property filter with an operator of RelOp.GT + or RelOp.GE matches an index property. The index property used + for the range is the first one following the identity count.
        +
        • +
      + + + +
        +
      • +

        getRangeStartFilters

        +
        public java.util.List<PropertyFilter<S>> getRangeStartFilters()
        +
        Returns the range start property filters supported by the evaluated + index. The operator of each filter is either RelOp.GT or RelOp.GE. The property of each filter is identical, and the properties + are also identical to any range end filters.
        +
        • +
      + + + +
        +
      • +

        getExclusiveRangeStartFilters

        +
        public java.util.List<PropertyFilter<S>> getExclusiveRangeStartFilters()
        +
        Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GT. This list is a subset of + those returned by getRangeStartFilters().
        +
        • +
      + + + +
        +
      • +

        getInclusiveRangeStartFilters

        +
        public java.util.List<PropertyFilter<S>> getInclusiveRangeStartFilters()
        +
        Returns the range start property filters supported by the evaluated + index whose operator is only RelOp.GE. This list is a subset of + those returned by getRangeStartFilters().
        +
        • +
      + + + +
        +
      • +

        hasRangeEnd

        +
        public boolean hasRangeEnd()
        +
        Returns true if any property filter with an operator of RelOp.LT + or RelOp.LE matches an index property. The index property used + for the range is the first one following the identity count.
        +
        • +
      + + + +
        +
      • +

        getRangeEndFilters

        +
        public java.util.List<PropertyFilter<S>> getRangeEndFilters()
        +
        Returns the range end property filters supported by the evaluated + index. The operator of each filter is either RelOp.LT or RelOp.LE. The property of each filter is identical, and the properties + are also identical to any range start filters.
        +
        • +
      + + + +
        +
      • +

        getExclusiveRangeEndFilters

        +
        public java.util.List<PropertyFilter<S>> getExclusiveRangeEndFilters()
        +
        Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LT. This list is a subset of + those returned by getRangeEndFilters().
        +
        • +
      + + + +
        +
      • +

        getInclusiveRangeEndFilters

        +
        public java.util.List<PropertyFilter<S>> getInclusiveRangeEndFilters()
        +
        Returns the range end property filters supported by the evaluated + index whose operator is only RelOp.LE. This list is a subset of + those returned by getRangeEndFilters().
        +
        • +
      + + + +
        +
      • +

        getHandledCount

        +
        public int getHandledCount()
        +
        Returns the count of all handled property filters.
        +
        • +
      + + + +
        +
      • +

        getHandledFilter

        +
        public Filter<S> getHandledFilter()
        +
        Returns the composite handled filter, or null if no matches at all.
        +
        • +
      + + + +
        +
      • +

        hasRangeMatch

        +
        public boolean hasRangeMatch()
        +
        Returns true if there is both a range start and range end.
        +
        • +
      + + + +
        +
      • +

        hasAnyMatches

        +
        public boolean hasAnyMatches()
        +
        Returns true if the identity count is greater than zero or if there is a + range match.
        +
        • +
      + + + +
        +
      • +

        getArrangementScore

        +
        public int getArrangementScore()
        +
        Returns a value which indicates how well the index property order + matches the property filter specification order. A higher value + can indicate that the index is a slightly better match.
        +
        Returns:
        arrangement value, never negative
        +
        • +
      + + + +
        +
      • +

        getPreferenceScore

        +
        public java.lang.Comparable getPreferenceScore()
        +
        Returns a value which indicates user index preference, based on the + original ordering of elements in the filter. A higher value can + indicate that the index is a slightly better match.
        +
        Returns:
        preference value which can be compared to another one
        +
        • +
      + + + +
        +
      • +

        getRemainderCount

        +
        public int getRemainderCount()
        +
        Returns number of property filters not supported by the evaluated index.
        +
        • +
      + + + +
        +
      • +

        getRemainderFilters

        +
        public java.util.List<? extends Filter<S>> getRemainderFilters()
        +
        Returns the filters not supported by the evaluated index.
        +
        • +
      + + + +
        +
      • +

        getRemainderFilter

        +
        public Filter<S> getRemainderFilter()
        +
        Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.
        +
        • +
      + + + +
        +
      • +

        getCoveringCount

        +
        public int getCoveringCount()
        +
        Returns number of covering property filters which are supported by the + evaluated index. This count is no more than the remainder count. If + hasAnyMatches returns false, then the covering count is zero.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getCoveringFilters

        +
        public java.util.List<? extends Filter<S>> getCoveringFilters()
        +
        Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getCoveringFilter

        +
        public Filter<S> getCoveringFilter()
        +
        Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getCoveringRemainderFilter

        +
        public Filter<S> getCoveringRemainderFilter()
        +
        Returns the composite remainder filter without including the covering + filter. Returns null if no remainder.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        isKeyMatch

        +
        public boolean isKeyMatch()
        +
        Returns true if evaluated index is unique and each of its properties has + an identity match. When index and filter are used in a query, expect at + most one result.
        +
        • +
      + + + +
        +
      • +

        shouldReverseRange

        +
        public boolean shouldReverseRange()
        +
        Returns true if there is a range start or end match, but natural order + of matching property is descending.
        +
        • +
      + + + +
        +
      • +

        canMergeRemainderFilter

        +
        public boolean canMergeRemainderFilter(FilteringScore<S> other)
        +
        Returns true if the given score uses an index exactly the same as this + one. The only allowed differences are in the remainder filter.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderFilter

        +
        public Filter<S> mergeRemainderFilter(FilteringScore<S> other)
        +
        Merges the remainder filter of this score with the one given using an + 'or' operation. Call canMergeRemainderFilter first to verify if the + merge makes any sense. Returns null if no remainder filter at all.
        +
        • +
      + + + +
        +
      • +

        withRemainderFilter

        +
        public FilteringScore<S> withRemainderFilter(Filter<S> filter)
        +
        Returns a new FilteringScore with the remainder replaced and covering + matches recalculated. Other matches are not recalculated.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html new file mode 100644 index 0000000..2299151 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html @@ -0,0 +1,297 @@ + + + + + + +FullScanQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface FullScanQueryExecutor.Support<S extends Storable>

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

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        • +
      + + + +
        +
      • +

        countAll

        +
        long countAll()
+              throws FetchException
        +
        Counts all Storables. Implementation may return -1 to indicate that + default count algorithm should be used.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        countAll

        +
        long countAll(Query.Controller controller)
+              throws FetchException
        +
        Counts all Storables. Implementation may return -1 to indicate that + default count algorithm should be used.
        +
        Parameters:
        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.

+ + diff --git a/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html new file mode 100644 index 0000000..54f2300 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html @@ -0,0 +1,446 @@ + + + + + + +FullScanQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class FullScanQueryExecutor<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutor<S>
    +
    +
    +
    +
    public class FullScanQueryExecutor<S extends Storable>
+extends AbstractQueryExecutor<S>
    +
    QueryExecutor which fully scans all Storables of a given type.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html new file mode 100644 index 0000000..300d9a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html @@ -0,0 +1,518 @@ + + + + + + +IndexedQueryAnalyzer.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class IndexedQueryAnalyzer.Result

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

      Method Detail

      + + + +
        +
      • +

        handlesAnything

        +
        public boolean handlesAnything()
        +
        Returns true if the selected index does anything at all to filter + results or to order them. If not, a filtered and sorted full scan + makes more sense.
        +
        • +
      + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Returns combined handled and remainder filter for this result.
        +
        • +
      + + + +
        +
      • +

        getOrdering

        +
        public OrderingList<S> getOrdering()
        +
        Returns combined handled and remainder orderings for this result.
        +
        • +
      + + + +
        +
      • +

        getCompositeScore

        +
        public CompositeScore<S> getCompositeScore()
        +
        Returns the score on how well the selected index performs the + desired filtering and ordering.
        +
        • +
      + + + +
        +
      • +

        getRemainderFilter

        +
        public Filter<S> getRemainderFilter()
        +
        Remainder filter which overrides that in composite score.
        +
        • +
      + + + +
        +
      • +

        getRemainderOrdering

        +
        public OrderingList<S> getRemainderOrdering()
        +
        Remainder orderings which override that in composite score.
        +
        • +
      + + + +
        +
      • +

        getLocalIndex

        +
        public StorableIndex<S> getLocalIndex()
        +
        Returns the local index that was selected, or null if a foreign + index was selected.
        +
        • +
      + + + +
        +
      • +

        getForeignIndex

        +
        public StorableIndex<?> getForeignIndex()
        +
        Returns the foreign index that was selected, or null if a local + index was selected. If a foreign index has been selected, then a + JoinedQueryExecutor is needed.
        +
        • +
      + + + +
        +
      • +

        getForeignProperty

        +
        public ChainedProperty<S> getForeignProperty()
        +
        Returns the simple or chained property that maps to the selected + foreign index. Returns null if foreign index was not selected. This + property corresponds to the "targetToSourceProperty" of JoinedQueryExecutor.
        +
        • +
      + + + +
        +
      • +

        isIndexClustered

        +
        public boolean isIndexClustered()
        +
        Returns true if local or foreign index is clustered. Scans of + clustered indexes are generally faster.
        +
        • +
      + + + +
        +
      • +

        canMergeRemainder

        +
        public boolean canMergeRemainder(IndexedQueryAnalyzer.Result other)
        +
        Returns true if the given result uses the same index as this, and in + the same way. The only allowed differences are in the remainder + filter and orderings.
        +
        • +
      + + + +
        +
      • +

        mergeRemainder

        +
        public IndexedQueryAnalyzer.Result mergeRemainder(IndexedQueryAnalyzer.Result other)
        +
        Merges the remainder filter and orderings of this result with the + one given, returning a new result. Call canMergeRemainder first to + verify if the merge makes any sense.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderFilter

        +
        public IndexedQueryAnalyzer.Result mergeRemainderFilter(Filter<S> filter)
        +
        Merges the remainder filter of this result with the given filter, + returning a new result. If handlesAnything return true, then it + doesn't usually make sense to call this method.
        +
        • +
      + + + +
        +
      • +

        withRemainderFilter

        +
        public IndexedQueryAnalyzer.Result withRemainderFilter(Filter<S> remainderFilter)
        +
        Returns a new result with the remainder filter replaced.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html new file mode 100644 index 0000000..b427293 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html @@ -0,0 +1,316 @@ + + + + + + +IndexedQueryAnalyzer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class IndexedQueryAnalyzer<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class IndexedQueryAnalyzer<S extends Storable>
+extends java.lang.Object
    +
    Analyzes a simple query specification and determines which index is best + suited for its execution. Query filters passed to this analyzer cannot + contain any 'or' operations. + +

    IndexedQueryAnalyzer is sharable and thread-safe. An instance for a + particular Storable type can be cached, avoiding repeated construction + cost. In addition, the analyzer caches learned foreign indexes.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    UnionQueryAnalyzer
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IndexedQueryAnalyzer

        +
        public IndexedQueryAnalyzer(java.lang.Class<S> type,
+                    RepositoryAccess access)
        +
        Parameters:
        type - type of storable being queried
        access - repository access for examing available indexes
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type or indexProvider is null
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + 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.

+ + diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html new file mode 100644 index 0000000..89c23a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html @@ -0,0 +1,436 @@ + + + + + + +IndexedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class IndexedQueryExecutor<S extends Storable>

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

      Method Detail

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

        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
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html new file mode 100644 index 0000000..42310dd --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html @@ -0,0 +1,386 @@ + + + + + + +IterableQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class IterableQueryExecutor<S extends Storable>

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

      Constructor Detail

      + + + +
        +
      • +

        IterableQueryExecutor

        +
        public IterableQueryExecutor(java.lang.Class<S> type,
+                     java.lang.Iterable<S> iterable)
        +
        Parameters:
        type - type of Storable
        iterable - collection to iterate over, or null for empty cursor
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type is null
        +
        • +
      + + + +
        +
      • +

        IterableQueryExecutor

        +
        public IterableQueryExecutor(java.lang.Class<S> type,
+                     java.lang.Iterable<S> iterable,
+                     java.util.concurrent.locks.Lock lock)
        +
        Parameters:
        type - type of Storable
        iterable - collection to iterate over, or null for empty cursor
        lock - optional lock to hold while cursor is open
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type is null
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Returns an open filter.
        +
        Returns:
        query filter, never null
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        public Cursor<S> fetch(FilterValues<S> values)
        +
        Description copied from interface: QueryExecutor
        +
        Returns a new cursor using the given filter values.
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        public Cursor<S> fetch(FilterValues<S> values,
+              Query.Controller controller)
        +
        Description copied from interface: QueryExecutor
        +
        Returns a new cursor using the given filter values.
        +
        controller - optional controller which can abort query operation
        +
        • +
      + + + +
        +
      • +

        getOrdering

        +
        public OrderingList<S> getOrdering()
        +
        Returns an empty list.
        +
        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
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html new file mode 100644 index 0000000..e8fd436 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html @@ -0,0 +1,374 @@ + + + + + + +JoinedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class JoinedQueryExecutor<S extends Storable,T extends Storable>

+
+
+ +
+
    +
  • +
    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 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
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        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
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html new file mode 100644 index 0000000..ec60bce --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html @@ -0,0 +1,254 @@ + + + + + + +KeyQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface KeyQueryExecutor.Support<S extends Storable>

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Cursor<S>fetchOne(StorableIndex<S> index, + java.lang.Object[] identityValues) +
      Select at most one Storable referenced by an index.
      +
      Cursor<S>fetchOne(StorableIndex<S> index, + java.lang.Object[] identityValues, + Query.Controller controller) +
      Select at most one Storable referenced by an index.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fetchOne

        +
        Cursor<S> fetchOne(StorableIndex<S> index,
+                 java.lang.Object[] identityValues)
+                                    throws FetchException
        +
        Select at most one Storable referenced by an index. The identity + values fully specify all elements of the index, and the index is + unique.
        +
        Parameters:
        index - index to open, which may be a primary key index
        identityValues - of exactly matching values to apply to index
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        fetchOne

        +
        Cursor<S> fetchOne(StorableIndex<S> index,
+                 java.lang.Object[] identityValues,
+                 Query.Controller controller)
+                                    throws FetchException
        +
        Select at most one Storable referenced by an index. The identity + values fully specify all elements of the index, and the index is + unique.
        +
        Parameters:
        controller - optional controller which can abort query operation
        index - index to open, which may be a primary key index
        identityValues - of exactly matching values to apply to index
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html new file mode 100644 index 0000000..4a39b5a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html @@ -0,0 +1,421 @@ + + + + + + +KeyQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class KeyQueryExecutor<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutor<S>
    +
    +
    +
    +
    public class KeyQueryExecutor<S extends Storable>
+extends AbstractQueryExecutor<S>
    +
    QueryExecutor which has a fully specified key, and so cursors produce at + most one result.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeyQueryExecutor

        +
        public KeyQueryExecutor(KeyQueryExecutor.Support<S> support,
+                StorableIndex<S> index,
+                FilteringScore<S> score)
        +
        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 or if index is + not unique or if score is not a key match
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/OrderingList.html b/apidocs/com/amazon/carbonado/qe/OrderingList.html new file mode 100644 index 0000000..f33cfe9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/OrderingList.html @@ -0,0 +1,559 @@ + + + + + + +OrderingList (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class OrderingList<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Iterable<OrderedProperty<S>>, java.util.Collection<OrderedProperty<S>>, java.util.List<OrderedProperty<S>>
    +
    +
    +
    +
    public class OrderingList<S extends Storable>
+extends java.util.AbstractList<OrderedProperty<S>>
+implements java.io.Serializable
    +
    Produces unmodifiable lists of orderings. Instances + are immutable, canonical and cached. Calls to "equals" and "hashCode" are + fast.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.util.AbstractList

        +modCount
        • +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      OrderingList<S>concat(java.lang.Class<S> type, + java.lang.String property) +
      Returns a list which concatenates this one with the given property.
      +
      OrderingList<S>concat(OrderedProperty<S> property) +
      Returns a list which concatenates this one with the given property.
      +
      OrderingList<S>concat(OrderingList<S> other) +
      Returns a list which concatenates this one with the other one.
      +
      static <S extends Storable> 
      OrderingList<S>      		emptyList() +
      Returns a canonical empty instance.
      +
      booleanequals(java.lang.Object other) 
      static <S extends Storable> 
      OrderingList<S>      		get(java.lang.Class<S> type, + java.lang.String... orderings) +
      Returns a canonical instance composed of the given orderings.
      +
      static <S extends Storable> 
      OrderingList<S>      		get(java.lang.Class<S> type, + java.lang.String property) +
      Returns a canonical instance composed of the given ordering.
      +
      OrderedProperty<S>get(int index) 
      static <S extends Storable> 
      OrderingList<S>      		get(java.util.List<OrderedProperty<S>> orderings) +
      Returns a canonical instance composed of the given orderings.
      +
      static <S extends Storable> 
      OrderingList<S>      		get(OrderedProperty<S>... orderings) +
      Returns a canonical instance composed of the given orderings.
      +
      inthashCode() 
      OrderingList<S>reduce() +
      Eliminates redundant ordering properties.
      +
      OrderingList<S>replace(int index, + OrderedProperty<S> property) +
      Returns a list with the given element replaced.
      +
      OrderingList<S>reverseDirections() +
      Returns this list with all orderings in reverse.
      +
      intsize() 
      OrderingList<S>subList(int fromIndex, + int toIndex) 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractList

        +add, add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.List

        +addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        emptyList

        +
        public static <S extends Storable> OrderingList<S> emptyList()
        +
        Returns a canonical empty instance.
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> OrderingList<S> get(java.lang.Class<S> type,
+                                       java.lang.String property)
        +
        Returns a canonical instance composed of the given ordering.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if ordering property is not in S
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> OrderingList<S> get(java.lang.Class<S> type,
+                                       java.lang.String... orderings)
        +
        Returns a canonical instance composed of the given orderings.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any ordering property is not in S
        +
        • +
      + + + + + + + +
        +
      • +

        get

        +
        public static <S extends Storable> OrderingList<S> get(java.util.List<OrderedProperty<S>> orderings)
        +
        Returns a canonical instance composed of the given orderings.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        concat

        +
        public OrderingList<S> concat(java.lang.Class<S> type,
+                     java.lang.String property)
        +
        Returns a list which concatenates this one with the given property.
        +
        • +
      + + + +
        +
      • +

        concat

        +
        public OrderingList<S> concat(OrderedProperty<S> property)
        +
        Returns a list which concatenates this one with the given property.
        +
        • +
      + + + +
        +
      • +

        concat

        +
        public OrderingList<S> concat(OrderingList<S> other)
        +
        Returns a list which concatenates this one with the other one.
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public OrderingList<S> reduce()
        +
        Eliminates redundant ordering properties.
        +
        • +
      + + + +
        +
      • +

        reverseDirections

        +
        public OrderingList<S> reverseDirections()
        +
        Returns this list with all orderings in reverse.
        +
        • +
      + + + + + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/OrderingScore.html b/apidocs/com/amazon/carbonado/qe/OrderingScore.html new file mode 100644 index 0000000..6b327ce --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/OrderingScore.html @@ -0,0 +1,547 @@ + + + + + + +OrderingScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class OrderingScore<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class OrderingScore<S extends Storable>
+extends java.lang.Object
    +
    Evaluates an index for how well it matches a query's desired ordering. An + ordering score is not a single absolute value – instead it has a relative + weight when compared to other scores. + +

    An index matches a desired ordering if the arrangement of properties + matches. Not all properties of the index need to be used, however. Also, + gaps in the arrangement are allowed if a property identity filter + matches. A property identity filter is of the form "a = ?". + +

    An OrderingScore measures the number of ordering properties that are + matched and the number that are remaining. If there are remainder + properties, then the user of the evaluated index will need to perform a + post-sort operation to achieve the desired results. + +

    In general, an OrderingScore is better than another if it has more + matched properties and fewer remainder properties. Index clustering, + property count, and natural order is also considered.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    FilteringScore, +CompositeScore
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> OrderingScore<S> evaluate(StorableIndex<S> index,
+                                             Filter<S> filter,
+                                             OrderingList<S> ordering)
        +
        Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.
        +
        Parameters:
        index - index to evaluate
        filter - optional filter which cannot contain any logical 'or' operations.
        ordering - optional properties which define desired ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        evaluate

        +
        public static <S extends Storable> OrderingScore<S> evaluate(OrderedProperty<S>[] indexProperties,
+                                             boolean unique,
+                                             boolean clustered,
+                                             Filter<S> filter,
+                                             OrderingList<S> ordering)
        +
        Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.
        +
        Parameters:
        indexProperties - index properties to evaluate
        unique - true if index is unique
        clustered - true if index is clustered
        filter - optional filter which cannot contain any logical 'or' operations.
        ordering - optional properties which define desired ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is null or filter is not supported
        +
        • +
      + + + +
        +
      • +

        fullComparator

        +
        public static java.util.Comparator<OrderingScore<?>> fullComparator()
        +
        Returns a comparator which determines which OrderingScores are + better. It does not matter if the scores were evaluated for different + indexes or storable types. The comparator returns <0 if first + score is better, 0 if equal, or >0 if second is better.
        +
        • +
      + + + +
        +
      • +

        isIndexClustered

        +
        public boolean isIndexClustered()
        +
        Returns true if evaluated index is clustered. Scans of clustered indexes + are generally faster.
        +
        • +
      + + + +
        +
      • +

        getIndexPropertyCount

        +
        public int getIndexPropertyCount()
        +
        Returns the amount of properties in the evaluated index.
        +
        • +
      + + + +
        +
      • +

        getHandledCount

        +
        public int getHandledCount()
        +
        Returns the number of desired orderings the evaluated index + supports. The number of orderings is reduced to eliminate redundancies.
        +
        • +
      + + + +
        +
      • +

        getHandledOrdering

        +
        public OrderingList<S> getHandledOrdering()
        +
        Returns the ordering properties that the evaluated index supports. The + list of orderings is reduced to eliminate redundancies. If any handled + ordering properties originally had an unspecified direction, the correct + direction is specified in this list.
        +
        Returns:
        handled orderings, never null
        +
        • +
      + + + +
        +
      • +

        getRemainderCount

        +
        public int getRemainderCount()
        +
        Returns the number of desired orderings the evaluated index does not + support. The number of orderings is reduced to eliminate redundancies. + When the remainder count is non-zero, a query plan which uses the + evaluated index must perform a sort.
        +
        • +
      + + + +
        +
      • +

        getRemainderOrdering

        +
        public OrderingList<S> getRemainderOrdering()
        +
        Returns the ordering properties that the evaluated index does not + support. The list of orderings is reduced to eliminate redundancies.
        +
        Returns:
        remainder orderings, never null
        +
        • +
      + + + +
        +
      • +

        shouldReverseOrder

        +
        public boolean shouldReverseOrder()
        +
        Returns true if evaluated index must be iterated in reverse to achieve + the desired ordering.
        +
        • +
      + + + +
        +
      • +

        getFreeOrdering

        +
        public OrderingList<S> getFreeOrdering()
        +
        Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings. The + direction of any free orderings may be UNSPECIFIED, which indicates that + specific order is not relevant.
        +
        Returns:
        free orderings, never null
        +
        • +
      + + + +
        +
      • +

        getUnusedOrdering

        +
        public OrderingList<S> getUnusedOrdering()
        +
        Returns unused ordering properties of the evaluated index because they + were filtered out. The direction of each unused ordering is UNSPECIFIED + because specific order is not relevant.
        +
        Returns:
        unused orderings, never null
        +
        • +
      + + + +
        +
      • +

        canMergeRemainderOrdering

        +
        public boolean canMergeRemainderOrdering(OrderingScore<S> other)
        +
        Returns true if the given score uses an index exactly the same as this + one. The only allowed differences are in the count of remainder + orderings.
        +
        • +
      + + + +
        +
      • +

        mergeRemainderOrdering

        +
        public OrderingList<S> mergeRemainderOrdering(OrderingScore<S> other)
        +
        Merges the remainder orderings of this score with the one given. Call + canMergeRemainderOrdering first to verify if the merge makes any sense.
        +
        • +
      + + + +
        +
      • +

        withRemainderOrdering

        +
        public OrderingScore<S> withRemainderOrdering(OrderingList<S> ordering)
        +
        Returns a new OrderingScore with the remainder replaced. Handled count + is not recalculated.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryEngine.html b/apidocs/com/amazon/carbonado/qe/QueryEngine.html new file mode 100644 index 0000000..fdcbeb3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryEngine.html @@ -0,0 +1,329 @@ + + + + + + +QueryEngine (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class QueryEngine<S extends Storable>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutor.html b/apidocs/com/amazon/carbonado/qe/QueryExecutor.html new file mode 100644 index 0000000..b3f7950 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutor.html @@ -0,0 +1,437 @@ + + + + + + +QueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface QueryExecutor<S extends Storable>

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

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        Returns the storable type that this executor operates on.
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        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
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        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
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html b/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html new file mode 100644 index 0000000..9d73f5a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html @@ -0,0 +1,300 @@ + + + + + + +QueryExecutorCache (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class QueryExecutorCache<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutorFactory<S>
    +
    +
    +
    +
    public class QueryExecutorCache<S extends Storable>
+extends java.lang.Object
+implements QueryExecutorFactory<S>
    +
    QueryExecutors should be cached since expensive analysis is often required to build + them. By default, a minimum of 100 query executors can be cached per Storable type. + The minimum can be changed with the + "com.amazon.carbonado.qe.QueryExecutorCache.minCapacity" system property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html new file mode 100644 index 0000000..f8d3b30 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html @@ -0,0 +1,239 @@ + + + + + + +QueryExecutorFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface QueryExecutorFactory<S extends Storable>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryFactory.html b/apidocs/com/amazon/carbonado/qe/QueryFactory.html new file mode 100644 index 0000000..4cad899 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryFactory.html @@ -0,0 +1,241 @@ + + + + + + +QueryFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface QueryFactory<S extends Storable>

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

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        • +
      + + + +
        +
      • +

        query

        +
        Query<S> query(Filter<S> filter,
+             FilterValues<S> values,
+             OrderingList<S> ordering,
+             QueryHints hints)
+                                throws FetchException
        +
        Returns a query that handles the given query specification.
        +
        Parameters:
        filter - optional filter object, defaults to open filter if null
        values - optional values object, defaults to filter initial values
        ordering - optional order-by properties
        hints - optional hints
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryHint.html b/apidocs/com/amazon/carbonado/qe/QueryHint.html new file mode 100644 index 0000000..41f32ac --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryHint.html @@ -0,0 +1,320 @@ + + + + + + +QueryHint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Enum QueryHint

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<QueryHint>
    +
    +
    +
    +
    public enum QueryHint
+extends java.lang.Enum<QueryHint>
    +
    Defines a hint key.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    QueryHints
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      CONSUME_SLICE +
      Intention to consume a slice of matched records
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static QueryHintvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static QueryHint[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        CONSUME_SLICE

        +
        public static final QueryHint CONSUME_SLICE
        +
        Intention to consume a slice of matched records
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static QueryHint[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (QueryHint c : QueryHint.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static QueryHint valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/QueryHints.html b/apidocs/com/amazon/carbonado/qe/QueryHints.html new file mode 100644 index 0000000..6e631c7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryHints.html @@ -0,0 +1,387 @@ + + + + + + +QueryHints (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class QueryHints

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class QueryHints
+extends java.lang.Object
+implements java.io.Serializable
    +
    An immutable map of query hints.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    QueryHint, +Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancontains(QueryHint hint) +
      Returns false if hint is not provided.
      +
      static QueryHintsemptyHints() 
      booleanequals(java.lang.Object obj) 
      java.lang.Objectget(QueryHint hint) +
      Returns null if hint is not provided.
      +
      inthashCode() 
      booleanisEmpty() 
      java.lang.StringtoString() 
      QueryHintswith(QueryHint hint) +
      Returns a new QueryHints object with the given hint.
      +
      QueryHintswith(QueryHint hint, + java.lang.Object value) +
      Returns a new QueryHints object with the given hint and value.
      +
      QueryHintswithout(QueryHint hint) +
      Returns a new QueryHints object without the given hint.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        emptyHints

        +
        public static QueryHints emptyHints()
        +
        • +
      + + + +
        +
      • +

        with

        +
        public QueryHints with(QueryHint hint)
        +
        Returns a new QueryHints object with the given hint. The associated + value is the hint object itself.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if hint is null
        +
        • +
      + + + +
        +
      • +

        with

        +
        public QueryHints with(QueryHint hint,
+              java.lang.Object value)
        +
        Returns a new QueryHints object with the given hint and value.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if hint or value is null
        +
        • +
      + + + +
        +
      • +

        without

        +
        public QueryHints without(QueryHint hint)
        +
        Returns a new QueryHints object without the given hint.
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains(QueryHint hint)
        +
        Returns false if hint is not provided.
        +
        • +
      + + + +
        +
      • +

        get

        +
        public java.lang.Object get(QueryHint hint)
        +
        Returns null if hint is not provided.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html b/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html new file mode 100644 index 0000000..761a4ee --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html @@ -0,0 +1,238 @@ + + + + + + +RepositoryAccess (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface RepositoryAccess

+
+
+
+
    +
  • +
    +
    +
    public interface RepositoryAccess
    +
    Provides internal access to a Repository, necessary for query + execution.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html new file mode 100644 index 0000000..628115a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html @@ -0,0 +1,296 @@ + + + + + + +SortedQueryExecutor.ArraySortSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class SortedQueryExecutor.ArraySortSupport<S extends Storable>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html new file mode 100644 index 0000000..c5b2888 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html @@ -0,0 +1,296 @@ + + + + + + +SortedQueryExecutor.MergeSortSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class SortedQueryExecutor.MergeSortSupport<S extends Storable>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html new file mode 100644 index 0000000..714d83d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html @@ -0,0 +1,241 @@ + + + + + + +SortedQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface SortedQueryExecutor.Support<S extends Storable>

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

      Method Detail

      + + + +
        +
      • +

        createSortBuffer

        +
        SortBuffer<S> createSortBuffer()
        +
        Implementation must return an empty buffer for sorting.
        +
        • +
      + + + +
        +
      • +

        createSortBuffer

        +
        SortBuffer<S> createSortBuffer(Query.Controller controller)
        +
        Implementation must return an empty buffer for sorting.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html new file mode 100644 index 0000000..9f616f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html @@ -0,0 +1,494 @@ + + + + + + +SortedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class SortedQueryExecutor<S extends Storable>

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/StandardQuery.html b/apidocs/com/amazon/carbonado/qe/StandardQuery.html new file mode 100644 index 0000000..51544d0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StandardQuery.html @@ -0,0 +1,1368 @@ + + + + + + +StandardQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class StandardQuery<S extends Storable>

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <T extends S> 
      Query<S>      		after(T start) +
      Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.
      +
      Query<S>and(Filter<S> filter) +
      Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
      +
      voidappendTo(java.lang.Appendable app) +
      Append the string representation of this object to the given Appendable.
      +
      protected voidclearExecutor() +
      Clears any cached reference to a query executor.
      +
      longcount() +
      Returns a count of all results matched by this query.
      +
      longcount(Query.Controller controller) +
      Returns a count of all results matched by this query.
      +
      voiddeleteAll() +
      Deletes zero or more matching objects.
      +
      voiddeleteAll(Query.Controller controller) +
      Deletes zero or more matching objects.
      +
      protected abstract TransactionenterTransaction(IsolationLevel level) +
      Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.
      +
      booleanequals(java.lang.Object obj) 
      protected QueryExecutor<S>executor() +
      Returns the executor in use by this query.
      +
      protected abstract QueryExecutorFactory<S>executorFactory() +
      Return a QueryExecutorFactory which is used to get an executor.
      +
      booleanexists() +
      Returns true if any results are matched by this query.
      +
      booleanexists(Query.Controller controller) +
      Returns true if any results are matched by this query.
      +
      Cursor<S>fetch() +
      Fetches results for this query.
      +
      Cursor<S>fetch(Query.Controller controller) +
      Fetches results for this query.
      +
      Cursor<S>fetchSlice(long from, + java.lang.Long to) +
      Fetches a slice of results for this query, as defined by a numerical + range.
      +
      Cursor<S>fetchSlice(long from, + java.lang.Long to, + Query.Controller controller) +
      Fetches a slice of results for this query, as defined by a numerical + range.
      +
      intgetBlankParameterCount() +
      Returns the amount of blank parameters that need to be filled in.
      +
      Filter<S>getFilter() +
      Returns the query's filter.
      +
      FilterValues<S>getFilterValues() +
      Returns the query's filter values, which is null if filter has no + parameters.
      +
      protected OrderingList<S>getOrdering() 
      java.lang.Class<S>getStorableType() +
      Returns the specific type of Storable managed by this object.
      +
      inthashCode() 
      protected abstract StandardQuery<S>newInstance(FilterValues<S> values, + OrderingList<S> ordering, + QueryHints hints) +
      Return a new or cached instance of StandardQuery implementation, using + new filter values.
      +
      Query<S>not() +
      Returns a new query which produces all the results not supplied in this + query.
      +
      Query<S>or(Filter<S> filter) +
      Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
      +
      Query<S>orderBy(java.lang.String... properties) +
      Returns a copy of this query ordered by specific property values.
      +
      Query<S>orderBy(java.lang.String property) +
      Returns a copy of this query ordered by a specific property value.
      +
      booleanprintNative(java.lang.Appendable app, + int indentLevel) +
      Prints the native query to any appendable, which is useful for + performance analysis.
      +
      booleanprintPlan(java.lang.Appendable app, + int indentLevel) +
      Prints the query excecution plan to any appendable, which is useful for + performance analysis.
      +
      protected abstract QueryFactory<S>queryFactory() +
      Return a QueryFactory which is used to form new queries from this one.
      +
      protected voidresetExecutor() +
      Resets any cached reference to a query executor.
      +
      protected voidsetExecutor() +
      Ensures that a cached query executor reference is available.
      +
      booleantryDeleteOne() +
      Deletes zero or one matching objects.
      +
      booleantryDeleteOne(Query.Controller controller) +
      Deletes zero or one matching objects.
      +
      Query<S>with(boolean value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(byte value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(char value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(double value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(float value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(int value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(long value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(java.lang.Object value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>with(short value) +
      Returns a copy of this Query with the next blank parameter filled in.
      +
      Query<S>withValues(java.lang.Object... values) +
      Returns a copy of this Query with the next blank parameters filled in.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StandardQuery

        +
        protected StandardQuery(Filter<S> filter,
+             FilterValues<S> values,
+             OrderingList<S> ordering,
+             QueryHints hints)
        +
        Parameters:
        filter - optional filter object, defaults to open filter if null
        values - optional values object, defaults to filter initial values
        ordering - optional order-by properties
        hints - optional query hints
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Description copied from interface: Query
        +
        Returns the specific type of Storable managed by this object.
        +
        +
        Specified by:
        +
        getStorableType in interface Query<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        getFilter

        +
        public Filter<S> getFilter()
        +
        Description copied from interface: Query
        +
        Returns the query's filter.
        +
        +
        Specified by:
        +
        getFilter in interface Query<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        getFilterValues

        +
        public FilterValues<S> getFilterValues()
        +
        Description copied from interface: Query
        +
        Returns the query's filter values, which is null if filter has no + parameters.
        +
        +
        Specified by:
        +
        getFilterValues in interface Query<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        getBlankParameterCount

        +
        public int getBlankParameterCount()
        +
        Description copied from interface: Query
        +
        Returns the amount of blank parameters that need to be filled in. If + zero, then this query is ready to be used.
        +
        +
        Specified by:
        +
        getBlankParameterCount in interface Query<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(int value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(long value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(float value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(double value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(boolean value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(char value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(byte value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(short value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        with

        +
        public Query<S> with(java.lang.Object value)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameter filled in.
        +
        +
        Specified by:
        +
        with in interface Query<S extends Storable>
        +
        Parameters:
        value - parameter value to fill in
        +
        • +
      + + + +
        +
      • +

        withValues

        +
        public Query<S> withValues(java.lang.Object... values)
        +
        Description copied from interface: Query
        +
        Returns a copy of this Query with the next blank parameters filled in.
        +
        +
        Specified by:
        +
        withValues in interface Query<S extends Storable>
        +
        Parameters:
        values - parameter values to fill in; if null or empty, this + Query instance is returned
        +
        • +
      + + + +
        +
      • +

        and

        +
        public Query<S> and(Filter<S> filter)
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "and"ed to this, potentially reducing the amount of + results.
        +
        +
        Specified by:
        +
        and in interface Query<S extends Storable>
        +
        Parameters:
        filter - query filter
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        or

        +
        public Query<S> or(Filter<S> filter)
+                             throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which has another filter logically "or"ed to this, potentially increasing the amount of + results.
        +
        +
        Specified by:
        +
        or in interface Query<S extends Storable>
        +
        Parameters:
        filter - query filter
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        not

        +
        public Query<S> not()
+                              throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a new query which produces all the results not supplied in this + query. Any filled in parameters in this query are copied into the new + one.
        +
        +
        Specified by:
        +
        not in interface Query<S extends Storable>
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        public Query<S> orderBy(java.lang.String property)
+                                  throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a copy of this query ordered by a specific property value. The + property name may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        +
        Specified by:
        +
        orderBy in interface Query<S extends Storable>
        +
        Parameters:
        property - name of property to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        orderBy

        +
        public Query<S> orderBy(java.lang.String... properties)
+                                  throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a copy of this query ordered by specific property values. The + property names may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + +

        Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.

        +
        +
        Specified by:
        +
        orderBy in interface Query<S extends Storable>
        +
        Parameters:
        properties - names of properties to order by
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + + + +
        +
      • +

        after

        +
        public <T extends S> Query<S> after(T start)
+                                throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor. This is only + effective when query has been given an explicit ordering. If not a total ordering, then query may start at an earlier + position. + +

        Note: The returned query can be very expensive to fetch from + repeatedly, if the query needs to perform a sort operation. Ideally, the + query ordering should match the natural ordering of an index or key.

        +
        +
        Specified by:
        +
        after in interface Query<S extends Storable>
        +
        Parameters:
        start - storable to attempt to start after; if null, this query is + returned
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        public Cursor<S> fetch()
+                                 throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.
        +
        +
        Specified by:
        +
        fetch in interface Query<S extends Storable>
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel)
        +
        • +
      + + + +
        +
      • +

        fetch

        +
        public Cursor<S> fetch(Query.Controller controller)
+                                 throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.
        +
        +
        Specified by:
        +
        fetch in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        See Also:
        Repository.enterTransaction(IsolationLevel)
        +
        • +
      + + + +
        +
      • +

        fetchSlice

        +
        public Cursor<S> fetchSlice(long from,
+                   java.lang.Long to)
+                                      throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total ordering in order for the slice results to be deterministic.
        +
        +
        Specified by:
        +
        fetchSlice in interface Query<S extends Storable>
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        fetchSlice

        +
        public Cursor<S> fetchSlice(long from,
+                   java.lang.Long to,
+                   Query.Controller controller)
+                                      throws FetchException
        +
        Description copied from interface: Query
        +
        Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total ordering in order for the slice results to be deterministic.
        +
        +
        Specified by:
        +
        fetchSlice in interface Query<S extends Storable>
        +
        Parameters:
        from - zero-based from record number, inclusive
        to - optional zero-based to record number, exclusive
        controller - optional controller which can abort query operation
        +
        Returns:
        fetch results
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryDeleteOne

        +
        public boolean tryDeleteOne()
+                     throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        +
        Specified by:
        +
        tryDeleteOne in interface Query<S extends Storable>
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        Throws:
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        tryDeleteOne

        +
        public boolean tryDeleteOne(Query.Controller controller)
+                     throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.
        +
        +
        Specified by:
        +
        tryDeleteOne in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if record existed and was deleted, or false if no match
        +
        Throws:
        +
        PersistMultipleException - if more than one record matches
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll()
+               throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.
        +
        +
        Specified by:
        +
        deleteAll in interface Query<S extends Storable>
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll(Query.Controller controller)
+               throws PersistException
        +
        Description copied from interface: Query
        +
        Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.
        +
        +
        Specified by:
        +
        deleteAll in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        PersistException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        count

        +
        public long count()
+           throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.
        +
        +
        Specified by:
        +
        count in interface Query<S extends Storable>
        +
        Returns:
        count of matches
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        count

        +
        public long count(Query.Controller controller)
+           throws FetchException
        +
        Description copied from interface: Query
        +
        Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.
        +
        +
        Specified by:
        +
        count in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        count of matches
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists()
+               throws FetchException
        +
        Description copied from interface: Query
        +
        Returns true if any results are matched by this query.
        +
        +
        Specified by:
        +
        exists in interface Query<S extends Storable>
        +
        Returns:
        true if any matches
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public boolean exists(Query.Controller controller)
+               throws FetchException
        +
        Description copied from interface: Query
        +
        Returns true if any results are matched by this query.
        +
        +
        Specified by:
        +
        exists in interface Query<S extends Storable>
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Returns:
        true if any matches
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app,
+                  int indentLevel)
+                    throws java.io.IOException
        +
        Description copied from interface: Query
        +
        Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.
        +
        +
        Specified by:
        +
        printNative in interface Query<S extends Storable>
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        printPlan

        +
        public boolean printPlan(java.lang.Appendable app,
+                int indentLevel)
+                  throws java.io.IOException
        +
        Description copied from interface: Query
        +
        Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.
        +
        +
        Specified by:
        +
        printPlan in interface Query<S extends Storable>
        +
        Parameters:
        app - append results here
        indentLevel - amount to indent text, zero for none
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Description copied from interface: Appender
        +
        Append the string representation of this object to the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        setExecutor

        +
        protected void setExecutor()
+                    throws RepositoryException
        +
        Ensures that a cached query executor reference is available. If not, the + query executor factory is called and the executor is cached.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        resetExecutor

        +
        protected void resetExecutor()
+                      throws RepositoryException
        +
        Resets any cached reference to a query executor. If a reference is + available, it is replaced, but a clear reference is not set.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        clearExecutor

        +
        protected void clearExecutor()
        +
        Clears any cached reference to a query executor. The next time this + Query is used, it will get an executor from the query executor factory + and cache a reference to it.
        +
        • +
      + + + +
        +
      • +

        enterTransaction

        +
        protected abstract Transaction enterTransaction(IsolationLevel level)
        +
        Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.
        +
        Parameters:
        level - minimum desired isolation level
        +
        • +
      + + + +
        +
      • +

        queryFactory

        +
        protected abstract QueryFactory<S> queryFactory()
        +
        Return a QueryFactory which is used to form new queries from this one.
        +
        • +
      + + + +
        +
      • +

        executorFactory

        +
        protected abstract QueryExecutorFactory<S> executorFactory()
        +
        Return a QueryExecutorFactory which is used to get an executor.
        +
        • +
      + + + +
        +
      • +

        newInstance

        +
        protected abstract StandardQuery<S> newInstance(FilterValues<S> values,
+                           OrderingList<S> ordering,
+                           QueryHints hints)
        +
        Return a new or cached instance of StandardQuery implementation, using + new filter values. The Filter in the FilterValues is the same as was + passed in the constructor.
        +
        Parameters:
        values - non-null values object
        ordering - order-by properties, never null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html b/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html new file mode 100644 index 0000000..d26bbc1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html @@ -0,0 +1,535 @@ + + + + + + +StandardQueryFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class StandardQueryFactory<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryFactory<S>
    +
    +
    +
    Direct Known Subclasses:
    +
    QueryEngine
    +
    +
    +
    +
    public abstract class StandardQueryFactory<S extends Storable>
+extends java.lang.Object
+implements QueryFactory<S>
    +
    Builds and caches StandardQuery instances.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StandardQueryFactory

        +
        protected StandardQueryFactory(java.lang.Class<S> type)
        +
        • +
      + + + +
        +
      • +

        StandardQueryFactory

        +
        protected StandardQueryFactory(java.lang.Class<S> type,
+                    boolean lazySetExecutor)
        +
        Parameters:
        lazySetExecutor - by default, query executors are built and set + eagerly. Pass true to build and set executor on first query use.
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html new file mode 100644 index 0000000..cfec807 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html @@ -0,0 +1,565 @@ + + + + + + +StorableIndexSet (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class StorableIndexSet<S extends Storable>

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddAlternateKeys(StorableInfo<S> info) +
      Adds all of the alternate keys of the given storable as indexes by + calling addKey.
      +
      voidaddIndexes(StorableInfo<S> info) +
      Adds all the indexes of the given storable.
      +
      voidaddIndexes(StorableInfo<S> info, + Direction defaultDirection) +
      Adds all the indexes of the given storable.
      +
      voidaddKey(StorableKey<S> key) +
      Adds the key as a unique index, preserving the property arrangement.
      +
      voidaddPrimaryKey(StorableInfo<S> info) +
      Adds the primary key of the given storable as indexes by calling addKey.
      +
      StorableIndex<S>findKeyIndex(StorableKey<S> key) +
      Finds the best index to represent the given key.
      +
      StorableIndex<S>findPrimaryKeyIndex(StorableInfo<S> info) +
      Finds the best index to represent the primary key.
      +
      voidmarkClustered(boolean clustered) +
      Marks all indexes as clustered or non-clustered.
      +
      voidreduce() +
      Reduces the size of the set by removing redundant indexes, and merges + others together.
      +
      voidreduce(Direction defaultDirection) +
      Reduces the size of the set by removing redundant indexes, and merges + others together.
      +
      voidsetDefaultDirection(Direction defaultDirection) +
      Set the default direction for all index properties.
      +
      voiduniquify(StorableInfo<S> info) +
      Augment non-unique indexes with primary key properties, thus making them + unique.
      +
      voiduniquify(StorableKey<S> key) +
      Augment non-unique indexes with key properties, thus making them unique.
      +
      +
        +
      • + + +

        Methods inherited from class java.util.TreeSet

        +add, addAll, ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, subSet, subSet, tailSet, tailSet
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractSet

        +equals, hashCode, removeAll
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +containsAll, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Set

        +containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorableIndexSet

        +
        public StorableIndexSet()
        +
        • +
      + + + +
        +
      • +

        StorableIndexSet

        +
        public StorableIndexSet(StorableIndexSet<S> set)
        +
        Copy constructor.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addIndexes

        +
        public void addIndexes(StorableInfo<S> info)
        +
        Adds all the indexes of the given storable.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        addIndexes

        +
        public void addIndexes(StorableInfo<S> info,
+              Direction defaultDirection)
        +
        Adds all the indexes of the given storable.
        +
        Parameters:
        defaultDirection - default ordering direction to apply to each + index property
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any argument is null
        +
        • +
      + + + +
        +
      • +

        addAlternateKeys

        +
        public void addAlternateKeys(StorableInfo<S> info)
        +
        Adds all of the alternate keys of the given storable as indexes by + calling addKey.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        addPrimaryKey

        +
        public void addPrimaryKey(StorableInfo<S> info)
        +
        Adds the primary key of the given storable as indexes by calling addKey. This method should not be called if the primary key + cannot be altered because persistent data is already stored against + it. Instead, the primary key index should be added as a normal index. + +

        After adding the primary key via this method and after reducing the + set, call findPrimaryKeyIndex to get the + best index to represent the primary key.

        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        addKey

        +
        public void addKey(StorableKey<S> key)
        +
        Adds the key as a unique index, preserving the property arrangement.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if key is null
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public void reduce()
        +
        Reduces the size of the set by removing redundant indexes, and merges + others together.
        +
        • +
      + + + +
        +
      • +

        reduce

        +
        public void reduce(Direction defaultDirection)
        +
        Reduces the size of the set by removing redundant indexes, and merges + others together.
        +
        Parameters:
        defaultDirection - replace unspecified property directions with this
        +
        • +
      + + + +
        +
      • +

        setDefaultDirection

        +
        public void setDefaultDirection(Direction defaultDirection)
        +
        Set the default direction for all index properties.
        +
        Parameters:
        defaultDirection - replace unspecified property directions with this
        +
        • +
      + + + +
        +
      • +

        markClustered

        +
        public void markClustered(boolean clustered)
        +
        Marks all indexes as clustered or non-clustered.
        +
        Parameters:
        clustered - true to mark clustered; false to mark non-clustered
        Since:
        +
        1.2
        +
        See Also:
        StorableIndex.isClustered()
        +
        • +
      + + + +
        +
      • +

        uniquify

        +
        public void uniquify(StorableInfo<S> info)
        +
        Augment non-unique indexes with primary key properties, thus making them + unique.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        uniquify

        +
        public void uniquify(StorableKey<S> key)
        +
        Augment non-unique indexes with key properties, thus making them unique.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if key is null
        +
        • +
      + + + +
        +
      • +

        findPrimaryKeyIndex

        +
        public StorableIndex<S> findPrimaryKeyIndex(StorableInfo<S> info)
        +
        Finds the best index to represent the primary key. Should be called + after calling reduce. As long as the primary key was added via addPrimaryKey, this method should never return null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if info is null
        +
        • +
      + + + +
        +
      • +

        findKeyIndex

        +
        public StorableIndex<S> findKeyIndex(StorableKey<S> key)
        +
        Finds the best index to represent the given key. Should be called after + calling reduce. As long as the key was added via addKey, + this method should never return null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if key is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/StorageAccess.html b/apidocs/com/amazon/carbonado/qe/StorageAccess.html new file mode 100644 index 0000000..affde1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StorageAccess.html @@ -0,0 +1,305 @@ + + + + + + +StorageAccess (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Interface StorageAccess<S extends Storable>

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

      Method Detail

      + + + + + + + +
        +
      • +

        getQueryExecutorFactory

        +
        QueryExecutorFactory<S> getQueryExecutorFactory()
        +
        Returns a QueryExecutorFactory instance for storage.
        +
        • +
      + + + +
        +
      • +

        getAllIndexes

        +
        java.util.Collection<StorableIndex<S>> getAllIndexes()
        +
        Returns all the available indexes.
        +
        • +
      + + + +
        +
      • +

        storageDelegate

        +
        Storage<S> storageDelegate(StorableIndex<S> index)
        +
        If the given index is not directly supported by storage, queries should + be delegated. Return the storage to delegate to or null if index should + not be delegated.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if index is unknown
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html new file mode 100644 index 0000000..faf0d05 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html @@ -0,0 +1,271 @@ + + + + + + +UnionQueryAnalyzer.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class UnionQueryAnalyzer.Result

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    UnionQueryAnalyzer<S extends Storable>
    +
    +
    +
    +
    public class UnionQueryAnalyzer.Result
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      QueryExecutor<S>createExecutor() +
      Creates a QueryExecutor based on this result.
      +
      java.util.List<IndexedQueryAnalyzer.Result>getSubResults() +
      Returns results for each sub-query to be executed in the union.
      +
      OrderingList<S>getTotalOrdering() +
      Returns a total ordering, if one was imposed.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html new file mode 100644 index 0000000..e797763 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html @@ -0,0 +1,350 @@ + + + + + + +UnionQueryAnalyzer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class UnionQueryAnalyzer<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueryExecutorFactory<S>
    +
    +
    +
    +
    public class UnionQueryAnalyzer<S extends Storable>
+extends java.lang.Object
+implements QueryExecutorFactory<S>
    +
    Analyzes a query specification and determines how it can be executed as a + union of smaller queries. If necessary, the UnionQueryAnalyzer will alter + the query slightly, imposing a total ordering. Internally, an IndexedQueryAnalyzer is used for selecting the best indexes. + +

    UnionQueryAnalyzer is sharable and thread-safe. An instance for a + particular Storable type can be cached, avoiding repeated construction + cost. In addition, the analyzer caches learned foreign indexes.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html new file mode 100644 index 0000000..222a230 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html @@ -0,0 +1,434 @@ + + + + + + +UnionQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.qe
+

Class UnionQueryExecutor<S extends Storable>

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

      Constructor Detail

      + + + +
        +
      • +

        UnionQueryExecutor

        +
        public UnionQueryExecutor(QueryExecutor<S>... executors)
        +
        Parameters:
        executors - executors to wrap, each must have the exact same total ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any parameter is null or if ordering doesn't match
        +
        • +
      + + + +
        +
      • +

        UnionQueryExecutor

        +
        public UnionQueryExecutor(java.util.List<QueryExecutor<S>> executors)
        +
        Parameters:
        executors - executors to wrap, each must have the exact same total ordering
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any executors is null or if ordering doesn't match
        +
        • +
      + + + +
        +
      • +

        UnionQueryExecutor

        +
        public UnionQueryExecutor(java.util.List<QueryExecutor<S>> executors,
+                  OrderingList<S> totalOrdering)
        +
        Parameters:
        executors - executors to wrap, each must have the exact same total ordering
        totalOrdering - effective total ordering of executors
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if executors is null
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        getFilter

        +
        public Filter<S> getFilter()
        +
        Returns the combined filter of the wrapped executors.
        +
        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
        +
        • +
      + + + +
        +
      • +

        printNative

        +
        public boolean printNative(java.lang.Appendable app,
+                  int indentLevel,
+                  FilterValues<S> values)
+                    throws java.io.IOException
        +
        Prints native queries of the wrapped executors.
        +
        +
        Specified by:
        +
        printNative in interface QueryExecutor<S extends Storable>
        +
        Overrides:
        +
        printNative in class AbstractQueryExecutor<S extends Storable>
        +
        values - optional
        +
        Returns:
        false if not implemented
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        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
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html new file mode 100644 index 0000000..567b706 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html @@ -0,0 +1,167 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.AbstractQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.AbstractQuery

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html new file mode 100644 index 0000000..ac33f84 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html @@ -0,0 +1,205 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.AbstractQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.AbstractQueryExecutor

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html b/apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html new file mode 100644 index 0000000..e9e0f72 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html @@ -0,0 +1,206 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.BoundaryType (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.BoundaryType

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html b/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html new file mode 100644 index 0000000..02be73d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html @@ -0,0 +1,275 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.CompositeScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.CompositeScore

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html new file mode 100644 index 0000000..cc4d958 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.DelegatedQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.DelegatedQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html new file mode 100644 index 0000000..48f311a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.DelegatedQueryExecutorFactory

+
+
No usage of com.amazon.carbonado.qe.DelegatedQueryExecutorFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html new file mode 100644 index 0000000..63377f7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.EmptyQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.EmptyQuery

+
+
No usage of com.amazon.carbonado.qe.EmptyQuery
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html new file mode 100644 index 0000000..541d205 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.FilteredQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.FilteredQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.FilteredQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html b/apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html new file mode 100644 index 0000000..1ef2837 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html @@ -0,0 +1,246 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.FilteringScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.FilteringScore

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html new file mode 100644 index 0000000..68b5038 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html @@ -0,0 +1,173 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.FullScanQueryExecutor.Support

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html new file mode 100644 index 0000000..b7289bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.FullScanQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.FullScanQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.FullScanQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html new file mode 100644 index 0000000..ec724a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html @@ -0,0 +1,225 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html new file mode 100644 index 0000000..569b053 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.IndexedQueryAnalyzer

+
+
No usage of com.amazon.carbonado.qe.IndexedQueryAnalyzer
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html new file mode 100644 index 0000000..da34597 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html @@ -0,0 +1,175 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.IndexedQueryExecutor.Support

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html new file mode 100644 index 0000000..67102f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.IndexedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.IndexedQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.IndexedQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html new file mode 100644 index 0000000..be08715 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.IterableQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.IterableQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.IterableQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html new file mode 100644 index 0000000..d013501 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.JoinedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.JoinedQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.JoinedQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html new file mode 100644 index 0000000..4007aa1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html @@ -0,0 +1,175 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.KeyQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.KeyQueryExecutor.Support

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html new file mode 100644 index 0000000..4775511 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.KeyQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.KeyQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.KeyQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html b/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html new file mode 100644 index 0000000..87365a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html @@ -0,0 +1,577 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.OrderingList (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.OrderingList

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html b/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html new file mode 100644 index 0000000..6d59339 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html @@ -0,0 +1,226 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.OrderingScore (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.OrderingScore

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html new file mode 100644 index 0000000..0d3242b --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.QueryEngine (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.QueryEngine

+
+
No usage of com.amazon.carbonado.qe.QueryEngine
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html new file mode 100644 index 0000000..2a62831 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html @@ -0,0 +1,331 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.QueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.QueryExecutor

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html new file mode 100644 index 0000000..518abde --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.QueryExecutorCache (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.QueryExecutorCache

+
+
No usage of com.amazon.carbonado.qe.QueryExecutorCache
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html new file mode 100644 index 0000000..eb00e23 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html @@ -0,0 +1,213 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.QueryExecutorFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.QueryExecutorFactory

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html new file mode 100644 index 0000000..398b758 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html @@ -0,0 +1,202 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.QueryFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.QueryFactory

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html new file mode 100644 index 0000000..6e78e09 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html @@ -0,0 +1,208 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.QueryHint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.QueryHint

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html new file mode 100644 index 0000000..fce4f14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html @@ -0,0 +1,325 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.QueryHints (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.QueryHints

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html b/apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html new file mode 100644 index 0000000..b4d2d7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html @@ -0,0 +1,186 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.RepositoryAccess (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.RepositoryAccess

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html new file mode 100644 index 0000000..e98b2ea --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport

+
+
No usage of com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html new file mode 100644 index 0000000..b2fe180 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport

+
+
No usage of com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html new file mode 100644 index 0000000..5551e27 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html @@ -0,0 +1,193 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.SortedQueryExecutor.Support (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.SortedQueryExecutor.Support

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html new file mode 100644 index 0000000..b2bec2a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.SortedQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.SortedQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html new file mode 100644 index 0000000..2daf639 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.StandardQuery (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.StandardQuery

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html new file mode 100644 index 0000000..0c1b2d5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.StandardQueryFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.StandardQueryFactory

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html b/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html new file mode 100644 index 0000000..5de3c10 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.StorableIndexSet (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.StorableIndexSet

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html b/apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html new file mode 100644 index 0000000..a2df0e3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Interface com.amazon.carbonado.qe.StorageAccess (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.qe.StorageAccess

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html new file mode 100644 index 0000000..8c63925 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.UnionQueryAnalyzer.Result

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html new file mode 100644 index 0000000..3e54a03 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.UnionQueryAnalyzer

+
+
No usage of com.amazon.carbonado.qe.UnionQueryAnalyzer
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html new file mode 100644 index 0000000..0d3b9cc --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.qe.UnionQueryExecutor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.qe.UnionQueryExecutor

+
+
No usage of com.amazon.carbonado.qe.UnionQueryExecutor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/package-frame.html b/apidocs/com/amazon/carbonado/qe/package-frame.html new file mode 100644 index 0000000..e951eaa --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-frame.html @@ -0,0 +1,63 @@ + + + + + + +com.amazon.carbonado.qe (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.qe

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/qe/package-summary.html b/apidocs/com/amazon/carbonado/qe/package-summary.html new file mode 100644 index 0000000..94c9d2e --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-summary.html @@ -0,0 +1,398 @@ + + + + + + +com.amazon.carbonado.qe (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.qe

+
+
Support for implementing a Query Engine.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.qe Description

+
Support for implementing a Query Engine. Repositories are free to use this + package to aid in their implementation, but user-level applications have no + need to use this package.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/package-tree.html b/apidocs/com/amazon/carbonado/qe/package-tree.html new file mode 100644 index 0000000..a256965 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-tree.html @@ -0,0 +1,223 @@ + + + + + + +com.amazon.carbonado.qe Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.qe

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/qe/package-use.html b/apidocs/com/amazon/carbonado/qe/package-use.html new file mode 100644 index 0000000..d198fbe --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-use.html @@ -0,0 +1,265 @@ + + + + + + +Uses of Package com.amazon.carbonado.qe (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.qe

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

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

+ + -- cgit v1.2.3