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/Derived.html | 264 ++++++++++++++++++++++++++++++ 1 file changed, 264 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/Derived.html (limited to 'apidocs/com/amazon/carbonado/Derived.html') diff --git a/apidocs/com/amazon/carbonado/Derived.html b/apidocs/com/amazon/carbonado/Derived.html new file mode 100644 index 0000000..a27e556 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Derived.html @@ -0,0 +1,264 @@ + + + + + + +Derived (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Derived

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Derived
    +
    Identifies a Storable property which is not directly persisted, but + is instead derived from other property values. A derived property cannot be + abstract, and a "set" method is optional. + +

    Derived properties can be used just like a normal property in most + cases. They can be used in query filters, indexes, alternate keys, and they + can also be used to define a Version property. + +

    If the derived property depends on Join properties and is also + used in an index or alternate key, dependencies must be listed in order for + the index to be properly updated. + +

    Example:

    + @Indexes(@Index("uppercaseName"))
+ public abstract class UserInfo implements Storable<UserInfo> {
+     /**
+      * Derive an uppercase name for case-insensitive searches.
+      */
+     @Derived
+     public String getUppercaseName() {
+         String name = getName();
+         return name == null ? null : name.toUpperCase();
+     }
+
+     ...
+ }
+
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill, Tobias Holgers
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]from +
      List of properties that this property is derived from.
      +
      booleanshouldCopy +
      Returns whether this property should be included when copying a + storable.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        from

        +
        public abstract java.lang.String[] from
        +
        List of properties that this property is derived from.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        shouldCopy

        +
        public abstract boolean shouldCopy
        +
        Returns whether this property should be included when copying a + storable. Copying of a derived property uses the "get" and "set" methods + and requires the "set" method to be defined. Default false.
        +
        +
        Default:
        +
        false
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + -- cgit v1.2.3