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

Annotation Type PartitionKey

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface PartitionKey
    +
    Identifies a Storable property as being a member of the partition key. + This key is ignored if the underlying repository lacks support for partitioning. + +

    Example:

    + @PrimaryKey("userInfoID")
+ @PartitionKey("userInfoGroup")
+ public interface UserInfo extends Storable<UserInfo> {
+     long getUserInfoID();
+     void setUserInfoID(long id);
+
+     String getUserInfoGroup();
+     void setUserInfoGroup(String group);
+
+     ...
+ }
+
    +
    Author:
    +
    Archit Shivaprakash
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]value +
      A list of property names.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        A list of property names.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + -- cgit v1.2.3