// $Id: GoModelElementToContainedLostElements.java 41 2010-04-03 20:04:12Z marcusvnac $
// Copyright (c) 2006 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA 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 UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.ui.explorer.rules;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;

import org.argouml.i18n.Translator;
import org.argouml.model.Model;

/**
 * Rule for ModelElement -> Contained Lost Elements. <p>
 *
 * The Contained elements are all the elements which,
 * if the owner is deleted, will be deleted, too.
 * Lost: the context is not set, i.e. a statemachine that is
 * not attached properly.
 *
 * @author michiel
 */
public class GoModelElementToContainedLostElements
    extends AbstractPerspectiveRule {

    /*
     * @see org.argouml.ui.explorer.rules.AbstractPerspectiveRule#getRuleName()
     */
    public String getRuleName() {
        return Translator.localize(
                "misc.model-element.contained-lost-elements");
    }

    /*
     * @see org.argouml.ui.explorer.rules.AbstractPerspectiveRule#getChildren(java.lang.Object)
     */
    public Collection getChildren(Object parent) {
        Collection ret = new ArrayList();
        if (Model.getFacade().isANamespace(parent)) {
            Collection col =
                Model.getModelManagementHelper().getAllModelElementsOfKind(
                        parent,
                        Model.getMetaTypes().getStateMachine());
            Iterator it = col.iterator();
            while (it.hasNext()) {
                Object machine = it.next();
                if (Model.getFacade().getNamespace(machine) == parent) {
                    Object context = Model.getFacade().getContext(machine);
                    if (context == null) {
                        ret.add(machine);
                    }
                }
            }
        }
        return ret;
    }

    /*
     * @see org.argouml.ui.explorer.rules.PerspectiveRule#getDependencies(java.lang.Object)
     */
    public Set getDependencies(Object parent) {
        Set set = new HashSet();
        if (Model.getFacade().isANamespace(parent)) {
            set.add(parent);
        }
        return set;
    }

}