001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.uml.ui.support.visitors;
043:
044: import java.util.Collections;
045: import org.netbeans.modules.uml.common.generics.IteratorT;
046: import org.netbeans.modules.uml.core.support.umlutils.ETArrayList;
047: import org.netbeans.modules.uml.core.support.umlutils.ETList;
048: import org.netbeans.modules.uml.ui.products.ad.graphobjects.ETGraph;
049: import org.netbeans.modules.uml.ui.support.viewfactorysupport.IETGraphObject;
050:
051: import java.util.Iterator;
052: import java.util.List;
053:
054: /**
055: * @author KevinM
056: * Traverses the graphs nodes, edges, nodeLabels and edgeLabels.
057: * Please note you should only use this in non destructive operations.
058: */
059: public class ETGraphObjectTraversal {
060: protected ETGraph m_graph;
061: ETList<IETGraphObjectVisitor> listeners = new ETArrayList<IETGraphObjectVisitor>();
062:
063: /**
064: *
065: */
066: public ETGraphObjectTraversal(ETGraph graph) {
067: super ();
068: m_graph = graph;
069: }
070:
071: /*
072: * Returns true if all graph objects have been visited.
073: */
074: public boolean traverse() {
075: return m_graph != null && visitThese(m_graph.nodes())
076: && visitThese(m_graph.edges())
077: && visitThese(m_graph.nodeLabels())
078: && visitThese(m_graph.edgeLabels());
079: }
080:
081: /*
082: * Adds a visiter to the listener list.
083: */
084: public void addVisitor(IETGraphObjectVisitor visiter) {
085: listeners.add(visiter);
086: }
087:
088: /*
089: * Removes a visiter from the visiter list.
090: */
091: public void removeVisitor(IETGraphObjectVisitor visiter) {
092: listeners.remove(visiter);
093: }
094:
095: /*
096: * Returns true if we should continue with the traversal.
097: */
098: protected boolean visit(IETGraphObject object) {
099: Iterator<IETGraphObjectVisitor> iter = listeners.iterator();
100: while (iter.hasNext()) {
101: if (!iter.next().visit(object)) {
102: return false;
103: }
104: }
105: return true;
106: }
107:
108: /*
109: * Returns true if we should continue with the traversal.
110: */
111: protected boolean visitThese(List objectList) {
112: IteratorT<IETGraphObject> iter = new IteratorT<IETGraphObject>(
113: objectList);
114: while (iter.hasNext()) {
115: if (!visit(iter.next())) {
116: return false;
117: }
118: }
119: return true;
120: }
121:
122: public boolean traverseInReverseOrder() {
123: List nodes = new ETArrayList(m_graph.nodes());
124: Collections.reverse(nodes);
125: return m_graph != null && visitThese(nodes)
126: && visitThese(m_graph.edges())
127: && visitThese(m_graph.nodeLabels())
128: && visitThese(m_graph.edgeLabels());
129: }
130: }
|