[Castore-commits] Workflow.java NONE 1.1

[Céline BENOIT]

Update of /cvsroot/castore/castore-core/src/java/fr/emn/castor/documents/metier/docGenerique/workflow
In directory adullact1:/tmp/cvs-serv25067/src/java/fr/emn/castor/documents/metier/docGenerique/workflow

Added Files:
	Workflow.java 
Log Message:
déplacement du fichier 

--- NEW FILE: Workflow.java ---
/*
 * $Id: Workflow.java,v 1.1 2006/03/22 13:37:22 cbenoit Exp $
 *
 * Plateforme CASTORE
 * CeCILL Copyright (C) 2005-2006 by EMN
 * Made by Stéphane Bouchet, Olivier Grouhan, Vanessa Bergere
 * Web site = http://www.emn.fr/castore
 * Contact = Cédric Dumas, e-mail = Cedric.Dumas at emn.fr
 *
 * Version 1.0 (1er mars 2005)
 *
 * Ce logiciel est un programme informatique servant à créer une plateforme
 * open-source de bibliothèque numérique XML pour Conserver, Valoriser et
 * Diffuser le patrimoine documentaire de votre institut.
 *
 * Ce logiciel est régi par la licence CeCILL soumise au droit français et
 * respectant les principes de diffusion des logiciels libres. Vous pouvez
 * utiliser, modifier et/ou redistribuer ce programme sous les conditions de la
 * licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA sur le site
 * "http://www.cecill.info". En contrepartie de l'accessibilité au code source
 * et des droits de copie, de modification et de redistribution accordés par
 * cette licence, il n'est offert aux utilisateurs qu'une garantie limitée. Pour
 * les mêmes raisons, seule une responsabilité restreinte pèse sur l'auteur du
 * programme, le titulaire des droits patrimoniaux et les concédants successifs.
 * A cet égard l'attention de l'utilisateur est attirée sur les risques associés
 * au chargement, à l'utilisation, à la modification et/ou au développement et à
 * la reproduction du logiciel par l'utilisateur étant donné sa spécificité de
 * logiciel libre, qui peut le rendre complexe à manipuler et qui le réserve
 * donc à des développeurs et des professionnels avertis possédant des
 * connaissances informatiques approfondies. Les utilisateurs sont donc invités
 * à charger et tester l'adéquation du logiciel à leurs besoins dans des
 * conditions permettant d'assurer la sécurité de leurs systèmes et ou de leurs
 * données et, plus généralement, à l'utiliser et l'exploiter dans les mêmes
 * conditions de sécurité. Le fait que vous puissiez accéder à cet en-tête
 * signifie que vous avez pris connaissance de la licence CeCILL, et que vous en
 * avez accepté les termes.
 *
 */
package fr.emn.castor.documents.metier.docGenerique.workflow;

import java.util.ArrayList;
import java.util.Iterator;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Classe representant un worflow.
 * 
 * @author $Author: cbenoit $
 * @version $Revision: 1.1 $
 */
public class Workflow {

    /** Le logger. */
    private static Log log = LogFactory.getLog(Workflow.class);

    /** l'identifiant du workflow. */
    private String id;

    /** les etapes. */
    protected ArrayList steps;

    /** La cle pour l'identifiant de l'etape. */
    public final static String STEP_NUMBER = "Stepnumber";

    /**
     * Constructeur.
     * 
     * @param aId
     *            l'identifiant du workflow.
     */
    public Workflow(final String aId) {
        this.id = aId;
        this.steps = new ArrayList();
    }

    /**
     * Constructeur.
     */
    private Workflow() {
        //rien !
    }

    /**
     * @return Renvoie id.
     */
    public String getId() {
        return this.id;
    }

    /**
     * @param aId id à définir.
     */
    public void setId(String aId) {
        this.id = aId;
    }

    /**
     * Methode ajoutant une etape au workflow.
     * 
     * @param stepNumber
     *            le numero de l'etape.
     */
    public void addStep(final int stepNumber) {
        WorkflowStep step = new WorkflowStep();
        // on verifie que l'etape n'est pas deja renseignée.
        // ie qu'il n'existe pas 2 etapes "1"..
        try {
            if (this.steps.get(stepNumber - 1) != null) {
                if (log.isErrorEnabled()) {
                    log.error("L'etape " + stepNumber
                            + " est déja définie pour ce workflow.");
                }
                return;
            }
        } catch (IndexOutOfBoundsException ioobe) {
            // on est dans le cas ou l'index demandé n'existe pas dans la liste
            // donc ok, on peux rajouter une etape
        }
        this.steps.add(stepNumber - 1, step);
    }

    /**
     * Renvoie l'etape correspondante au nombre passé en parametre.
     * 
     * @param stepNumber
     * @return l'etape correspondante
     */
    public WorkflowStep getStep(final int stepNumber) {
        try {
            if (this.steps.get(stepNumber - 1) != null) {
                return (WorkflowStep) this.steps.get(stepNumber - 1);
            }
            if (log.isErrorEnabled()) {
                log.error("Pas d'étape correspondant au numero "
                        + stepNumber);
            }
        } catch (IndexOutOfBoundsException ioobe) {
            // sert lorsque l'on veux retrouver la prochaine etape alors
            // que l'on est deja a la derniere.
        }
        return null;
    }

    //    public void setStep(final int stepNumber){
    //        
    //    }

    /**
     * Renvoie le nombre total d'etape pour ce workflow.
     * 
     * @return le nombre d'etapes de ce workflow.
     */
    public int getNumberOfSteps() {
        return this.steps.size();
    }

    /**
     * Construit un worklow spécifique.
     * 
     * @param workflowBase
     *            base pour le workflow
     * @param docId
     *            id du document
     */
    private Workflow(Workflow workflowBase) {
        this(workflowBase.getId());
        int numEtape = 1;
        WorkflowStep etape = workflowBase.getStep(numEtape);
        while (etape != null) {
            this.addStep(etape);
            etape = workflowBase.getStep(++numEtape);
        }

    }

    /**
     * Ajout et clonage d'une etape.
     * 
     * @param step
     *            etape a ajouter
     */
    private void addStep(WorkflowStep step) {
        //copie de l'etape
        WorkflowStep newStep = new WorkflowStep();
        newStep.setValidationType(step.getValidationType());
        Iterator validateurs = step.getValidateurs().iterator();
        while (validateurs.hasNext()) {
            newStep.addValidateur((String) validateurs.next());
        }
        Iterator validateursLink = step.getValidateursLink().iterator();
        while (validateursLink.hasNext()) {
            newStep.addValidateurLink((String) validateursLink.next());
        }

        this.steps.add(newStep);
    }

    /**
     * Clonage du workflow.
     * @return copie du workflow.
     */
    public Workflow cloneWorkflow() {
        return new Workflow(this);
    }

}