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

Interface IndexInfo

+
+
+
+
    +
  • +
    +
    All Known Subinterfaces:
    +
    IndexEntryAccessor<S>
    +
    +
    +
    All Known Implementing Classes:
    +
    IndexInfoImpl
    +
    +
    +
    +
    public interface IndexInfo
    +
    General information about an index defined in a Storage. + +

    IndexInfo instances are thread-safe and immutable.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IndexInfoCapability
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetName() +
      Returns the name of this index, or null if not applicable.
      +
      Direction[]getPropertyDirections() +
      Returns the directions of all the properties in this index.
      +
      java.lang.String[]getPropertyNames() +
      Returns the properties in this index.
      +
      booleanisClustered() +
      Returns true if index is clustered, which means it defines the physical + ordering of storables.
      +
      booleanisUnique() +
      Returns true if index entries are unique.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Returns the name of this index, or null if not applicable.
        +
        • +
      + + + +
        +
      • +

        isUnique

        +
        boolean isUnique()
        +
        Returns true if index entries are unique.
        +
        • +
      + + + +
        +
      • +

        isClustered

        +
        boolean isClustered()
        +
        Returns true if index is clustered, which means it defines the physical + ordering of storables.
        +
        • +
      + + + +
        +
      • +

        getPropertyNames

        +
        java.lang.String[] getPropertyNames()
        +
        Returns the properties in this index. The array might be empty, but it + is never null. The array is a copy, and so it may be safely modified.
        +
        • +
      + + + +
        +
      • +

        getPropertyDirections

        +
        Direction[] getPropertyDirections()
        +
        Returns the directions of all the properties in this index. The length + of the array matches the length returned by getPropertyNames(). The array is a copy, and so it may be safely + modified.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3