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