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/cursor/AbstractCursor.html | 430 ++++++++++++++++ .../amazon/carbonado/cursor/ArraySortBuffer.html | 395 +++++++++++++++ .../amazon/carbonado/cursor/ControllerCursor.html | 317 ++++++++++++ .../amazon/carbonado/cursor/DifferenceCursor.html | 341 +++++++++++++ .../com/amazon/carbonado/cursor/EmptyCursor.html | 401 +++++++++++++++ .../amazon/carbonado/cursor/FetchAheadCursor.html | 331 +++++++++++++ .../amazon/carbonado/cursor/FilteredCursor.html | 436 ++++++++++++++++ .../com/amazon/carbonado/cursor/GroupedCursor.html | 488 ++++++++++++++++++ .../carbonado/cursor/IntersectionCursor.html | 341 +++++++++++++ .../amazon/carbonado/cursor/IteratorCursor.html | 348 +++++++++++++ .../com/amazon/carbonado/cursor/LimitCursor.html | 366 ++++++++++++++ .../amazon/carbonado/cursor/MergeSortBuffer.html | 546 +++++++++++++++++++++ .../carbonado/cursor/MultiTransformedCursor.html | 388 +++++++++++++++ .../amazon/carbonado/cursor/SingletonCursor.html | 475 ++++++++++++++++++ .../com/amazon/carbonado/cursor/SkipCursor.html | 366 ++++++++++++++ .../com/amazon/carbonado/cursor/SortBuffer.html | 274 +++++++++++ .../com/amazon/carbonado/cursor/SortedCursor.html | 476 ++++++++++++++++++ .../cursor/SymmetricDifferenceCursor.html | 364 ++++++++++++++ .../amazon/carbonado/cursor/ThrottledCursor.html | 362 ++++++++++++++ .../amazon/carbonado/cursor/TransformedCursor.html | 387 +++++++++++++++ .../com/amazon/carbonado/cursor/UnionCursor.html | 341 +++++++++++++ .../carbonado/cursor/class-use/AbstractCursor.html | 278 +++++++++++ .../cursor/class-use/ArraySortBuffer.html | 117 +++++ .../cursor/class-use/ControllerCursor.html | 117 +++++ .../cursor/class-use/DifferenceCursor.html | 117 +++++ .../carbonado/cursor/class-use/EmptyCursor.html | 117 +++++ .../cursor/class-use/FetchAheadCursor.html | 117 +++++ .../carbonado/cursor/class-use/FilteredCursor.html | 117 +++++ .../carbonado/cursor/class-use/GroupedCursor.html | 117 +++++ .../cursor/class-use/IntersectionCursor.html | 117 +++++ .../carbonado/cursor/class-use/IteratorCursor.html | 117 +++++ .../carbonado/cursor/class-use/LimitCursor.html | 117 +++++ .../cursor/class-use/MergeSortBuffer.html | 117 +++++ .../cursor/class-use/MultiTransformedCursor.html | 117 +++++ .../cursor/class-use/SingletonCursor.html | 117 +++++ .../carbonado/cursor/class-use/SkipCursor.html | 117 +++++ .../carbonado/cursor/class-use/SortBuffer.html | 244 +++++++++ .../carbonado/cursor/class-use/SortedCursor.html | 117 +++++ .../class-use/SymmetricDifferenceCursor.html | 117 +++++ .../cursor/class-use/ThrottledCursor.html | 117 +++++ .../cursor/class-use/TransformedCursor.html | 117 +++++ .../carbonado/cursor/class-use/UnionCursor.html | 117 +++++ .../com/amazon/carbonado/cursor/package-frame.html | 43 ++ .../amazon/carbonado/cursor/package-summary.html | 284 +++++++++++ .../com/amazon/carbonado/cursor/package-tree.html | 176 +++++++ .../com/amazon/carbonado/cursor/package-use.html | 207 ++++++++ 46 files changed, 11628 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/cursor/AbstractCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/ControllerCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/EmptyCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/FilteredCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/GroupedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/IntersectionCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/IteratorCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/LimitCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/MergeSortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/MultiTransformedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SingletonCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SkipCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SortedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/ThrottledCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/TransformedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/UnionCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/ArraySortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/ControllerCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/DifferenceCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/EmptyCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/FetchAheadCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/FilteredCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/GroupedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/IntersectionCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/IteratorCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/LimitCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/MergeSortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/MultiTransformedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SingletonCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SkipCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SortBuffer.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SortedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/SymmetricDifferenceCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/ThrottledCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/TransformedCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/class-use/UnionCursor.html create mode 100644 apidocs/com/amazon/carbonado/cursor/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/cursor/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/cursor/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/cursor/package-use.html (limited to 'apidocs/com/amazon/carbonado/cursor') diff --git a/apidocs/com/amazon/carbonado/cursor/AbstractCursor.html b/apidocs/com/amazon/carbonado/cursor/AbstractCursor.html new file mode 100644 index 0000000..401e185 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/AbstractCursor.html @@ -0,0 +1,430 @@ + + + + + + +AbstractCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class AbstractCursor<S>

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

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected AbstractCursor() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intcopyInto(java.util.Collection<? super S> c) +
      Copies all remaining next elements into the given collection.
      +
      intcopyInto(java.util.Collection<? super S> c, + int limit) +
      Copies a limited amount of remaining next elements into the given + collection.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      java.util.List<S>toList() +
      Copies all remaining next elements into a new modifiable list.
      +
      java.util.List<S>toList(int limit) +
      Copies a limited amount of remaining next elements into a new modifiable + list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AbstractCursor

        +
        protected AbstractCursor()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Copies all remaining next elements into the given collection. This + method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        Returns:
        actual amount of results added
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c,
+           int limit)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Copies a limited amount of remaining next elements into the given + collection. This method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (--limit >= 0 && cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        limit - maximum amount of elements to copy
        +
        Returns:
        actual amount of results added
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList()
+                         throws FetchException
        +
        Description copied from interface: Cursor
        +
        Copies all remaining next elements into a new modifiable list. This + method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list);
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Returns:
        a new modifiable list
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList(int limit)
+                         throws FetchException
        +
        Description copied from interface: Cursor
        +
        Copies a limited amount of remaining next elements into a new modifiable + list. This method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list, limit);
+
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Parameters:
        limit - maximum amount of elements to copy
        +
        Returns:
        a new modifiable list
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html b/apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html new file mode 100644 index 0000000..0b6613c --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html @@ -0,0 +1,395 @@ + + + + + + +ArraySortBuffer (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class ArraySortBuffer<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SortBuffer<S>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<S>, java.util.Collection<S>, java.util.List<S>, java.util.RandomAccess
    +
    +
    +
    +
    public class ArraySortBuffer<S>
+extends java.util.ArrayList<S>
+implements SortBuffer<S>
    +
    Sort buffer implementation backed by an ArrayList.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SortedCursor, +Serialized Form
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class java.util.AbstractList

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

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Clear and close buffer.
      +
      voidprepare(java.util.Comparator<S> comparator) +
      Clears buffer and assigns a comparator for sorting.
      +
      voidsort() +
      Finish sorting buffer.
      +
      +
        +
      • + + +

        Methods inherited from class java.util.ArrayList

        +add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize
        • +
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractList

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

        Methods inherited from class java.util.AbstractCollection

        +containsAll, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Collection

        +add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.List

        +containsAll, equals, hashCode
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ArraySortBuffer

        +
        public ArraySortBuffer()
        +
        • +
      + + + +
        +
      • +

        ArraySortBuffer

        +
        public ArraySortBuffer(int initialCapacity)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        prepare

        +
        public void prepare(java.util.Comparator<S> comparator)
        +
        Description copied from interface: SortBuffer
        +
        Clears buffer and assigns a comparator for sorting.
        +
        +
        Specified by:
        +
        prepare in interface SortBuffer<S>
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public void sort()
        +
        Description copied from interface: SortBuffer
        +
        Finish sorting buffer.
        +
        +
        Specified by:
        +
        sort in interface SortBuffer<S>
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: SortBuffer
        +
        Clear and close buffer.
        +
        +
        Specified by:
        +
        close in interface SortBuffer<S>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

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

Class ControllerCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class ControllerCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor and periodically calls a controller.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S> Cursor<S>apply(Cursor<S> source, + Query.Controller controller) +
      Returns a ControllerCursor depending on whether a controller instance is + passed in or not.
      +
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        apply

        +
        public static <S> Cursor<S> apply(Cursor<S> source,
+                  Query.Controller controller)
        +
        Returns a ControllerCursor depending on whether a controller instance is + passed in or not.
        +
        Parameters:
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if source is null
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        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/cursor/DifferenceCursor.html b/apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html new file mode 100644 index 0000000..9b2169e --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html @@ -0,0 +1,341 @@ + + + + + + +DifferenceCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class DifferenceCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class DifferenceCursor<S>
+extends AbstractCursor<S>
    +
    Wraps two Cursors and performs an asymmetric set difference + operation. + +

    Both cursors must return results in the same order. Ordering is preserved + by the difference.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    UnionCursor, +IntersectionCursor, +SymmetricDifferenceCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DifferenceCursor(Cursor<S> left, + Cursor<S> right, + java.util.Comparator<S> order) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DifferenceCursor

        +
        public DifferenceCursor(Cursor<S> left,
+                Cursor<S> right,
+                java.util.Comparator<S> order)
        +
        Parameters:
        left - cursor to wrap
        right - cursor to wrap whose results are completely discarded
        order - describes sort ordering of wrapped cursors, which must be + a total ordering
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class EmptyCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class EmptyCursor<S>
+extends java.lang.Object
+implements Cursor<S>
    +
    Special cursor implementation that is empty.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SingletonCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Does nothing.
      +
      intcopyInto(java.util.Collection<? super S> c) +
      Performs no copy and always returns 0.
      +
      intcopyInto(java.util.Collection<? super S> c, + int limit) +
      Performs no copy and always returns 0.
      +
      booleanhasNext() +
      Always returns false.
      +
      Snext() +
      Always throws NoSuchElementException.
      +
      intskipNext(int amount) +
      Always returns 0.
      +
      static <S> Cursor<S>the() +
      Returns the empty cursor instance.
      +
      java.util.List<S>toList() +
      Always returns an empty list.
      +
      java.util.List<S>toList(int limit) +
      Always returns an empty list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        the

        +
        public static <S> Cursor<S> the()
        +
        Returns the empty cursor instance.
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Does nothing.
        +
        +
        Specified by:
        +
        close in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        Always returns false.
        +
        +
        Specified by:
        +
        hasNext in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
        +
        Always throws NoSuchElementException.
        +
        +
        Specified by:
        +
        next in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
        +
        Always returns 0.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c)
        +
        Performs no copy and always returns 0.
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c,
+           int limit)
        +
        Performs no copy and always returns 0.
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        limit - maximum amount of elements to copy
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList()
        +
        Always returns an empty list.
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Returns:
        a new modifiable list
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList(int limit)
        +
        Always returns an empty list.
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Parameters:
        limit - maximum amount of elements to copy
        +
        Returns:
        a new modifiable list
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • 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/cursor/FetchAheadCursor.html b/apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html new file mode 100644 index 0000000..79de3f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html @@ -0,0 +1,331 @@ + + + + + + +FetchAheadCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class FetchAheadCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class FetchAheadCursor<S>
+extends AbstractCursor<S>
    +
    Cursor implementation which fetches records in advance, in order to release locks.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FetchAheadCursor(Cursor<S> source, + int fetchAhead) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FetchAheadCursor

        +
        public FetchAheadCursor(Cursor<S> source,
+                int fetchAhead)
        +
        Parameters:
        fetchAhead - how much to fetch ahead from source
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class FilteredCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public abstract class FilteredCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor and applies custom filtering to reduce the set of + results.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected FilteredCursor(Cursor<S> cursor) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      Cursor<S>      		applyFilter(Cursor<S> cursor, + java.lang.Class<S> type, + java.lang.String filter, + java.lang.Object... filterValues) +
      Returns a Cursor that is filtered by the given filter expression and values.
      +
      static <S extends Storable> 
      Cursor<S>      		applyFilter(Filter<S> filter, + FilterValues<S> filterValues, + Cursor<S> cursor) +
      Returns a Cursor that is filtered by the given Filter and FilterValues.
      +
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      protected abstract booleanisAllowed(S storable) 
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FilteredCursor

        +
        protected FilteredCursor(Cursor<S> cursor)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        applyFilter

        +
        public static <S extends Storable> Cursor<S> applyFilter(Cursor<S> cursor,
+                                         java.lang.Class<S> type,
+                                         java.lang.String filter,
+                                         java.lang.Object... filterValues)
        +
        Returns a Cursor that is filtered by the given filter expression and values.
        +
        Parameters:
        cursor - cursor to wrap
        type - type of storable
        filter - filter to apply
        filterValues - values for filter
        +
        Returns:
        wrapped cursor which filters results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any values are not specified
        +
        java.lang.IllegalArgumentException - if any argument is null
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        applyFilter

        +
        public static <S extends Storable> Cursor<S> applyFilter(Filter<S> filter,
+                                         FilterValues<S> filterValues,
+                                         Cursor<S> cursor)
        +
        Returns a Cursor that is filtered by the given Filter and FilterValues. + The given Filter must be composed only of the same PropertyFilter + instances as used to construct the FilterValues. An + IllegalStateException will result otherwise.
        +
        Parameters:
        filter - filter to apply
        filterValues - values for filter, which may be null if filter has no parameters
        cursor - cursor to wrap
        +
        Returns:
        wrapped cursor which filters results
        +
        Throws:
        +
        java.lang.IllegalStateException - if any values are not specified
        +
        java.lang.IllegalArgumentException - if filter is closed
        +
        • +
      + + + + + +
        +
      • +

        isAllowed

        +
        protected abstract boolean isAllowed(S storable)
+                              throws FetchException
        +
        Returns:
        false if object should not be in results
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class GroupedCursor<S,G>

+
+
+ +
+
    +
  • +
    Type Parameters:
    S - source type, can be anything
    G - aggregate type, can be anything
    +
    +
    All Implemented Interfaces:
    +
    Cursor<G>
    +
    +
    +
    +
    public abstract class GroupedCursor<S,G>
+extends AbstractCursor<G>
    +
    Abstract cursor for aggregation and finding distinct data. The source cursor + must be ordered in some fashion by the grouping properties. The arrangement of + properties must match, but it does not matter if they are ascending or + descending.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SortedCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected GroupedCursor(Cursor<S> cursor, + java.lang.Class<S> type, + java.lang.String... groupProperties) +
      Create a GroupedCursor using properties to define the group + comparator.
      +
      protected GroupedCursor(Cursor<S> cursor, + java.util.Comparator<S> groupComparator) +
      Create a GroupedCursor with an existing group comparator.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected abstract voidaddToGroup(S groupMember) +
      This method is called when more entries are found for the current + group.
      +
      protected abstract voidbeginGroup(S groupLeader) +
      This method is called for the first entry in a group.
      +
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      java.util.Comparator<S>comparator() +
      Returns the comparator used to identify group boundaries.
      +
      protected abstract GfinishGroup() +
      This method is called when a group is finished, and it can return an + aggregate.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Gnext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GroupedCursor

        +
        protected GroupedCursor(Cursor<S> cursor,
+             java.util.Comparator<S> groupComparator)
        +
        Create a GroupedCursor with an existing group comparator. The comparator + defines the ordering of the source cursor, and it should be a partial + odering. If group comparator defines a total ordering, then all groups + have one member.
        +
        Parameters:
        cursor - source of elements which must be ordered properly
        groupComparator - comparator which defines ordering of source cursor
        +
        • +
      + + + +
        +
      • +

        GroupedCursor

        +
        protected GroupedCursor(Cursor<S> cursor,
+             java.lang.Class<S> type,
+             java.lang.String... groupProperties)
        +
        Create a GroupedCursor using properties to define the group + comparator. The set of properties defines the ordering of the source + cursor, and it should be a partial ordering. If properties define a + total ordering, then all groups have one member.
        +
        Parameters:
        cursor - source of elements which must be ordered properly
        type - type of storable to create cursor for
        groupProperties - list of properties to group by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any property is null or not a member + of storable type
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        comparator

        +
        public java.util.Comparator<S> comparator()
        +
        Returns the comparator used to identify group boundaries.
        +
        • +
      + + + + + +
        +
      • +

        beginGroup

        +
        protected abstract void beginGroup(S groupLeader)
+                            throws FetchException
        +
        This method is called for the first entry in a group. This method is not + called again until after finishGroup is called.
        +
        Parameters:
        groupLeader - first entry in group
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        addToGroup

        +
        protected abstract void addToGroup(S groupMember)
+                            throws FetchException
        +
        This method is called when more entries are found for the current + group. This method is not called until after beginGroup has been + called. It may called multiple times until finishGroup is called.
        +
        Parameters:
        groupMember - additional entry in group
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        finishGroup

        +
        protected abstract G finishGroup()
+                          throws FetchException
        +
        This method is called when a group is finished, and it can return an + aggregate. Simply return null if aggregate should be filtered out.
        +
        Returns:
        aggregate, or null to filter it out
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public G next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<G>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<G>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class IntersectionCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class IntersectionCursor<S>
+extends AbstractCursor<S>
    +
    Wraps two Cursors and performs a set intersection operation. In + boolean logic, this is an and operation. + +

    Both cursors must return results in the same order. Ordering is preserved + by the intersection.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    UnionCursor, +DifferenceCursor, +SymmetricDifferenceCursor
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        IntersectionCursor

        +
        public IntersectionCursor(Cursor<S> left,
+                  Cursor<S> right,
+                  java.util.Comparator<S> order)
        +
        Parameters:
        left - cursor to wrap
        right - cursor to wrap
        order - describes sort ordering of wrapped cursors, which must be + a total ordering
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class IteratorCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class IteratorCursor<S>
+extends AbstractCursor<S>
    +
    Adapts an Iterator into a Cursor.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      IteratorCursor(java.lang.Iterable<S> iterable) 
      IteratorCursor(java.lang.Iterable<S> iterable, + java.util.concurrent.locks.Lock lock) 
      IteratorCursor(java.util.Iterator<S> iterator) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        IteratorCursor

        +
        public IteratorCursor(java.lang.Iterable<S> iterable)
        +
        Parameters:
        iterable - collection to iterate over, or null for empty cursor
        +
        • +
      + + + +
        +
      • +

        IteratorCursor

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

        IteratorCursor

        +
        public IteratorCursor(java.util.Iterator<S> iterator)
        +
        Parameters:
        iterator - iterator to wrap, or null for empty cursor
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class LimitCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class LimitCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor to limit the amount of elements.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SkipCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LimitCursor(Cursor<S> source, + long limit) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        LimitCursor

        +
        public LimitCursor(Cursor<S> source,
+           long limit)
        +
        Parameters:
        limit - maximum amount of elements
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if source is null or limit is negative
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class MergeSortBuffer<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SortBuffer<S>, java.lang.Iterable<S>, java.util.Collection<S>
    +
    +
    +
    +
    public class MergeSortBuffer<S extends Storable>
+extends java.util.AbstractCollection<S>
+implements SortBuffer<S>
    +
    Sort buffer implemented via a merge sort algorithm. If there are too many + storables to fit in the reserved memory buffer, they are sorted and + serialized to temporary files. + +

    The following system properties can be set to change the default + performance characteristics of the merge sort. Each property name must be + prefixed with "com.amazon.carbonado.cursor.MergeSortBuffer." + + 

    + Property            Default    Notes
+ ------------------- ---------- ----------------------------------------------
+ maxArrayCapacity    8192       Larger value greatly improves performance, but
+                                more memory is used for each running sort.
+
+ maxOpenFileCount    100        Larger value may reduce the amount of file
+                                merges, but there is an increased risk of
+                                running out of file descriptors.
+
+ outputBufferSize    10000      Larger value may improve performance of file
+                                writing, but not by much.
+
+ tmpdir                         Merge sort files by default are placed in the
+                                Java temp directory. Override to place them
+                                somewhere else.
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SortedCursor
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanadd(S storable) 
      voidclear() 
      voidclose() +
      Clear and close buffer.
      +
      java.util.Iterator<S>iterator() 
      voidprepare(java.util.Comparator<S> comparator) +
      Clears buffer and assigns a comparator for sorting.
      +
      intsize() 
      voidsort() +
      Finish sorting buffer.
      +
      +
        +
      • + + +

        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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Collection

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

      Constructor Detail

      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer()
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Query.Controller controller)
        +
        Parameters:
        controller - optional controller which can abort query operation
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage,
+               Query.Controller controller)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        controller - optional controller which can abort query operation
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage,
+               java.lang.String tempDir)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        tempDir - directory to store temp files for merging, or null for default
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage,
+               java.lang.String tempDir,
+               int maxArrayCapacity)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        tempDir - directory to store temp files for merging, or null for default
        maxArrayCapacity - maximum amount of storables to keep in an array + before serializing to a file
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if storage is null
        +
        • +
      + + + +
        +
      • +

        MergeSortBuffer

        +
        public MergeSortBuffer(Storage<S> storage,
+               java.lang.String tempDir,
+               int maxArrayCapacity,
+               Query.Controller controller)
        +
        Parameters:
        storage - storage for elements; if null use first Storable to + prepare reloaded Storables
        tempDir - directory to store temp files for merging, or null for default
        maxArrayCapacity - maximum amount of storables to keep in an array + before serializing to a file
        controller - optional controller which can abort query operation
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if storage is null
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        prepare

        +
        public void prepare(java.util.Comparator<S> comparator)
        +
        Description copied from interface: SortBuffer
        +
        Clears buffer and assigns a comparator for sorting.
        +
        +
        Specified by:
        +
        prepare in interface SortBuffer<S extends Storable>
        +
        +
        • +
      + + + + + +
        +
      • +

        add

        +
        public boolean add(S storable)
        +
        +
        Specified by:
        +
        add in interface java.util.Collection<S extends Storable>
        +
        Overrides:
        +
        add in class java.util.AbstractCollection<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Collection<S extends Storable>
        +
        Specified by:
        +
        size in class java.util.AbstractCollection<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<S> iterator()
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<S extends Storable>
        +
        Specified by:
        +
        iterator in interface java.util.Collection<S extends Storable>
        +
        Specified by:
        +
        iterator in class java.util.AbstractCollection<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Collection<S extends Storable>
        +
        Overrides:
        +
        clear in class java.util.AbstractCollection<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        public void sort()
        +
        Description copied from interface: SortBuffer
        +
        Finish sorting buffer.
        +
        +
        Specified by:
        +
        sort in interface SortBuffer<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: SortBuffer
        +
        Clear and close buffer.
        +
        +
        Specified by:
        +
        close in interface SortBuffer<S extends Storable>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class MultiTransformedCursor<S,T>

+
+
+ +
+
    +
  • +
    Type Parameters:
    S - source type, can be anything
    T - target type, can be anything
    +
    +
    All Implemented Interfaces:
    +
    Cursor<T>
    +
    +
    +
    +
    public abstract class MultiTransformedCursor<S,T>
+extends AbstractCursor<T>
    +
    Abstract cursor which wraps another cursor and transforms each storable + result into a set of target storables. This class can be used for + implementing one-to-many joins. Use TransformedCursor for one-to-one + joins.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Tnext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      protected abstract Cursor<T>transform(S storable) +
      This method must be implemented to transform storables.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MultiTransformedCursor

        +
        protected MultiTransformedCursor(Cursor<S> cursor)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        transform

        +
        protected abstract Cursor<T> transform(S storable)
+                                throws FetchException
        +
        This method must be implemented to transform storables. If the storable + cannot be transformed, either throw a FetchException or return null. If + null is returned, the storable is simply filtered out.
        +
        Returns:
        transformed storables, or null to filter it out
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public T next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<T>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<T>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class SingletonCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class SingletonCursor<S>
+extends java.lang.Object
+implements Cursor<S>
    +
    Special cursor implementation that returns only one element.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    EmptyCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SingletonCursor(S object) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      intcopyInto(java.util.Collection<? super S> c) +
      Copies all remaining next elements into the given collection.
      +
      intcopyInto(java.util.Collection<? super S> c, + int limit) +
      Copies a limited amount of remaining next elements into the given + collection.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      java.util.List<S>toList() +
      Copies all remaining next elements into a new modifiable list.
      +
      java.util.List<S>toList(int limit) +
      Copies a limited amount of remaining next elements into a new modifiable + list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + + + +
        +
      • +

        SingletonCursor

        +
        public SingletonCursor(S object)
        +
        Parameters:
        object - single object to return from cursor, must not be null
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if object is null
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        +
        Specified by:
        +
        close in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        +
        Specified by:
        +
        hasNext in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        +
        Specified by:
        +
        next in interface Cursor<S>
        +
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c)
        +
        Description copied from interface: Cursor
        +
        Copies all remaining next elements into the given collection. This + method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        copyInto

        +
        public int copyInto(java.util.Collection<? super S> c,
+           int limit)
        +
        Description copied from interface: Cursor
        +
        Copies a limited amount of remaining next elements into the given + collection. This method is roughly equivalent to the following: + 
        + Cursor cursor;
+ ...
+ while (--limit >= 0 && cursor.hasNext()) {
+     c.add(cursor.next());
+ }
+
        +
        +
        Specified by:
        +
        copyInto in interface Cursor<S>
        +
        limit - maximum amount of elements to copy
        +
        Returns:
        actual amount of results added
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList()
        +
        Description copied from interface: Cursor
        +
        Copies all remaining next elements into a new modifiable list. This + method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list);
+
        + +

        As a side-effect of calling this method, the cursor is closed.

        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Returns:
        a new modifiable list
        +
        • +
      + + + +
        +
      • +

        toList

        +
        public java.util.List<S> toList(int limit)
        +
        Description copied from interface: Cursor
        +
        Copies a limited amount of remaining next elements into a new modifiable + list. This method is roughly equivalent to the following: + 
        + Cursor<S> cursor;
+ ...
+ List<S> list = new ...
+ cursor.copyInto(list, limit);
+
        +
        +
        Specified by:
        +
        toList in interface Cursor<S>
        +
        Parameters:
        limit - maximum amount of elements to copy
        +
        Returns:
        a new modifiable list
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class SkipCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class SkipCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor to skip an initial amount of elements.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    LimitCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SkipCursor(Cursor<S> source, + long skip) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SkipCursor

        +
        public SkipCursor(Cursor<S> source,
+          long skip)
        +
        Parameters:
        skip - initial amount of elements to skip
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if source is null or skip is negative
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Interface SortBuffer<S>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.util.Collection<S>, java.lang.Iterable<S>
    +
    +
    +
    All Known Implementing Classes:
    +
    ArraySortBuffer, MergeSortBuffer
    +
    +
    +
    +
    public interface SortBuffer<S>
+extends java.util.Collection<S>
    +
    Buffers up Storable instances allowing them to be sorted. Should any method + need to throw an undeclared exception, wrap it with an + UndeclaredThrowableException.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SortedCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Clear and close buffer.
      +
      voidprepare(java.util.Comparator<S> comparator) +
      Clears buffer and assigns a comparator for sorting.
      +
      voidsort() +
      Finish sorting buffer.
      +
      +
        +
      • + + +

        Methods inherited from interface java.util.Collection

        +add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        prepare

        +
        void prepare(java.util.Comparator<S> comparator)
        +
        Clears buffer and assigns a comparator for sorting.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if comparator is null
        +
        • +
      + + + +
        +
      • +

        sort

        +
        void sort()
+          throws FetchException
        +
        Finish sorting buffer.
        +
        Throws:
        +
        java.lang.IllegalStateException - if prepare was never called
        +
        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/cursor/SortedCursor.html b/apidocs/com/amazon/carbonado/cursor/SortedCursor.html new file mode 100644 index 0000000..56ddfc2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SortedCursor.html @@ -0,0 +1,476 @@ + + + + + + +SortedCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.cursor
+

Class SortedCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class SortedCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another Cursor and ensures the results are sorted. If the elements in + the source cursor are already partially sorted, a handled comparator can be + passed in which specifies the partial ordering. Elements are then processed + in smaller chunks rather than sorting the entire set. The handled comparator + can represent ascending or descending order of source elements.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      SortedCursor(Cursor<S> cursor, + SortBuffer<S> buffer, + java.lang.Class<S> type, + java.lang.String... orderProperties) 
      SortedCursor(Cursor<S> cursor, + SortBuffer<S> buffer, + java.util.Comparator<S> handled, + java.util.Comparator<S> finisher) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      java.util.Comparator<S>comparator() +
      Returns a comparator representing the effective sort order of this cursor.
      +
      static <S> java.util.Comparator<S>createComparator(java.lang.Class<S> type, + java.lang.String... orderProperties) +
      Convenience method to create a comparator which orders storables by the + given order-by properties.
      +
      static <S extends Storable> 
      java.util.Comparator<S>      		createComparator(java.util.List<OrderedProperty<S>> properties) +
      Convenience method to create a comparator which orders storables by the + given properties.
      +
      static <S extends Storable> 
      java.util.Comparator<S>      		createComparator(OrderedProperty<S>... properties) +
      Convenience method to create a comparator which orders storables by the + given properties.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SortedCursor

        +
        public SortedCursor(Cursor<S> cursor,
+            SortBuffer<S> buffer,
+            java.util.Comparator<S> handled,
+            java.util.Comparator<S> finisher)
        +
        Parameters:
        cursor - cursor to wrap
        buffer - required buffer to hold results
        handled - optional comparator which represents how the results are + already sorted
        finisher - required comparator which finishes the sort
        +
        • +
      + + + +
        +
      • +

        SortedCursor

        +
        public SortedCursor(Cursor<S> cursor,
+            SortBuffer<S> buffer,
+            java.lang.Class<S> type,
+            java.lang.String... orderProperties)
        +
        Parameters:
        cursor - cursor to wrap
        buffer - required buffer to hold results
        type - type of storable to create cursor for
        orderProperties - list of properties to order by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any property is null or not a member + of storable type
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createComparator

        +
        public static <S> java.util.Comparator<S> createComparator(java.lang.Class<S> type,
+                                           java.lang.String... orderProperties)
        +
        Convenience method to create a comparator which orders storables by the + given order-by properties. The property names may be prefixed with '+' + or '-' to indicate ascending or descending order. If the prefix is + omitted, ascending order is assumed.
        +
        Parameters:
        type - type of storable to create comparator for
        orderProperties - list of properties to order by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any property is null or not a member + of storable type
        +
        • +
      + + + +
        +
      • +

        createComparator

        +
        public static <S extends Storable> java.util.Comparator<S> createComparator(OrderedProperty<S>... properties)
        +
        Convenience method to create a comparator which orders storables by the + given properties.
        +
        Parameters:
        properties - list of properties to order by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if no properties or if any property is null
        +
        • +
      + + + +
        +
      • +

        createComparator

        +
        public static <S extends Storable> java.util.Comparator<S> createComparator(java.util.List<OrderedProperty<S>> properties)
        +
        Convenience method to create a comparator which orders storables by the + given properties.
        +
        Parameters:
        properties - list of properties to order by
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if no properties or if any property is null
        +
        • +
      + + + +
        +
      • +

        comparator

        +
        public java.util.Comparator<S> comparator()
        +
        Returns a comparator representing the effective sort order of this cursor.
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class SymmetricDifferenceCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class SymmetricDifferenceCursor<S>
+extends AbstractCursor<S>
    +
    Wraps two Cursors and performs a symmetric set difference + operation. In boolean logic, this is an exclusive or operation. + +

    Both cursors must return results in the same order. Ordering is preserved + by the difference.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    UnionCursor, +IntersectionCursor, +DifferenceCursor
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      intcompareNext() +
      Returns 0 if no next element available, <0 if next element is + from left source cursor, and >0 if next element is from right + source cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SymmetricDifferenceCursor

        +
        public SymmetricDifferenceCursor(Cursor<S> left,
+                         Cursor<S> right,
+                         java.util.Comparator<S> order)
        +
        Parameters:
        left - cursor to wrap
        right - cursor to wrap
        order - describes sort ordering of wrapped cursors, which must be + a total ordering
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        compareNext

        +
        public int compareNext()
+                throws FetchException
        +
        Returns 0 if no next element available, <0 if next element is + from left source cursor, and >0 if next element is from right + source cursor.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class ThrottledCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class ThrottledCursor<S>
+extends AbstractCursor<S>
    +
    Wraps another cursor and fetches results at a reduced speed.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ThrottledCursor(Cursor<S> cursor, + double throttle) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ThrottledCursor

        +
        public ThrottledCursor(Cursor<S> cursor,
+               double throttle)
        +
        Parameters:
        cursor - cursor to wrap
        throttle - 1.0 = fetch at full speed, 0.5 = fetch at half speed, + 0.1 = fetch at one tenth speed, etc.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class TransformedCursor<S,T>

+
+
+ +
+
    +
  • +
    Type Parameters:
    S - source type, can be anything
    T - target type, can be anything
    +
    +
    All Implemented Interfaces:
    +
    Cursor<T>
    +
    +
    +
    +
    public abstract class TransformedCursor<S,T>
+extends AbstractCursor<T>
    +
    Abstract cursor which wraps another cursor and transforms each storable + result into a target storable. This class can be used for implementing + one-to-one joins. Use MultiTransformedCursor for one-to-many joins.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected TransformedCursor(Cursor<S> cursor) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Tnext() +
      Returns the next element from this cursor.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      protected abstract Ttransform(S storable) +
      This method must be implemented to transform storables.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        TransformedCursor

        +
        protected TransformedCursor(Cursor<S> cursor)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        transform

        +
        protected abstract T transform(S storable)
+                        throws FetchException
        +
        This method must be implemented to transform storables. If the storable + cannot be transformed, either throw a FetchException or return null. If + null is returned, the storable is simply filtered out.
        +
        Returns:
        transformed storable, or null to filter it out
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public T next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<T>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<T>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

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

Class UnionCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public class UnionCursor<S>
+extends AbstractCursor<S>
    +
    Wraps two Cursors and performs a set union operation. In boolean + logic, this is an or operation. + +

    Both cursors must return results in the same order. Ordering is preserved + by the union.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IntersectionCursor, +DifferenceCursor, +SymmetricDifferenceCursor
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      UnionCursor(Cursor<S> left, + Cursor<S> right, + java.util.Comparator<S> order) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        UnionCursor

        +
        public UnionCursor(Cursor<S> left,
+           Cursor<S> right,
+           java.util.Comparator<S> order)
        +
        Parameters:
        left - cursor to wrap
        right - cursor to wrap
        order - describes sort ordering of wrapped cursors, which must be + a total ordering
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html new file mode 100644 index 0000000..060c4ed --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html @@ -0,0 +1,278 @@ + + + + + + +Uses of Class com.amazon.carbonado.cursor.AbstractCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.cursor.AbstractCursor

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

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

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

Uses of Class
com.amazon.carbonado.cursor.ArraySortBuffer

+
+
No usage of com.amazon.carbonado.cursor.ArraySortBuffer
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.ControllerCursor

+
+
No usage of com.amazon.carbonado.cursor.ControllerCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.DifferenceCursor

+
+
No usage of com.amazon.carbonado.cursor.DifferenceCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.EmptyCursor

+
+
No usage of com.amazon.carbonado.cursor.EmptyCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.FetchAheadCursor

+
+
No usage of com.amazon.carbonado.cursor.FetchAheadCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.FilteredCursor

+
+
No usage of com.amazon.carbonado.cursor.FilteredCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.GroupedCursor

+
+
No usage of com.amazon.carbonado.cursor.GroupedCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.IntersectionCursor

+
+
No usage of com.amazon.carbonado.cursor.IntersectionCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.IteratorCursor

+
+
No usage of com.amazon.carbonado.cursor.IteratorCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.LimitCursor

+
+
No usage of com.amazon.carbonado.cursor.LimitCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.MergeSortBuffer

+
+
No usage of com.amazon.carbonado.cursor.MergeSortBuffer
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.MultiTransformedCursor

+
+
No usage of com.amazon.carbonado.cursor.MultiTransformedCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.SingletonCursor

+
+
No usage of com.amazon.carbonado.cursor.SingletonCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.SkipCursor

+
+
No usage of com.amazon.carbonado.cursor.SkipCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Interface
com.amazon.carbonado.cursor.SortBuffer

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

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

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

Uses of Class
com.amazon.carbonado.cursor.SortedCursor

+
+
No usage of com.amazon.carbonado.cursor.SortedCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.SymmetricDifferenceCursor

+
+
No usage of com.amazon.carbonado.cursor.SymmetricDifferenceCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.ThrottledCursor

+
+
No usage of com.amazon.carbonado.cursor.ThrottledCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.TransformedCursor

+
+
No usage of com.amazon.carbonado.cursor.TransformedCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.cursor.UnionCursor

+
+
No usage of com.amazon.carbonado.cursor.UnionCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

com.amazon.carbonado.cursor

+
+

Interfaces

+ +

Classes

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

Package com.amazon.carbonado.cursor

+
+
Support for advanced processing of cursor results, including basic set + theory operations.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.cursor Description

+
Support for advanced processing of cursor results, including basic set + theory operations.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Hierarchy For Package com.amazon.carbonado.cursor

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

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

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

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

Uses of Package
com.amazon.carbonado.cursor

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

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

+ + -- cgit v1.2.3