View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.jxpath;
18  
19  /**
20   * A delegate of {@link JXPathContext} that implements the XPath <code>"key()"</code>
21   * function.
22   *
23   * @author Dmitri Plotnikov
24   * @version $Revision: 652845 $ $Date: 2008-05-02 13:46:46 -0400 (Fri, 02 May 2008) $
25   */
26  public interface KeyManager {
27  
28      /**
29       * Find a node by key/value.
30       *
31       * @param context to search
32       * @param keyName String
33       * @param keyValue String
34       * @return Pointer
35       */
36      Pointer getPointerByKey(
37          JXPathContext context,
38          String keyName,
39          String keyValue);
40  }