nl.trivento.albero.model.Tree 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.List;

import nl.trivento.albero.model.model.Model;
import nl.trivento.albero.model.text.Dictionary;

/**
 * A decision tree.
 *
 */
public interface Tree {
	/**
	 * Returns this tree's code. It is unique for an organisation.
	 *
	 * @return the code of this tree
	 */
	String getCode();

	/**
	 * Returns this tree's dictionary.
	 *
	 * @return the dictionary of this tree
	 */
	Dictionary getDictionary();

	/**
	 * Returns the model of this tree.
	 *
	 * @return this tree's model
	 */
	Model getModel();

	/**
	 * Returns the codes of all of the nodes in this tree.
	 *
	 * @return the codes of this tree's nodes
	 */
	List getNodeCodes();

	/**
	 * Finds a node in this decision tree by its code.
	 *
	 * @param code the code of the node to return
	 * @return the node with the given code or {@code null} when no such node exists in this tree
	 */
	Node findNode(String code);

	/**
	 * Returns the result model of this tree.
	 *
	 * @return this tree's result model
	 */
	Model getResultModel();

	/**
	 * Returns all result providers of this tree.
	 *
	 * @return this tree's result providers
	 */
	List getResultProviders();
}