wilos.model.spem2.iteration.Iteration.java Source code

Introduction

Here is the source code for wilos.model.spem2.iteration.Iteration.java

Source

/*
 * Wilos Is a cLever process Orchestration Software - http://wilos.berlios.de
 * Copyright (C) 2006-2007 Paul Sabatier University, IUP ISI (Toulouse, France) <massie@irit.fr>
 *
 * 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 2 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,
 * write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

package wilos.model.spem2.iteration;

import java.util.HashSet;
import java.util.Set;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

import wilos.model.misc.concreteiteration.ConcreteIteration;
import wilos.model.spem2.activity.Activity;

/**
 * Iteration is a special Activity, which prescribes pre-defined values for its instances for the attributes prefix ('Iteration') and isRepeatable ('True').
 * It has been included into the meta-model for convenience and to provide a special stereotype, because it represents a very commonly used Activity type.
 * Iteration groups a set of nested Activities that are repeated more than once. It represents an important structuring element to organize work in repetitive cycles
    
 * @author Soosuske
 *
 */
public class Iteration extends Activity implements Cloneable {

    private Set<ConcreteIteration> concreteIterations;

    /**
     * Default constructor
     *
     */
    public Iteration() {
        super();
        this.concreteIterations = new HashSet<ConcreteIteration>();
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#clone()
     */
    @Override
    public Iteration clone() throws CloneNotSupportedException {
        Iteration iteration = new Iteration();
        iteration.copy(this);
        return iteration;
    }

    /**
     * Copy the object.
     *
     * @param _iteration
     *            The iteration to copy.
     */
    protected void copy(final Iteration _iteration) {
        super.copy(_iteration);
        this.concreteIterations.addAll(_iteration.getConcreteIterations());
    }

    /*
     * (non-Javadoc)
     *
     * @see woops2.model.activity.Activity#equals(java.lang.Object)
     */
    public boolean equals(Object obj) {
        if (obj instanceof Iteration == false) {
            return false;
        }
        if (this == obj) {
            return true;
        }
        Iteration iteration = (Iteration) obj;
        return new EqualsBuilder().appendSuper(super.equals(iteration)).isEquals();
    }

    /*
     * (non-Javadoc)
     *
     * @see woops2.model.activity.Activity#hashCode()
     */
    public int hashCode() {
        return new HashCodeBuilder(17, 37).appendSuper(super.hashCode()).toHashCode();
    }

    /**
     * Add a concreteIteration to an iteration
     *
     * @param _concreteIteration
     */
    public void addConcreteIteration(ConcreteIteration _concreteIteration) {
        this.concreteIterations.add(_concreteIteration);
        _concreteIteration.setIteration(this);
    }

    /**
     * Add a concreteIteration collection to the concreteIteration collection of a
     * Iteration
     *
     * @param _concreteIteration
     */
    public void addAllConcreteIterations(Set<ConcreteIteration> _concreteIterations) {
        for (ConcreteIteration ci : _concreteIterations) {
            ci.addIteration(this);
        }
    }

    /**
     * Remove a concreteIteration to its iteration
     *
     * @param _concreteIteration
     */
    public void removeConcreteIteration(ConcreteIteration _concreteIteration) {
        _concreteIteration.setIteration(null);
        this.concreteIterations.remove(_concreteIteration);
    }

    /**
     * Remove all concreteIterations to its iteration
     */
    public void removeAllConcreteIterations() {
        for (ConcreteIteration tmp : this.concreteIterations) {
            tmp.setIteration(null);
        }
        this.concreteIterations.clear();
    }

    /**
     *
     * @return
     */
    public Set<ConcreteIteration> getConcreteIterations() {
        return concreteIterations;
    }

    /**
     *
     * @param _concreteIterations
     */
    public void setConcreteIterations(Set<ConcreteIteration> _concreteIterations) {
        this.concreteIterations = _concreteIterations;
    }

}