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

Interface IndexEntryAccessor<S extends Storable>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    IndexInfo
    +
    +
    +
    +
    public interface IndexEntryAccessor<S extends Storable>
+extends IndexInfo
    +
    Provides low-level access to index data, which can be used for manual + inspection and repair.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IndexEntryAccessCapability
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidcopyFromMaster(Storable indexEntry, + S master) +
      Sets all the properties of the given index entry, using the applicable + properties of the given master.
      +
      voidcopyToMasterPrimaryKey(Storable indexEntry, + S master) +
      Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.
      +
      java.util.Comparator<? extends Storable>getComparator() +
      Returns a comparator for ordering index entries.
      +
      Storage<?>getIndexEntryStorage() +
      Returns the index entry storage.
      +
      booleanisConsistent(Storable indexEntry, + S master) +
      Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.
      +
      voidrepair(double desiredSpeed) +
      Repairs the index by inserting missing entries and fixing + inconsistencies.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexEntryStorage

        +
        Storage<?> getIndexEntryStorage()
        +
        Returns the index entry storage.
        +
        • +
      + + + + + +
        +
      • +

        copyToMasterPrimaryKey

        +
        void copyToMasterPrimaryKey(Storable indexEntry,
+                          S master)
+                            throws FetchException
        +
        Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.
        +
        Parameters:
        indexEntry - source of property values
        master - master whose primary key properties will be set
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        copyFromMaster

        +
        void copyFromMaster(Storable indexEntry,
+                  S master)
+                    throws FetchException
        +
        Sets all the properties of the given index entry, using the applicable + properties of the given master.
        +
        Parameters:
        indexEntry - index entry whose properties will be set
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        isConsistent

        +
        boolean isConsistent(Storable indexEntry,
+                   S master)
+                     throws FetchException
        +
        Returns true if the properties of the given index entry match those + contained in the master, exluding any version property. This will always + return true after a call to copyFromMaster.
        +
        Parameters:
        indexEntry - index entry whose properties will be tested
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        repair

        +
        void repair(double desiredSpeed)
+            throws RepositoryException
        +
        Repairs the index by inserting missing entries and fixing + inconsistencies.
        +
        Parameters:
        desiredSpeed - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        getComparator

        +
        java.util.Comparator<? extends Storable> getComparator()
        +
        Returns a comparator for ordering index entries.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3