ComparatorRegistry


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.schema;
18  
19  
20  import javax.naming.NamingException  ;
21  import java.util.Comparator  ;
22  
23  
24  /**
25   * Comparator registry component's service interface.
26   *
27   * @author <a HREF="mailto:dev@directory.apache.org">Apache Directory Project</a>
28   * @version $Rev: 169198 $
29   */
30  public interface ComparatorRegistry
31  {
32      /**
33       * Gets the name of the schema this schema object is associated with.
34       *
35       * @param oid the object identifier
36       * @return the schema name
37       * @throws NamingException if the schema object does not exist 
38       */
39      String   getSchemaName( String   oid ) throws NamingException  ;
40  
41      /**
42       * Registers a Comparator with this registry.
43       * 
44       * @param schema the name of the schema the comparator is associated with
45       * @param oid the object identifier
46       * @param comparator the Comparator to register
47       * @throws NamingException if the Comparator is already registered or the 
48       *      registration operation is not supported
49       */
50      void register( String   schema, String   oid, Comparator   comparator ) throws NamingException  ;
51      
52      /**
53       * Looks up a Comparator by its unique Object Identifier.
54       * 
55       * @param oid the object identifier
56       * @return the Comparator for the oid
57       * @throws NamingException if there is a backing store failure or the 
58       *      Comparator does not exist.
59       */
60      Comparator   lookup( String   oid ) throws NamingException  ;
61  
62      /**
63       * Checks to see if a Comparator exists.  Backing store failures simply 
64       * return false.
65       * 
66       * @param oid the object identifier
67       * @return true if a Comparator definition exists for the oid, false 
68       *      otherwise
69       */
70      boolean hasComparator( String   oid );
71  }
72
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags