de.betterform.xml.xforms.action.DispatchAction.java Source code

Introduction

Here is the source code for de.betterform.xml.xforms.action.DispatchAction.java

Source

/*
 * Copyright (c) 2012. betterFORM Project - http://www.betterform.de
 * Licensed under the terms of BSD License
 */

package de.betterform.xml.xforms.action;

import de.betterform.xml.dom.DOMUtil;
import de.betterform.xml.ns.NamespaceConstants;
import de.betterform.xml.xforms.XFormsElement;
import de.betterform.xml.xforms.exception.XFormsBindingException;
import de.betterform.xml.xforms.exception.XFormsException;
import de.betterform.xml.xforms.model.Model;
import de.betterform.xml.xforms.model.submission.AttributeOrValueChild;
import de.betterform.xml.xpath.impl.saxon.XPathCache;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

import java.util.HashMap;
import java.util.Map;

/**
 * Implements the action as defined in <code>10.1.2 The dispatch
 * Element</code>.
 *
 * @author Ulrich Nicolas Liss&eacute;
 * @version $Id: DispatchAction.java 3457 2008-08-13 15:03:54Z joern $
 */
public class DispatchAction extends AbstractBoundAction {
    private static final Log LOGGER = LogFactory.getLog(DispatchAction.class);
    private AttributeOrValueChild eventName = null;
    private AttributeOrValueChild eventTarget = null;
    private AttributeOrValueChild delay = null;
    private boolean bubbles = true;
    private boolean cancelable = true;

    /**
     * Creates a dispatch action implementation.
     *
     * @param element the element.
     * @param model the context model.
     */
    public DispatchAction(Element element, Model model) {
        super(element, model);
    }

    // lifecycle methods

    /**
     * Performs element init.
     */
    public void init() throws XFormsException {
        super.init();

        this.eventName = new AttributeOrValueChild(this.element, this.model, NAME_ATTRIBUTE);
        this.eventName.init();

        this.eventTarget = new AttributeOrValueChild(this.element, this.model, TARGETID_ATTRIBUTE);
        this.eventTarget.init();
        if (!this.eventTarget.isAvailable()) {
            throw new XFormsBindingException(
                    "missing targetid attribute or child at " + DOMUtil.getCanonicalPath(this.getElement()),
                    this.target, null);
        }

        String bubblesAttribute = getXFormsAttribute(BUBBLES_ATTRIBUTE);
        if (bubblesAttribute != null) {
            this.bubbles = Boolean.valueOf(bubblesAttribute).booleanValue();
        }

        String cancelableAttribute = getXFormsAttribute(CANCELABLE_ATTRIBUTE);
        if (cancelableAttribute != null) {
            this.cancelable = Boolean.valueOf(cancelableAttribute).booleanValue();
        }
        this.delay = new AttributeOrValueChild(this.element, this.model, DELAY);
        this.delay.init();

    }

    // implementation of 'de.betterform.xml.xforms.action.XFormsAction'

    /**
     * Performs the <code>dispatch</code> action.
     *
     * @throws XFormsException if an error occurred during <code>dispatch</code>
     * processing.
     */
    public void perform() throws XFormsException {
        if (this.delay.getValue() != null && this.delay.getValue() != "") {
            long sleep = Long.parseLong(this.delay.getValue());
            if (LOGGER.isDebugEnabled()) {
                LOGGER.debug("dispatch action - delaying for " + sleep + " milliseconds");
            }
            try {
                Thread.sleep(sleep);
            } catch (Exception e) {
                throw new XFormsException(e);
            }
        }
        // dispatch specified event
        if (this.eventName != null) {

            NodeList nl = this.element.getElementsByTagNameNS(NamespaceConstants.XFORMS_NS, "contextinfo");
            int len = nl.getLength();
            if (len != 0) {
                updateXPathContext();
                Element e = null;
                Map map = new HashMap(len);
                String value;
                for (int i = 0; i < len; i++) {
                    e = (Element) nl.item(i);
                    value = XPathCache.getInstance().evaluateAsString(this.getNodeset(), getPosition(),
                            XFormsElement.getXFormsAttribute(e, "value"), getPrefixMapping(), xpathFunctionContext);
                    map.put(XFormsElement.getXFormsAttribute(e, "name"), value);
                }
                this.container.dispatch(this.eventTarget.getValue(), this.eventName.getValue(), map, this.bubbles,
                        this.cancelable);
                return;
            }
            this.container.dispatch(this.eventTarget.getValue(), this.eventName.getValue(), null, this.bubbles,
                    this.cancelable);
        }
    }

    /**
     * Returns the logger object.
     *
     * @return the logger object.
     */
    protected Log getLogger() {
        return LOGGER;
    }
}

// end of class