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 --- .../amazon/carbonado/qe/IterableQueryExecutor.html | 386 +++++++++++++++++++++ 1 file changed, 386 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html (limited to 'apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html') 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) + + + + + + + +
+ + + + + +
+ + + +
+
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
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + -- cgit v1.2.3