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

Class IndexInfoImpl

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IndexInfo
    +
    +
    +
    +
    public class IndexInfoImpl
+extends java.lang.Object
+implements IndexInfo
    +
    Basic implementation of an IndexInfo.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      IndexInfoImpl(java.lang.String name, + boolean unique, + boolean clustered, + java.lang.String[] propertyNames, + Direction[] propertyDirections) 
      +
      • +
    + +
      +
    • + + +

      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.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IndexInfoImpl

        +
        public IndexInfoImpl(java.lang.String name,
+             boolean unique,
+             boolean clustered,
+             java.lang.String[] propertyNames,
+             Direction[] propertyDirections)
        +
        Parameters:
        name - optional name for index
        unique - true if index requires unique values
        propertyNames - required list of property names, must have at least + one name
        propertyDirections - optional property directions, may be null or + same length as property names array
        +
        Throws:
        +
        java.lang.IllegalArgumentException
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: IndexInfo
        +
        Returns the name of this index, or null if not applicable.
        +
        +
        Specified by:
        +
        getName in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        isUnique

        +
        public boolean isUnique()
        +
        Description copied from interface: IndexInfo
        +
        Returns true if index entries are unique.
        +
        +
        Specified by:
        +
        isUnique in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        isClustered

        +
        public boolean isClustered()
        +
        Description copied from interface: IndexInfo
        +
        Returns true if index is clustered, which means it defines the physical + ordering of storables.
        +
        +
        Specified by:
        +
        isClustered in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyNames

        +
        public java.lang.String[] getPropertyNames()
        +
        Description copied from interface: IndexInfo
        +
        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.
        +
        +
        Specified by:
        +
        getPropertyNames in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyDirections

        +
        public Direction[] getPropertyDirections()
        +
        Description copied from interface: IndexInfo
        +
        Returns the directions of all the properties in this index. The length + of the array matches the length returned by IndexInfo.getPropertyNames(). The array is a copy, and so it may be safely + modified.
        +
        +
        Specified by:
        +
        getPropertyDirections in interface IndexInfo
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3