| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| CrNoOutgoingTransitions |
|
| 8.0;8 |
| 1 | /* $Id: CrNoOutgoingTransitions.java 17965 2010-02-04 23:36:04Z bobtarling $ | |
| 2 | ***************************************************************************** | |
| 3 | * Copyright (c) 2009 Contributors - see below | |
| 4 | * All rights reserved. This program and the accompanying materials | |
| 5 | * are made available under the terms of the Eclipse Public License v1.0 | |
| 6 | * which accompanies this distribution, and is available at | |
| 7 | * http://www.eclipse.org/legal/epl-v10.html | |
| 8 | * | |
| 9 | * Contributors: | |
| 10 | * mvw | |
| 11 | ***************************************************************************** | |
| 12 | * | |
| 13 | * Some portions of this file was previously release using the BSD License: | |
| 14 | */ | |
| 15 | ||
| 16 | // Copyright (c) 1996-2009 The Regents of the University of California. All | |
| 17 | // Rights Reserved. Permission to use, copy, modify, and distribute this | |
| 18 | // software and its documentation without fee, and without a written | |
| 19 | // agreement is hereby granted, provided that the above copyright notice | |
| 20 | // and this paragraph appear in all copies. This software program and | |
| 21 | // documentation are copyrighted by The Regents of the University of | |
| 22 | // California. The software program and documentation are supplied "AS | |
| 23 | // IS", without any accompanying services from The Regents. The Regents | |
| 24 | // does not warrant that the operation of the program will be | |
| 25 | // uninterrupted or error-free. The end-user understands that the program | |
| 26 | // was developed for research purposes and is advised not to rely | |
| 27 | // exclusively on the program for any reason. IN NO EVENT SHALL THE | |
| 28 | // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, | |
| 29 | // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, | |
| 30 | // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF | |
| 31 | // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF | |
| 32 | // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY | |
| 33 | // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | |
| 34 | // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE | |
| 35 | // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF | |
| 36 | // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, | |
| 37 | // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. | |
| 38 | ||
| 39 | package org.argouml.uml.cognitive.critics; | |
| 40 | ||
| 41 | import java.util.Collection; | |
| 42 | import java.util.HashSet; | |
| 43 | import java.util.Set; | |
| 44 | ||
| 45 | import org.argouml.cognitive.Designer; | |
| 46 | import org.argouml.model.Model; | |
| 47 | import org.argouml.uml.cognitive.UMLDecision; | |
| 48 | ||
| 49 | /** | |
| 50 | * A critic to detect when a state has no outgoing transitions. | |
| 51 | * <p> | |
| 52 | * Also a transition from a state contained in the dm going out of the dm | |
| 53 | * counts as an "outgoing" transition thanks to issue 689. | |
| 54 | * | |
| 55 | * @author jrobbins | |
| 56 | */ | |
| 57 | public class CrNoOutgoingTransitions extends CrUML { | |
| 58 | ||
| 59 | /** | |
| 60 | * Constructor. | |
| 61 | */ | |
| 62 | 900 | public CrNoOutgoingTransitions() { |
| 63 | 900 | setupHeadAndDesc(); |
| 64 | 900 | addSupportedDecision(UMLDecision.STATE_MACHINES); |
| 65 | 900 | addTrigger("outgoing"); |
| 66 | 900 | } |
| 67 | ||
| 68 | /* | |
| 69 | * @see org.argouml.uml.cognitive.critics.CrUML#predicate2(java.lang.Object, org.argouml.cognitive.Designer) | |
| 70 | */ | |
| 71 | public boolean predicate2(Object dm, Designer dsgr) { | |
| 72 | 570 | if (!(Model.getFacade().isAStateVertex(dm))) { |
| 73 | 0 | return NO_PROBLEM; |
| 74 | } | |
| 75 | /* Now we are sure dm is a StateVertex. */ | |
| 76 | ||
| 77 | 570 | if (Model.getFacade().isAPseudostate(dm)) { |
| 78 | 0 | Object k = Model.getFacade().getKind(dm); |
| 79 | 0 | if (k.equals(Model.getPseudostateKind().getChoice())) { |
| 80 | 0 | return NO_PROBLEM; |
| 81 | } | |
| 82 | 0 | if (k.equals(Model.getPseudostateKind().getJunction())) { |
| 83 | 0 | return NO_PROBLEM; |
| 84 | } | |
| 85 | } | |
| 86 | 570 | if (!Model.getFacade().isAState(dm)) { |
| 87 | 0 | return NO_PROBLEM; |
| 88 | } | |
| 89 | 570 | if (Model.getFacade().isAFinalState(dm)) { |
| 90 | 0 | return NO_PROBLEM; |
| 91 | } | |
| 92 | /* Now we are sure dm is a State. */ | |
| 93 | 570 | Object stateMachine = Model.getFacade().getStateMachine(dm); |
| 94 | 570 | if (stateMachine == null) { |
| 95 | 0 | return NO_PROBLEM; |
| 96 | } | |
| 97 | ||
| 98 | 570 | if (stateMachine != null && Model.getFacade().getTop(stateMachine) == dm) { |
| 99 | /* If dm is the top state of the statemachine, then it is | |
| 100 | * not supposed to have outgoing transitions. */ | |
| 101 | 570 | return NO_PROBLEM; |
| 102 | } | |
| 103 | ||
| 104 | 0 | Collection outgoing = Model.getFacade().getOutgoings(dm); |
| 105 | 0 | if (outgoing == null || outgoing.size() > 0) { |
| 106 | 0 | return NO_PROBLEM; |
| 107 | } | |
| 108 | ||
| 109 | 0 | if (!Model.getFacade().isACompositeState(dm)) { |
| 110 | 0 | return PROBLEM_FOUND; |
| 111 | } | |
| 112 | /* Now we are sure dm is a Composite State. */ | |
| 113 | ||
| 114 | /* Issue 689: Look for a transition that starts | |
| 115 | * at a sub-state and goes out of the composite state: */ | |
| 116 | 0 | Collection transitions = Model.getFacade().getTransitions(stateMachine); |
| 117 | 0 | for (Object t : transitions) { |
| 118 | 0 | Object sourceState = Model.getFacade().getSource(t); |
| 119 | 0 | Object targetState = Model.getFacade().getTarget(t); |
| 120 | 0 | if (isSomeSubvertexOf(sourceState, dm) && !isSomeSubvertexOf(targetState, dm)) { |
| 121 | 0 | return NO_PROBLEM; |
| 122 | } | |
| 123 | 0 | } |
| 124 | ||
| 125 | 0 | return PROBLEM_FOUND; |
| 126 | } | |
| 127 | ||
| 128 | /** | |
| 129 | * Test if a state is contained within a composite state recursively. | |
| 130 | * This is done by checking if the parent of the subject | |
| 131 | * equals the composite, or the parent of the parent, etc. | |
| 132 | * | |
| 133 | * @param subject the StateVertex that is investigated | |
| 134 | * @param composite the Composite state that may or may not contain the subject | |
| 135 | * @return true if and only if the given composite contains recursively the given subject | |
| 136 | */ | |
| 137 | private boolean isSomeSubvertexOf(Object subject, Object composite) { | |
| 138 | 0 | Object c = subject; |
| 139 | 0 | while (c != null) { |
| 140 | 0 | if (c == composite) { |
| 141 | 0 | return true; |
| 142 | } | |
| 143 | 0 | c = Model.getFacade().getContainer(c); |
| 144 | } | |
| 145 | 0 | return false; |
| 146 | } | |
| 147 | ||
| 148 | /* | |
| 149 | * @see org.argouml.uml.cognitive.critics.CrUML#getCriticizedDesignMaterials() | |
| 150 | */ | |
| 151 | public Set<Object> getCriticizedDesignMaterials() { | |
| 152 | 900 | Set<Object> ret = new HashSet<Object>(); |
| 153 | 900 | ret.add(Model.getMetaTypes().getStateVertex()); |
| 154 | 900 | return ret; |
| 155 | } | |
| 156 | ||
| 157 | } |