CellNodeImpl.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.impl;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map.Entry;
import java.util.Set;

import net.jcip.annotations.Immutable;

import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ListMultimap;
import com.google.common.collect.Multimaps;

import eu.esdihumboldt.hale.common.align.model.Cell;
import eu.esdihumboldt.hale.common.align.model.Entity;
import eu.esdihumboldt.hale.common.align.model.transformation.tree.CellNode;
import eu.esdihumboldt.hale.common.align.model.transformation.tree.SourceNode;
import eu.esdihumboldt.hale.common.align.model.transformation.tree.TargetNode;
import eu.esdihumboldt.hale.common.align.model.transformation.tree.TransformationNode;
import eu.esdihumboldt.hale.common.align.model.transformation.tree.TransformationNodeVisitor;

/**
 * Default {@link CellNode} implementation
 * 
 * @author Simon Templer
 */
@Immutable
public class CellNodeImpl extends AbstractTransformationNode implements CellNode {

	private final Cell cell;
	private final ListMultimap<SourceNode, String> sources;
	private final List<TargetNode> targets = new ArrayList<TargetNode>();

	/**
	 * Creates a cell node where the sources are populated from the given cell.
	 * 
	 * @param cell the cell
	 * @param sourceNodes the factory for creating source nodes
	 */
	public CellNodeImpl(Cell cell, SourceNodeFactory sourceNodes) {
		super();
		this.cell = cell;

		ListMultimap<SourceNode, String> sourceList = ArrayListMultimap.create();

		if (cell.getSource() != null) {
			for (Entry<String, ? extends Entity> namedEntity : cell.getSource().entries()) {
				SourceNode node = sourceNodes.getSourceNode(namedEntity.getValue().getDefinition());
				// XXX what about filter etc.?!
				node.addRelation(this);
				sourceList.put(node, namedEntity.getKey());
			}
		}

		sources = Multimaps.unmodifiableListMultimap(sourceList);
	}

	/**
	 * Create a cell node w/o associated sources. Sources can be added later on
	 * through {@link #addSource(Set, SourceNode)}
	 * 
	 * @param cell the associated cell
	 */
	public CellNodeImpl(Cell cell) {
		this.cell = cell;
		sources = ArrayListMultimap.create();
	}

	/**
	 * Add a source to the cell node. May only be called if the cell node was
	 * created using the {@link #CellNodeImpl(Cell)} constructor.
	 * 
	 * @param names the entity names associated to the source
	 * @param source the source node
	 */
	public void addSource(Set<String> names, SourceNode source) {
		sources.putAll(source, names);
	}

	/**
	 * @see TransformationNode#accept(TransformationNodeVisitor)
	 */
	@Override
	public void accept(TransformationNodeVisitor visitor) {
		if (visitor.visit(this)) {
			if (visitor.isFromTargetToSource()) {
				// visit sources
				for (SourceNode source : sources.keySet()) {
					source.accept(visitor);
				}
			}
			else {
				// visit targets
				for (TargetNode target : targets) {
					target.accept(visitor);
				}
			}
		}
		visitor.leave(this);
	}

	/**
	 * @see CellNode#getCell()
	 */
	@Override
	public Cell getCell() {
		return cell;
	}

	/**
	 * @see CellNode#getSources()
	 */
	@Override
	public List<SourceNode> getSources() {
		return new ArrayList<SourceNode>(sources.keySet());
	}

	/**
	 * @see CellNode#getSourceNames(SourceNode)
	 */
	@Override
	public Set<String> getSourceNames(SourceNode source) {
		return new HashSet<String>(sources.get(source));
	}

	/**
	 * @see CellNode#addTarget(TargetNode)
	 */
	@Override
	public void addTarget(TargetNode target) {
		targets.add(target);
	}

	/**
	 * @see CellNode#getTargets()
	 */
	@Override
	public List<TargetNode> getTargets() {
		return Collections.unmodifiableList(targets);
	}

	/**
	 * @see CellNode#setValid(boolean)
	 */
	@Override
	public void setValid(boolean valid) {
		setAnnotation(ANNOTATION_VALID, valid);
	}

	/**
	 * @see CellNode#isValid()
	 */
	@Override
	public boolean isValid() {
		Object value = getAnnotation(ANNOTATION_VALID);
		if (value instanceof Boolean) {
			return (Boolean) value;
		}
		return false;
	}

	/**
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((cell == null) ? 0 : cell.hashCode());
		return result;
	}

	/**
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		CellNodeImpl other = (CellNodeImpl) obj;
		if (cell == null) {
			if (other.cell != null)
				return false;
		}
		else if (!cell.equals(other.cell))
			return false;
		return true;
	}

}