org.apache.shale.dialog.scxml.action.ViewAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of shale-dialog-scxml Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.shale.dialog.scxml.action;

import java.util.Collection;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.commons.scxml.ErrorReporter;
import org.apache.commons.scxml.EventDispatcher;
import org.apache.commons.scxml.SCInstance;
import org.apache.commons.scxml.SCXMLExpressionException;
import org.apache.commons.scxml.model.Action;
import org.apache.commons.scxml.model.ModelException;
import org.apache.shale.dialog.scxml.DialogProperties;
import org.apache.shale.dialog.scxml.Globals;

/**
 * Custom Commons SCXML action to set the JSF view identifier of the
 * next view to be rendered by this dialog.
 *
 * @since 1.0.4
 *
 * $Id: ViewAction.java 486006 2006-12-12 03:46:29Z rahul $
 */
public class ViewAction extends Action {

    /**
     * Set nextViewId in dialog properties, which will be the next view
     * rendered by this dialog.
     *
     * @param evtDispatcher The EventDispatcher for this execution instance
     * @param errRep        The ErrorReporter
     * @param scInstance    The state machine execution instance information
     * @param appLog        The application log
     * @param derivedEvents The collection of internal events
     * @throws ModelException If execution causes a non-deterministic state
     * @throws SCXMLExpressionException Bad expression
     */
    public void execute(EventDispatcher evtDispatcher, ErrorReporter errRep,
            SCInstance scInstance, Log appLog, Collection derivedEvents)
    throws ModelException, SCXMLExpressionException {

        DialogProperties dp = (DialogProperties) scInstance.getRootContext().
            get(Globals.DIALOG_PROPERTIES);
        dp.setNextViewId(viewId);

        if (log().isDebugEnabled()) {
            log().debug(": Setting next view ID to '" + viewId + "'");
        }

    }

    /**
     * The JSF view identifier for the next view to be rendered by
     * this dialog.
     */
    private String viewId = null;

    /**
     * Get the view identifier.
     *
     * @return The view identifier
     */
    public String getViewId() {
        return viewId;
    }

    /**
     * Set the view identifier.
     *
     * @param viewId The view identifier
     */
    public void setViewId(String viewId) {
        this.viewId = viewId;
    }

    // --------------------------------------------------------------- Logging

    /**
     * The Log instance for this class.  This value is lazily
     * instantiated, and is also transient and may need to be regenerated.
     */
    private transient Log log = null;


    /**
     * Return the Log instance for this instance.
     *
     * @return The {@link Log} instance used by this manager
     */
    private Log log() {
        if (this.log == null) {
            this.log = LogFactory.getLog(ViewAction.class);
        }
        return this.log;
    }

}