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

Annotation Type Alias

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value={TYPE,METHOD})
+public @interface Alias
    +
    Identifies alternate names for a Storable or a Storable property. An alias is used + only by a repository to link to entities. Without an alias, the repository will perform + a best guess at finding an entity to use. Aliases may be ignored by repositories that + don't require explicitly named entities. +

    The most common use for an alias is for a JDBC repository, to link a storable to a table and + its properties to the corresponding columns. Naming conventions for databases rarely work + well for class and variable names. + +

    Example:

    + @Alias("USER_INFO")
+ @PrimaryKey("userInfoID")
+ public interface UserInfo extends Storable<UserInfo> {
+     @Alias("USER_ID")
+     long getUserInfoID();
+     void setUserInfoID(long id);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Name
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      java.lang.String[]value +
      Alias values for the storage layer to select from.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract java.lang.String[] value
        +
        Alias values for the storage layer to select from. It will choose the + first one in the list that matches one of its own entities.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + -- cgit v1.2.3