Return-Path: X-Original-To: apmail-directory-commits-archive@www.apache.org Delivered-To: apmail-directory-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id EA3A510207 for ; Tue, 13 Aug 2013 15:43:22 +0000 (UTC) Received: (qmail 63351 invoked by uid 500); 13 Aug 2013 15:43:21 -0000 Delivered-To: apmail-directory-commits-archive@directory.apache.org Received: (qmail 63258 invoked by uid 500); 13 Aug 2013 15:43:19 -0000 Mailing-List: contact commits-help@directory.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@directory.apache.org Delivered-To: mailing list commits@directory.apache.org Received: (qmail 63144 invoked by uid 99); 13 Aug 2013 15:43:19 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 13 Aug 2013 15:43:19 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 13 Aug 2013 15:43:12 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 8662D2388B4E for ; Tue, 13 Aug 2013 15:42:27 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r874484 [6/45] - in /websites/production/directory/content/mavibot/gen-docs: ./ 1.0.0-M1/ 1.0.0-M1/apidocs/ 1.0.0-M1/apidocs/org/ 1.0.0-M1/apidocs/org/apache/ 1.0.0-M1/apidocs/org/apache/directory/ 1.0.0-M1/apidocs/org/apache/directory/mavi... Date: Tue, 13 Aug 2013 15:42:17 -0000 To: commits@directory.apache.org From: elecharny@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20130813154227.8662D2388B4E@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/BTreeTypeEnum.html ============================================================================== --- websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/BTreeTypeEnum.html (added) +++ websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/BTreeTypeEnum.html Tue Aug 13 15:42:13 2013 @@ -0,0 +1,353 @@ + + + + + + +BTreeTypeEnum (ApacheDS MVCC BTree implementation 1.0.0-M1 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.directory.mavibot.btree
+

Enum BTreeTypeEnum

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<BTreeTypeEnum>
    +
    +
    +
    +
    public enum BTreeTypeEnum
+extends Enum<BTreeTypeEnum>
    +
    An enum to describe the BTree type. We have three possible type : +
      +
    • IN_MEMORY : the BTree will remain in memory, and won't be persisted on disk
      • +
    • PERSISTENT : the BTree is in memory, but will be persisted on disk
      • +
    • MANAGED : the BTree is managed by a RecordManager, and some pages may + be swapped out from memory on demand
      • +
    +
    Author:
    +
    Mavibot labs Project
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        IN_MEMORY

        +
        public static final BTreeTypeEnum IN_MEMORY
        +
        Pure in-memory BTree, not persisted on disk
        +
        • +
      + + + +
        +
      • +

        PERSISTENT

        +
        public static final BTreeTypeEnum PERSISTENT
        +
        In-memory BTree but persisted on disk
        +
        • +
      + + + +
        +
      • +

        MANAGED

        +
        public static final BTreeTypeEnum MANAGED
        +
        A BTree associated with a RecordManager
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static BTreeTypeEnum[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (BTreeTypeEnum c : BTreeTypeEnum.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static BTreeTypeEnum valueOf(String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2012-2013 Apache Mavibot Project Parent. All Rights Reserved.

+ + Added: websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/Cursor.html ============================================================================== --- websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/Cursor.html (added) +++ websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/Cursor.html Tue Aug 13 15:42:13 2013 @@ -0,0 +1,467 @@ + + + + + + +Cursor (ApacheDS MVCC BTree implementation 1.0.0-M1 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.directory.mavibot.btree
+

Class Cursor<K,V>

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidafterLast() +
      Places the cursor at the end of the last position
      +
      voidbeforeFirst() +
      moves the cursor to the same position that was given at the time of instantiating the cursor.
      +
      voidclose() +
      Closes the cursor, thus releases the associated transaction
      +
      longgetCreationDate() 
      longgetRevision() 
      booleanhasNext() +
      Tells if the cursor can return a next element
      +
      booleanhasPrev() +
      Tells if the cursor can return a previous element
      +
      voidmoveToNextNonDuplicateKey() +
      Moves the cursor to the next non-duplicate key.
      +
      voidmoveToPrevNonDuplicateKey() +
      Moves the cursor to the previous non-duplicate key + If the BTree contains + + + <1,0> + <1,1> + <2,0> + <2,1> + + + and cursor is present at <2,1> then the cursor will move to <1,1>
      +
      Tuple<K,V>next() +
      Find the next key/value
      +
      Tuple<K,V>prev() +
      Find the previous key/value
      +
      + +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2012-2013 Apache Mavibot Project Parent. All Rights Reserved.

+ + Added: websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/Deletion.html ============================================================================== --- websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/Deletion.html (added) +++ websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/Deletion.html Tue Aug 13 15:42:13 2013 @@ -0,0 +1,272 @@ + + + + + + +Deletion (ApacheDS MVCC BTree implementation 1.0.0-M1 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.directory.mavibot.btree
+

Class Deletion<K,V>

+
+
+ +
+
    +
  • +
    Type Parameters:
    K - The key type
    V - The value type
    +
    +
    +
    public class Deletion<K,V>
+extends Modification<K,V>
    +
    A class used to store a Delete modification done on a BTree.
    +
    Author:
    +
    Mavibot labs Project
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + + + +
        +
      • +

        Deletion

        +
        public Deletion(K key)
        +
        Create a new Deletion instance.
        +
        Parameters:
        key - The key to be deleted
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2012-2013 Apache Mavibot Project Parent. All Rights Reserved.

+ + Added: websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/DuplicateKeyMemoryHolder.html ============================================================================== --- websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/DuplicateKeyMemoryHolder.html (added) +++ websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/DuplicateKeyMemoryHolder.html Tue Aug 13 15:42:13 2013 @@ -0,0 +1,301 @@ + + + + + + +DuplicateKeyMemoryHolder (ApacheDS MVCC BTree implementation 1.0.0-M1 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.directory.mavibot.btree
+

Class DuplicateKeyMemoryHolder<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.apache.directory.mavibot.btree.DuplicateKeyMemoryHolder<K,V>
      • +
    +
    • +
+
+
    +
  • +
    Type Parameters:
    K - The type of the BTree key
    V - The type of the BTree value
    +
    +
    All Implemented Interfaces:
    +
    ElementHolder<V,K,V>
    +
    +
    +
    +
    public class DuplicateKeyMemoryHolder<K,V>
+extends Object
+implements ElementHolder<V,K,V>
    +
    A holder for values of duplicate keys. The values are either present in memory + or loaded on the fly from disk when needed.
    +
    Author:
    +
    Mavibot labs Project
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + + + +
        +
      • +

        DuplicateKeyMemoryHolder

        +
        public DuplicateKeyMemoryHolder(BTree<K,V> btree,
+                        V value)
        +
        Create a new holder storing an offset and a SoftReference containing the value.
        +
        Parameters:
        offset - The offset in disk for this value
        value - The value to store into a SoftReference
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2012-2013 Apache Mavibot Project Parent. All Rights Reserved.

+ + Added: websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/ElementHolder.html ============================================================================== --- websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/ElementHolder.html (added) +++ websites/production/directory/content/mavibot/gen-docs/1.0.0-M1/apidocs/org/apache/directory/mavibot/btree/ElementHolder.html Tue Aug 13 15:42:13 2013 @@ -0,0 +1,228 @@ + + + + + + +ElementHolder (ApacheDS MVCC BTree implementation 1.0.0-M1 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.directory.mavibot.btree
+

Interface ElementHolder<E,K,V>

+
+
+
+
    +
  • +
    Type Parameters:
    E - The type for the stored element (either a value or a page)
    K - The type of the BTree key
    V - The type of the BTree value
    +
    +
    All Known Implementing Classes:
    +
    DuplicateKeyMemoryHolder, MemoryHolder, ReferenceHolder
    +
    +
    +
    +
    public interface ElementHolder<E,K,V>
    +
    A Value holder. As we may not store all the values in memory (except for an in-memory + BTree), we will use a SoftReference to keep a reference to a Value, and if it's null, + then we will load the Value from the underlying physical support, using the offset.
    +
    Author:
    +
    Mavibot labs Project
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      EgetValue(BTree<K,V> btree) +
      Get back the element
      +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2012-2013 Apache Mavibot Project Parent. All Rights Reserved.

+ +