org.jvoicexml.xml.ssml.Sub Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.jvoicexml.xml Show documentation
The Open Source Voice Browser
The newest version!
/*
 * JVoiceXML - A free VoiceXML implementation.
 *
 * Copyright (C) 2005-2018 JVoiceXML group - http://jvoicexml.sourceforge.net
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library 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
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

package org.jvoicexml.xml.ssml;

import java.util.ArrayList;
import java.util.Collection;

import org.jvoicexml.xml.Text;
import org.jvoicexml.xml.VoiceXmlNode;
import org.jvoicexml.xml.XmlNode;
import org.jvoicexml.xml.XmlNodeFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Node;

/**
 * The sub element is employed to indicate that the text in the alias
 * attribute value replaces the contained text for pronunciation. This
 * allows a document to contain both a spoken and written form.
 *
 * @author Steve Doyle
 */
public final class Sub
        extends AbstractSsmlNode implements VoiceXmlNode {

    /** Name of the tag. */
    public static final String TAG_NAME = "sub";

    /**
     * Specifies the string to be spoken instead of the enclosed string.
     */
    public static final String ATTRIBUTE_ALIAS = "alias";

    /**
     * Supported attribute names for this node.
     */
    protected static final ArrayList ATTRIBUTE_NAMES;

    /**
     * Set the valid attributes for this node.
     */
    static {
        ATTRIBUTE_NAMES = new java.util.ArrayList();

        ATTRIBUTE_NAMES.add(ATTRIBUTE_ALIAS);
    }

    /**
     * Construct a new sub object without a node.
     * 
     * This is necessary for the node factory.
     * 
     *
     * @see SsmlNodeFactory
     */
    public Sub() {
        super(null);
    }

    /**
     * Construct a new sub object.
     * @param node The encapsulated node.
     */
    Sub(final Node node) {
        super(node);
    }

    /**
     * Constructs a new node.
     *
     * @param n
     *            The encapsulated node.
     * @param factory
     *            The node factory to use.
     */
    private Sub(final Node n,
            final XmlNodeFactory factory) {
        super(n, factory);
    }

    /**
     * Get the name of the tag for the derived node.
     *
     * @return name of the tag.
     */
    public String getTagName() {
        return TAG_NAME;
    }

    /**
     * {@inheritDoc}
     */
    public XmlNode newInstance(final Node n,
            final XmlNodeFactory factory) {
        return new Sub(n, factory);
    }

    /**
     * Retrieve the alias attribute.
     * @return Value of the alias attribute.
     * @see #ATTRIBUTE_ALIAS
     */
    public String getAlias() {
        return getAttribute(ATTRIBUTE_ALIAS);
    }

    /**
     * Set the alias attribute.
     * @param alias Value of the alias attribute.
     * @see #ATTRIBUTE_ALIAS
     */
    public void setAlias(final String alias) {
        setAttribute(ATTRIBUTE_ALIAS, alias);
    }

    /**
     * Create a new text within this block.
     * @param text The text to be added.
     * @return The new created text.
     */
    public Text addText(final String text) {
        final Document document = getOwnerDocument();
        final Node node = document.createTextNode(text);
        final Text textNode = new Text(node, getNodeFactory());
        appendChild(textNode);
        return textNode;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected boolean canContainChild(final String tagName) {
        return false;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Collection getAttributeNames() {
        return ATTRIBUTE_NAMES;
    }
}