/*
 * $Header: /src/cvs/jakarta-local/org/apache/commons/workflow/core/CoreRuleSet.java,v 1.1 2001/11/13 22:57:04 db2admin Exp $
 * $Revision: 1.1 $
 * $Date: 2001/11/13 22:57:04 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */


package org.apache.commons.workflow.core;


import org.apache.commons.digester.Digester;
import org.apache.commons.workflow.base.BaseRuleSet;


/**
 * <p><strong>RuleSet</strong> for the Step definitions supported by the
 * <em>core</em> library.  This library is normally associated with the
 * following namespace URI:</p>
 * <pre>
 *   http://jakarta.apache.org/commons/workflow/core
 * </pre>
 *
 * @author Craig R. McClanahan
 * @version $Revision: 1.1 $ $Date: 2001/11/13 22:57:04 $
 */

public class CoreRuleSet extends BaseRuleSet {


    // ------------------------------------------------------------ Constructor


    /**
     * Construct a default instance of the <code>RuleSet</code>.
     */
    public CoreRuleSet() {

        super();
        setPrefix("activity/");
        setNamespaceURI("http://jakarta.apache.org/commons/workflow/core");

    }


    // --------------------------------------------------------- Public Methods


    /**
     * <p>Add the set of Rule instances defined in this RuleSet to the
     * specified <code>Digester</code> instance, associating them with
     * our namespace URI (if any).  This method should only be called
     * by a Digester instance.</p>
     *
     * @param digester Digester instance to which the new Rule instances
     *  should be added.
     */
    public void addRuleInstances(Digester digester) {

        digester.addObjectCreate
            (prefix + "and",
             "org.apache.commons.workflow.core.AndStep");
        digester.addSetProperties
            (prefix + "and");
        digester.addSetNext
            (prefix + "and", "addStep",
             "org.apache.commons.workflow.Step");
        digester.addObjectCreate
            (prefix + "and/descriptor",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "and/descriptor");
        digester.addSetNext
            (prefix + "and/descriptor", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");

        digester.addObjectCreate
            (prefix + "call",
             "org.apache.commons.workflow.core.CallStep");
        digester.addSetProperties
            (prefix + "call");
        digester.addSetNext
            (prefix + "call", "addStep",
             "org.apache.commons.workflow.Step");

        // First descriptor can be called "class" for clarity
        digester.addObjectCreate
            (prefix + "construct",
             "org.apache.commons.workflow.core.ConstructStep");
        digester.addSetProperties
            (prefix + "construct");
        digester.addSetNext
            (prefix + "construct", "addStep",
             "org.apache.commons.workflow.Step");
        digester.addObjectCreate
            (prefix + "construct/class",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "construct/class");
        digester.addSetNext
            (prefix + "construct/class", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");
        digester.addObjectCreate
            (prefix + "construct/descriptor",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "construct/descriptor");
        digester.addSetNext
            (prefix + "construct/descriptor", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");

        digester.addObjectCreate
            (prefix + "duplicate",
             "org.apache.commons.workflow.core.DuplicateStep");
        digester.addSetProperties
            (prefix + "duplicate");
        digester.addSetNext
            (prefix + "duplicate", "addStep",
             "org.apache.commons.workflow.Step");

        digester.addObjectCreate
            (prefix + "exit",
             "org.apache.commons.workflow.core.ExitStep");
        digester.addSetProperties
            (prefix + "exit");
        digester.addSetNext
            (prefix + "exit", "addStep",
             "org.apache.commons.workflow.Step");

        digester.addObjectCreate
            (prefix + "get",
             "org.apache.commons.workflow.core.GetStep");
        digester.addSetProperties
            (prefix + "get");
        digester.addSetNext
            (prefix + "get", "addStep",
             "org.apache.commons.workflow.Step");
        digester.addObjectCreate
            (prefix + "get/descriptor",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "get/descriptor");
        digester.addSetNext
            (prefix + "get/descriptor", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");

        digester.addObjectCreate
            (prefix + "goto",
             "org.apache.commons.workflow.core.GotoStep");
        digester.addSetProperties
            (prefix + "goto");
        digester.addSetNext
            (prefix + "goto", "addStep",
             "org.apache.commons.workflow.Step");

        // First "descriptor" can be called "bean" for clarity
        digester.addObjectCreate
            (prefix + "invoke",
             "org.apache.commons.workflow.core.InvokeStep");
        digester.addSetProperties
            (prefix + "invoke");
        digester.addSetNext
            (prefix + "invoke", "addStep",
             "org.apache.commons.workflow.Step");
        digester.addObjectCreate
            (prefix + "invoke/bean",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "invoke/bean");
        digester.addSetNext
            (prefix + "invoke/bean", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");
        digester.addObjectCreate
            (prefix + "invoke/descriptor",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "invoke/descriptor");
        digester.addSetNext
            (prefix + "invoke/descriptor", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");

        digester.addObjectCreate
            (prefix + "load",
             "org.apache.commons.workflow.core.LoadStep");
        digester.addSetProperties
            (prefix + "load");
        digester.addSetNext
            (prefix + "load", "addStep",
             "org.apache.commons.workflow.Step");

        // Added 14 Nov 2001 - pksiv

        digester.addObjectCreate
            (prefix + "andNot",
             "org.apache.commons.workflow.core.AndNotStep");
        digester.addSetProperties
            (prefix + "andNot");
        digester.addSetNext
            (prefix + "andNot", "addStep",
             "org.apache.commons.workflow.Step");
        digester.addObjectCreate
            (prefix + "andNot/descriptor",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "andNot/descriptor");
        digester.addSetNext
            (prefix + "andNot/descriptor", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");        
            
        digester.addObjectCreate
            (prefix + "notOr",
             "org.apache.commons.workflow.core.OrStep");
        digester.addSetProperties
            (prefix + "notOr");
        digester.addSetNext
            (prefix + "notOr", "addStep",
             "org.apache.commons.workflow.Step");
        digester.addObjectCreate
            (prefix + "notOr/descriptor",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "notOr/descriptor");
        digester.addSetNext
            (prefix + "notOr/descriptor", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");            
             
        digester.addObjectCreate
            (prefix + "or",
             "org.apache.commons.workflow.core.OrStep");
        digester.addSetProperties
            (prefix + "or");
        digester.addSetNext
            (prefix + "or", "addStep",
             "org.apache.commons.workflow.Step");
        digester.addObjectCreate
            (prefix + "or/descriptor",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "or/descriptor");
        digester.addSetNext
            (prefix + "or/descriptor", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");

        digester.addObjectCreate
            (prefix + "pop",
             "org.apache.commons.workflow.core.PopStep");
        digester.addSetProperties
            (prefix + "pop");
        digester.addSetNext
            (prefix + "pop", "addStep",
             "org.apache.commons.workflow.Step");

        digester.addObjectCreate
            (prefix + "put",
             "org.apache.commons.workflow.core.PutStep");
        digester.addSetProperties
            (prefix + "put");
        digester.addSetNext
            (prefix + "put", "addStep",
             "org.apache.commons.workflow.Step");
        digester.addObjectCreate
            (prefix + "put/descriptor",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "put/descriptor");
        digester.addSetNext
            (prefix + "put/descriptor", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");

        digester.addObjectCreate
            (prefix + "remove",
             "org.apache.commons.workflow.core.RemoveStep");
        digester.addSetProperties
            (prefix + "remove");
        digester.addSetNext
            (prefix + "remove", "addStep",
             "org.apache.commons.workflow.Step");
        digester.addObjectCreate
            (prefix + "remove/descriptor",
             "org.apache.commons.workflow.base.BaseDescriptor");
        digester.addSetProperties
            (prefix + "remove/descriptor");
        digester.addSetNext
            (prefix + "remove/descriptor", "addDescriptor",
             "org.apache.commons.workflow.Descriptor");

        digester.addObjectCreate
            (prefix + "string",
             "org.apache.commons.workflow.core.StringStep");
        digester.addSetProperties
            (prefix + "string");
        digester.addSetNext
            (prefix + "string", "addStep",
             "org.apache.commons.workflow.Step");

        digester.addObjectCreate
            (prefix + "suspend",
             "org.apache.commons.workflow.core.SuspendStep");
        digester.addSetProperties
            (prefix + "suspend");
        digester.addSetNext
            (prefix + "suspend", "addStep",
             "org.apache.commons.workflow.Step");

        digester.addObjectCreate
            (prefix + "swap",
             "org.apache.commons.workflow.core.SwapStep");
        digester.addSetProperties
            (prefix + "swap");
        digester.addSetNext
            (prefix + "swap", "addStep",
             "org.apache.commons.workflow.Step");

    }


}
