View Javadoc

1   /*
2    *   Copyright 2004 The Apache Software Foundation
3    *
4    *   Licensed under the Apache License, Version 2.0 (the "License");
5    *   you may not use this file except in compliance with the License.
6    *   You may obtain a copy of the License at
7    *
8    *       http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *   Unless required by applicable law or agreed to in writing, software
11   *   distributed under the License is distributed on an "AS IS" BASIS,
12   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *   See the License for the specific language governing permissions and
14   *   limitations under the License.
15   *
16   */
17  package org.apache.ldap.server.db;
18  
19  
20  import org.apache.ldap.common.filter.ExprNode;
21  
22  import javax.naming.NamingEnumeration;
23  import javax.naming.NamingException;
24  
25  
26  /***
27   * An enumeration builder or factory for filter expressions.
28   * 
29   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30   * @version $Rev: 159259 $
31   */
32  public interface Enumerator
33  {
34      /***
35       * Creates an enumeration to enumerate through the set of candidates 
36       * satisfying a filter expression.
37       * 
38       * @param node a filter expression root
39       * @return an enumeration over the 
40       * @throws NamingException if database access fails
41       */
42      NamingEnumeration enumerate( ExprNode node ) throws NamingException;
43  }