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.server.core.partition.impl.btree;
21  
22  
23  import org.apache.directory.server.xdbm.IndexEntry;
24  
25  import javax.naming.NamingException;
26  
27  
28  /**
29   * Asserts whether or not a candidate should be returned in searching based on
30   * hard coded logic.  This interface is not related to the filter AssertionNode.
31   * It is strictly used for purposes internal to the search engine.
32   * 
33   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34   * @version $Rev: 642356 $
35   */
36  public interface IndexAssertion<K,E>
37  {
38      /**
39       * Tests to see if a perspective candidate should be returned based on 
40       * the evaluation of hard coded logic.  If the entry has not been 
41       * resusitated then the getObject member of the record will be null.  As
42       * a side-effect an index assertion may populate the entry attribute after
43       * resusitating an entry from the master table.
44       * 
45       * @param entry an index record of the entry
46       * @return true if the entry should be returned, false otherwise
47       * @throws NamingException if their are failures while asserting the 
48       * condition
49       */
50      boolean assertCandidate( IndexEntry<K,E> entry ) throws Exception;
51  }