CellNode.java

/*
 * Copyright (c) 2012 Data Harmonisation Panel
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Contributors:
 *     HUMBOLDT EU Integrated Project #030962
 *     Data Harmonisation Panel <http://www.dhpanel.eu>
 */

package eu.esdihumboldt.hale.common.align.model.transformation.tree;

import java.util.List;
import java.util.Set;

import eu.esdihumboldt.hale.common.align.model.Cell;

/**
 * Represents a cell in the transformation tree
 * 
 * @author Simon Templer
 */
public interface CellNode extends TransformationNode {

	/**
	 * Name of the valid annotation
	 */
	public static final String ANNOTATION_VALID = "valid";

	/**
	 * Get the associated cell.
	 * 
	 * @return the cell
	 */
	public Cell getCell();

	/**
	 * Get the source entities associated to the cell.
	 * 
	 * @return the source entities represented by source nodes
	 */
	public List<SourceNode> getSources();

	/**
	 * Get the entity names for the given source node. These are the names of
	 * the cell entities the node is associated to.
	 * 
	 * @param source the source node
	 * @return the source names
	 */
	public Set<String> getSourceNames(SourceNode source);

	/**
	 * Add an associated target node to the cell.
	 * 
	 * @param target the target node
	 */
	public void addTarget(TargetNode target);

	/**
	 * Get the associated target nodes.
	 * 
	 * @return the list of target nodes
	 */
	public List<TargetNode> getTargets();

	/**
	 * Set the value of the valid annotation.
	 * 
	 * @see #ANNOTATION_VALID
	 * @param valid if the cell node is valid in its configuration for
	 *            transformation execution
	 */
	public void setValid(boolean valid);

	/**
	 * Get the value of the valid annotation. Returns <code>false</code> in any
	 * case if no validation has been performed yet.
	 * 
	 * @return if the cell node is valid in its configuration for transformation
	 *         execution
	 */
	public boolean isValid();

}