nl.trivento.albero.model.Node Maven / Gradle / Ivy

Go to download
/* Copyright 2011-2012 Profict Holding 
*
* 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.
*/
package nl.trivento.albero.model;

import java.util.Map;

import nl.trivento.albero.model.forms.Form;

/**
 * A node in a {@link Tree decision tree}.
 *
 */
public interface Node {
	/**
	 * Returns the code of this node. It is unique within a tree.
	 *
	 * @return this node's code
	 */
	String getCode();

	/**
	 * Returns the group of this node. Node groups are optional.
	 *
	 * @return this node's group (may be {@code null})
	 */
	String getGroup();

	/**
	 * Returns all of the dynamic properties of this node.
	 *
	 * @return this node's dynamic properties
	 */
	Map getDynamicProperties();

	/**
	 * Determines whether this node can be evaluated in a certain context.
	 *
	 * @param context the context to inspect
	 * @return {@code true} if this node's {@link #evaluate(EvaluationContext, boolean) evaluate method} may be used,
	 *         {@code false} otherwise
	 */
	boolean isEvaluatable(Context context);

	/**
	 * Evaluates this node in a certain context.
	 *
	 * @param evaluationContext the context of the evaluation
	 * @param validate whether or not to apply validation
	 * @return the form that should be presented to the user (may be {@code null})
	 * @throws EvaluationException when this node can't be evaluated
	 */
	Form evaluate(EvaluationContext evaluationContext, boolean validate) throws EvaluationException;
}