View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.directory.mavibot.btree;
21  
22  
23  
24  /**
25   * This class is used to store the parent page and the position in it during
26   * a browse operation. We have as many ParentPos instance than the depth of the tree.
27   * 
28   * @param <K> The type for the Key
29   * @param <V> The type for the stored value
30   * 
31   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32   */
33  public class ParentPos<K, V>
34  {
35      /** The page we are browsing */
36      public Page<K, V> page;
37  
38      /** The current position in the page */
39      public int pos;
40  
41      /** The current position of the duplicate container in the page */
42      public int dupPos;
43  
44      /** The current position of the duplicate container in the page */
45      public ValueCursor<V> valueCursor;
46  
47  
48      /**
49       * Creates a new instance of ParentPos
50       * @param page The current Page
51       * @param pos The current position in the page
52       */
53      public ParentPos( Page<K, V> page, int pos )
54      {
55          this.page = page;
56          this.pos = pos;
57      }
58  
59  
60      /**
61       * @see Object#toString()
62       */
63      public String toString()
64      {
65          return "<" + pos + "," + page + ">";
66      }
67  }