    001    /*
    002     * Licensed to the Apache Software Foundation (ASF) under one or more
    003     * contributor license agreements.  See the NOTICE file distributed with
    004     * this work for additional information regarding copyright ownership.
    005     * The ASF licenses this file to You under the Apache License, Version 2.0
    006     * (the "License"); you may not use this file except in compliance with
    007     * the License.  You may obtain a copy of the License at
    008     *
    009     *     http://www.apache.org/licenses/LICENSE-2.0
    010     *
    011     * Unless required by applicable law or agreed to in writing, software
    012     * distributed under the License is distributed on an "AS IS" BASIS,
    013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014     * See the License for the specific language governing permissions and
    015     * limitations under the License.
    016     */
    017    package org.apache.commons.jxpath;
    018
    019    /**
    020     * A delegate of {@link JXPathContext} that implements the XPath <code>"key()"</code>
    021     * function.
    022     *
    023     * @author Dmitri Plotnikov
    024     * @version $Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
    025     */
    026    public interface KeyManager {
    027
    028        /**
    029         * Find a node by key/value.
    030         *
    031         * @param context to search
    032         * @param keyName String
    033         * @param keyValue String
    034         * @return Pointer
    035         */
    036        Pointer getPointerByKey(
    037            JXPathContext context,
    038            String keyName,
    039            String keyValue);
    040    }