annotate java/src/uk/ac/qmul/eecs/ccmi/gui/Finder.java @ 0:9418ab7b7f3f

Initial import

/*  
 CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
  
 Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program 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.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
package uk.ac.qmul.eecs.ccmi.gui;

import java.awt.geom.Point2D;
import java.util.Collection;

import uk.ac.qmul.eecs.ccmi.diagrammodel.DiagramElement;
import uk.ac.qmul.eecs.ccmi.diagrammodel.DiagramModelTreeNode;

/**
 * 
 * A utility class which provides methods for searching either a node or an edge 
 * in a collection or array.
 *
 */
public abstract class Finder {
	public static Node findNode(String nodeClass,Node[] prototypes){
		for(Node n : prototypes){
			if(n.getType().equals(nodeClass)){
				return n;
			}
		}
		return null;
	}
	
	public static Edge findEdge(String edgeClass,Edge[] prototypes){
		for(Edge e : prototypes){
			if(e.getType().equals(edgeClass)){
				return e;
			}
		}
		return null;
	}
	
	public static Node findNode(Long id, Collection<Node> collection){
		for(Node n : collection)
			if(n.getId() == id)
				return n;
		return null;
	}
	
	public static Node findNode(Point2D p, Collection<Node> collection){
		for (Node n : collection)
			if (n.contains(p)) 
				return n;
		return null;
	}
	
	public static Edge findEdge(Point2D p, Collection<Edge> collection){
		for (Edge e : collection)
			if (e.contains(p)) 
				return e;
		return null;
	}
	
	public static Edge findEdge(Long id, Collection<Edge> collection){
		for(Edge e : collection)
			if(e.getId() == id)
				return e;
		return null;
	}
	
	public static DiagramElement findElement(Long id, Collection<DiagramElement> collection){
		for(DiagramElement e : collection)
			if(e.getId() == id)
				return e;
		return null;
	}
	
	public static DiagramElement findElementByHashcode(long identityHashcode, Collection<DiagramElement> collection){
		for(DiagramElement de : collection){
			if(System.identityHashCode(de) == identityHashcode){
				return de;
			}
		}
		return null;
	}
	
	/**
	 * Return the tree node whose path is described by the variable path
	 * where path contains the indexes returned by each node n of the path upon calling n.getParent().getChildAt(n) 
	 * 
	 * @param path
	 * @param root
	 * @return
	 */
	public static DiagramModelTreeNode findTreeNode(int[] path, DiagramModelTreeNode root){
		DiagramModelTreeNode retVal = root;
		for(int i=0;i<path.length;i++){
			if(retVal.getChildCount() <= path[i])
				return null;
			retVal = retVal.getChildAt(path[i]);
		}
		return retVal;
	}

}