View Javadoc

1   /*
2    * Copyright 1999-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  package org.apache.commons.jxpath;
17  
18  /***
19   * A delegate of JXPathContext that implements the XPath <code>"key()"</code>
20   * function.
21   *
22   * @author Dmitri Plotnikov
23   * @version $Revision: 1.5 $ $Date: 2004/02/29 14:17:42 $
24   */
25  public interface KeyManager {
26  
27      /***
28       * Finds a node by a key value.
29       */
30      Pointer getPointerByKey(
31          JXPathContext context,
32          String keyName,
33          String keyValue);
34  }