/*
 File: FlagAndSelectionHandler.java

 Copyright (c) 2006, The Cytoscape Consortium (www.cytoscape.org)

 The Cytoscape Consortium is:
 - Institute for Systems Biology
 - University of California San Diego
 - Memorial Sloan-Kettering Cancer Center
 - Institut Pasteur
 - Agilent Technologies

 This library is free software; you can redistribute it and/or modify it
 under the terms of the GNU Lesser General Public License as published
 by the Free Software Foundation; either version 2.1 of the License, or
 any later version.

 This library is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF
 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  The software and
 documentation provided hereunder is on an "as is" basis, and the
 Institute for Systems Biology and the Whitehead Institute
 have no obligations to provide maintenance, support,
 updates, enhancements or modifications.  In no event shall the
 Institute for Systems Biology and the Whitehead Institute
 be liable to any party for direct, indirect, special,
 incidental or consequential damages, including lost profits, arising
 out of the use of this software and its documentation, even if the
 Institute for Systems Biology and the Whitehead Institute
 have been advised of the possibility of such damage.  See
 the GNU Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software Foundation,
 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 */

//---------------------------------------------------------------------------
//  $Revision: 9920 $ 
//  $Date: 2007-04-09 16:17:52 -0500 (Mon, 09 Apr 2007) $
//  $Author: mes $
//---------------------------------------------------------------------------
package cytoscape.view;

import cytoscape.data.SelectEvent;
import cytoscape.data.SelectEventListener;
import cytoscape.data.SelectFilter;

//---------------------------------------------------------------------------
import giny.model.Edge;
import giny.model.Node;
import giny.model.RootGraph;

import giny.view.EdgeView;
import giny.view.GraphView;
import giny.view.GraphViewChangeEvent;
import giny.view.GraphViewChangeListener;
import giny.view.NodeView;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Set;


//---------------------------------------------------------------------------
/**
 * This class synchronizes the flagged status of nodes and edges as held by a
 * SelectFilter object of a network with the selection status of the corresponding
 * node and edge views in a GraphView. An object will be selected in the view
 * iff the matching object is flagged in the SelectFilter. This class is only used
 * by PhoebeNetworkView, which no longer used anywhere.
 */
public class FlagAndSelectionHandler implements SelectEventListener, GraphViewChangeListener {
	private SelectFilter selectFilter;
	private GraphView view;

	/**
	 * Standard constructor takes the flag filter and the view that should be
	 * synchronized. On construction, this object will synchronize the filter
	 * and view by turning on flags or selections that are currently on in one
	 * of the two objects.
	 */
	public FlagAndSelectionHandler(SelectFilter selectFilter, GraphView view) {
		this.selectFilter = selectFilter;
		this.view = view;
		syncFilterAndView();
		selectFilter.addSelectEventListener(this);
		view.addGraphViewChangeListener(this);
	}

	/**
	 * Synchronizes the filter and view of this object by selecting every object
	 * that is currently flagged and vice versa.
	 */
	private void syncFilterAndView() {
		final Set<Node> flaggedNodes = selectFilter.getSelectedNodes();
		final Set<Edge> flaggedEdges = selectFilter.getSelectedEdges();

		final List<Node> selectedNodes = view.getSelectedNodes();
		final List<Edge> selectedEdges = view.getSelectedEdges();

		// select all nodes that are flagged but not currently selected
		for (Iterator iter = flaggedNodes.iterator(); iter.hasNext();) {
			Node node = (Node) iter.next();
			NodeView nv = view.getNodeView(node);

			if ((nv == null) || nv.isSelected()) {
				continue;
			}

			nv.setSelected(true);
		}

		// select all edges that are flagged but not currently selected
		for (Iterator iter = flaggedEdges.iterator(); iter.hasNext();) {
			Edge edge = (Edge) iter.next();
			EdgeView ev = view.getEdgeView(edge);

			if ((ev == null) || ev.isSelected()) {
				continue;
			}

			ev.setSelected(true);
		}

		// flag all nodes that are selected but not currently flagged
		for (Iterator iter = selectedNodes.iterator(); iter.hasNext();) {
			NodeView nv = (NodeView) iter.next();
			Node node = nv.getNode();
			selectFilter.setSelected(node, true); // does nothing if already
			                                   // flagged
		}

		// flag all edges that are selected but not currently flagged
		for (Iterator iter = selectedEdges.iterator(); iter.hasNext();) {
			EdgeView ev = (EdgeView) iter.next();
			Edge edge = ev.getEdge();
			selectFilter.setSelected(edge, true); // does nothing if already
			                                   // flagged
		}
	}

	/**
	 * Responds to selection events from the view by setting the matching
	 * flagged state in the SelectFilter object.
	 */
	public void graphViewChanged(GraphViewChangeEvent event) {
		// GINY bug: the event we get frequently has the correct indices
		// but incorrect Node and Edge objects. For now we get around this
		// by converting indices to graph objects ourselves
		final GraphView source = (GraphView) event.getSource();
		final RootGraph rootGraph = source.getGraphPerspective().getRootGraph();

		int[] objIndecies;

		if (event.isNodesSelectedType()) {
			objIndecies = event.getSelectedNodeIndices();

			final List<Node> selList = new ArrayList<Node>();

			for (int index = 0; index < objIndecies.length; index++) {
				selList.add(rootGraph.getNode(objIndecies[index]));
			}

			selectFilter.setSelectedNodes(selList, true);
		} else if (event.isNodesUnselectedType() || event.isNodesHiddenType()) {
			if (event.isNodesUnselectedType()) {
				objIndecies = event.getUnselectedNodeIndices();
			} else {
				objIndecies = event.getHiddenNodeIndices();
			}

			final List<Node> unselList = new ArrayList<Node>();

			for (int index = 0; index < objIndecies.length; index++) {
				unselList.add(rootGraph.getNode(objIndecies[index]));
			}

			selectFilter.setSelectedNodes(unselList, false);
		} else if (event.isEdgesSelectedType()) {
			objIndecies = event.getSelectedEdgeIndices();

			final List<Edge> selList = new ArrayList<Edge>();

			for (int index = 0; index < objIndecies.length; index++) {
				selList.add(rootGraph.getEdge(objIndecies[index]));
			}

			selectFilter.setSelectedEdges(selList, true);
		} else if (event.isEdgesUnselectedType() || event.isEdgesHiddenType()) {
			if (event.isEdgesUnselectedType()) {
				objIndecies = event.getUnselectedEdgeIndices();
			} else {
				objIndecies = event.getHiddenEdgeIndices();
			}

			final List<Edge> unselList = new ArrayList<Edge>();

			for (int index = 0; index < objIndecies.length; index++) {
				unselList.add(rootGraph.getEdge(objIndecies[index]));
			}

			selectFilter.setSelectedEdges(unselList, false);
		}
	}

	/**
	 * Responds to events indicating a change in the flagged state of one or
	 * more nodes or edges. Sets the corresponding selection state for views of
	 * those objects in the graph view.
	 */
	public void onSelectEvent(SelectEvent event) {
		if (event.getTargetType() == SelectEvent.SINGLE_NODE) { // single node
			setNodeSelected((Node) event.getTarget(), event.getEventType());
		} else if (event.getTargetType() == SelectEvent.SINGLE_EDGE) { // single
			                                                         // edge
			setEdgeSelected((Edge) event.getTarget(), event.getEventType());
		} else if (event.getTargetType() == SelectEvent.NODE_SET) { // multiple
			                                                      // nodes

			Set nodeSet = (Set) event.getTarget();

			for (Iterator iter = nodeSet.iterator(); iter.hasNext();) {
				Node node = (Node) iter.next();
				setNodeSelected(node, event.getEventType());
			}
		} else if (event.getTargetType() == SelectEvent.EDGE_SET) { // multiple
			                                                      // edges

			Set edgeSet = (Set) event.getTarget();

			for (Iterator iter = edgeSet.iterator(); iter.hasNext();) {
				Edge edge = (Edge) iter.next();
				setEdgeSelected(edge, event.getEventType());
			}
		} else { // unexpected target type

			return;
		}
	}

	/**
	 * Helper method to set selection for a node view.
	 */
	private void setNodeSelected(Node node, boolean selectOn) {
		NodeView nodeView = view.getNodeView(node);

		if (nodeView == null) {
			return;
		} // sanity check
		  // Giny fires a selection event even if there's no change in state
		  // we trap this by only requesting a selection if there's a change

		if (nodeView.isSelected() != selectOn) {
			nodeView.setSelected(selectOn);
		}
	}

	/**
	 * Helper method to set selection for an edge view.
	 */
	private void setEdgeSelected(Edge edge, boolean selectOn) {
		EdgeView edgeView = view.getEdgeView(edge);

		if (edgeView == null) {
			return;
		} // sanity check
		  // Giny fires a selection event even if there's no change in state
		  // we trap this by only requesting a selection if there's a change

		if (edgeView.isSelected() != selectOn) {
			edgeView.setSelected(selectOn);
		}
	}
}