    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 *     https://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 */
    017package org.apache.commons.configuration2.tree;
    018
    019import java.util.List;
    020
    021/**
    022 * <p>
    023 * Definition of an interface for evaluating keys for hierarchical configurations.
    024 * </p>
    025 * <p>
    026 * An <em>expression engine</em> knows how to map a key for a configuration's property to a single or a set of
    027 * configuration nodes. Thus it defines the way how properties are addressed in this configuration. Methods of a
    028 * configuration that have to handle property keys (for example {@code getProperty()} or {@code addProperty()} do not interpret
    029 * the passed in keys on their own, but delegate this task to an associated expression engine. This expression engine
    030 * will then find out, which configuration nodes are addressed by the key.
    031 * </p>
    032 * <p>
    033 * Separating the task of evaluating property keys from the configuration object has the advantage that multiple
    034 * different expression languages (i.e. ways for querying or setting properties) can be supported. Just set a suitable
    035 * implementation of this interface as the configuration's expression engine, and you can use the syntax provided by
    036 * this implementation.
    037 * </p>
    038 * <p>
    039 * An {@code ExpressionEngine} can deal with nodes of different types. To achieve this, a {@link NodeHandler} for the
    040 * desired type must be passed to the methods.
    041 * </p>
    042 *
    043 * @since 1.3
    044 */
    045public interface ExpressionEngine {
    046    /**
    047     * Returns the key of an attribute. The passed in {@code parentKey} must reference the parent node of the attribute. A
    048     * concrete implementation must concatenate this parent key with the attribute name to a valid key for this attribute.
    049     *
    050     * @param parentKey the key to the node owning this attribute
    051     * @param attributeName the name of the attribute in question
    052     * @return the resulting key referencing this attribute
    053     */
    054    String attributeKey(String parentKey, String attributeName);
    055
    056    /**
    057     * Determines a &quot;canonical&quot; key for the specified node in the expression language supported by this
    058     * implementation. This means that always a unique key if generated pointing to this specific node. For most concrete
    059     * implementations, this means that an index is added to the node name to ensure that there are no ambiguities with
    060     * child nodes having the same names.
    061     *
    062     * @param <T> the type of the node to be processed
    063     * @param node the node, for which the key must be constructed
    064     * @param parentKey the key of this node's parent (can be <strong>null</strong> for the root node)
    065     * @param handler the {@code NodeHandler} for accessing the node
    066     * @return the canonical key of this node
    067     */
    068    <T> String canonicalKey(T node, String parentKey, NodeHandler<T> handler);
    069
    070    /**
    071     * Returns the key for the specified node in the expression language supported by an implementation. This method is
    072     * called whenever a property key for a node has to be constructed, for example by the
    073     * {@link org.apache.commons.configuration2.Configuration#getKeys() getKeys()} method.
    074     *
    075     * @param <T> the type of the node to be processed
    076     * @param node the node, for which the key must be constructed
    077     * @param parentKey the key of this node's parent (can be <strong>null</strong> for the root node)
    078     * @param handler the {@code NodeHandler} for accessing the node
    079     * @return this node's key
    080     */
    081    <T> String nodeKey(T node, String parentKey, NodeHandler<T> handler);
    082
    083    /**
    084     * Returns information needed for an add operation. This method gets called when new properties are to be added to a
    085     * configuration. An implementation has to interpret the specified key, find the parent node for the new elements, and
    086     * provide all information about new nodes to be added.
    087     *
    088     * @param <T> the type of the node to be processed
    089     * @param root the root node
    090     * @param key the key for the new property
    091     * @param handler the {@code NodeHandler} for accessing the node
    092     * @return an object with all information needed for the add operation
    093     */
    094    <T> NodeAddData<T> prepareAdd(T root, String key, NodeHandler<T> handler);
    095
    096    /**
    097     * Finds the nodes and/or attributes that are matched by the specified key. This is the main method for interpreting
    098     * property keys. An implementation must traverse the given root node and its children to find all results that are
    099     * matched by the given key. If the key is not correct in the syntax provided by that implementation, it is free to
    100     * throw a (runtime) exception indicating this error condition. The passed in {@code NodeHandler} can be used to gather
    101     * the required information from the node object.
    102     *
    103     * @param <T> the type of the node to be processed
    104     * @param root the root node of a hierarchy of nodes
    105     * @param key the key to be evaluated
    106     * @param handler the {@code NodeHandler} for accessing the node
    107     * @return a list with the results that are matched by the key (should never be <strong>null</strong>)
    108     */
    109    <T> List<QueryResult<T>> query(T root, String key, NodeHandler<T> handler);
    110}