org.tensorics.core.tree.domain.ResolvingContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tensorics-core Show documentation

Tensorics is a java framework which uses a tensor as a central object. A tensor represents a set of values placed in an N-dimensional space. Wherever you are tempted to use maps of maps, a tensor might be a good choice ;-) Tensorics provides methods to create, transform and performing calculations with those tensors.

There is a newer version: 0.0.81

Show newest version

// @formatter:off
 /*******************************************************************************
 *
 * This file is part of tensorics.
 * 
 * Copyright (c) 2008-2011, CERN. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 ******************************************************************************/
// @formatter:on

package org.tensorics.core.tree.domain;

/**
 * A container for resolved expressions which can be used by resolvers of expressions that need these results.
 * 
 * @author kfuchsbe
 */
public interface ResolvingContext {

    /**
     * Checks if the expression is resolved within this context. Only if this method returns {@code true}, then it is
     * safe to call the {@link #resolvedValueOf(Expression)} method. An expression is seen as resolved, either if the
     * context knows already the resolved value or, if the given expression is a resolved expression by itself.
     * 
     * @param expression the expression for which to check if it is resolved
     * @return {@code true} if the expression is resolved within the context, {@code false} if not
     */
    > boolean resolves(E expression);

    /**
     * Retrieves the resolved value for the expression. This action can be completed, if the result of the given
     * expression is already known within the context, or if the expression is a resolved expression itself.
     * 
     * An {@link IllegalArgumentException} will be thrown, if the expression cannot be resolved within the context.
     * Therefore it is mandatory to call the {@link #resolves(Expression)} method first to check if the expression is
     * resolved in the context.
     * 
     * @param expression the expression for which to retrieve the resolved value
     * @return the resolved value for the expression
     */
    > R resolvedValueOf(E expression);

    /**
     * Retrieves the amount of resolved values which are stored in the context.
     * 
     * @return the number of stored resolved values
     */
    int size();

}