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 --- .../raw/GenericStorableCodec.SearchKeyFactory.html | 313 +++++++++++++++++++++ 1 file changed, 313 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html (limited to 'apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html') diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html new file mode 100644 index 0000000..9201b11 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html @@ -0,0 +1,313 @@ + + + + + + +GenericStorableCodec.SearchKeyFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface GenericStorableCodec.SearchKeyFactory<S extends Storable>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    GenericStorableCodec<S extends Storable>
    +
    +
    +
    +
    public static interface GenericStorableCodec.SearchKeyFactory<S extends Storable>
    +
    Creates custom raw search keys for Storable types. It is + intended for supporting queries and indexes.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]encodeSearchKey(java.lang.Object[] values) +
      Build a search key by supplying property values without a storable.
      +
      byte[]encodeSearchKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd) +
      Build a search key by supplying property values without a storable.
      +
      byte[]encodeSearchKey(S storable) +
      Build a search key by extracting all the desired properties from the + given storable.
      +
      byte[]encodeSearchKey(S storable, + int rangeStart, + int rangeEnd) +
      Build a search key by extracting all the desired properties from the + given storable.
      +
      byte[]encodeSearchKeyPrefix() +
      Returns the search key for when there are no values.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(S storable)
        +
        Build a search key by extracting all the desired properties from the + given storable.
        +
        Parameters:
        storable - extract a subset of properties from this instance
        +
        Returns:
        raw search key
        +
        • +
      + + + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(S storable,
+                     int rangeStart,
+                     int rangeEnd)
        +
        Build a search key by extracting all the desired properties from the + given storable.
        +
        Parameters:
        storable - extract a subset of properties from this instance
        rangeStart - index of first property to use. Its value must be less + than the count of properties used by this factory.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of properties used by this factory.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(java.lang.Object[] values)
        +
        Build a search key by supplying property values without a storable.
        +
        Parameters:
        values - values to build into a key. It must be long enough to + accommodate all of properties used by this factory.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(java.lang.Object[] values,
+                     int rangeStart,
+                     int rangeEnd)
        +
        Build a search key by supplying property values without a storable.
        +
        Parameters:
        values - values to build into a key. The length may be less than + the amount of properties used by this factory. It must not be less than the + difference between rangeStart and rangeEnd.
        rangeStart - index of first property to use. Its value must be less + than the count of properties used by this factory.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of properties used by this factory.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodeSearchKeyPrefix

        +
        byte[] encodeSearchKeyPrefix()
        +
        Returns the search key for when there are no values. Returned value + may be null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3