org.jvoicexml.xml.srgs.SrgsXmlDocument 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.srgs;

import java.io.IOException;

import javax.xml.parsers.ParserConfigurationException;

import org.jvoicexml.xml.SrgsNode;
import org.jvoicexml.xml.XmlDocument;
import org.jvoicexml.xml.XmlNodeFactory;
import org.jvoicexml.xml.XmlNodeList;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;

/**
 * A SRGS XML document according to the specifcation in 
 * http://www.w3.org/TR/2004/REC-speech-grammar-20040316/.
 *
 * 
 * Objects of this class can create SRGS XML grammar documents or
 * parse them.
 * 
 *
 * @author Christoph Buente
 * @author Dirk Schnelle-Walka
 */
public final class SrgsXmlDocument
        extends XmlDocument {
    /** The serial version UID. */
    private static final long serialVersionUID = -8001881520046348740L;

    /** The XmlNodefactory to use. */
    private static final transient SrgsNodeFactory NODE_FACTORY;

    static {
        NODE_FACTORY = new SrgsNodeFactory();
    }

    /**
     * Creates an empty XML Grammar Document.
     *
     * @throws ParserConfigurationException
     *         If anything goes wrong while parsing the document.
     */
    public SrgsXmlDocument()
            throws ParserConfigurationException {
        super();
    }

    /**
     * Constructs a new Grammar document from the given input source.
     *
     * @param source
     *        Input source for a single XML document.
     * @throws ParserConfigurationException
     *         Error creating the document builder.
     * @throws SAXException
     *         Error parsing the input source.
     * @throws IOException
     *         Error reading the input source.
     */
    public SrgsXmlDocument(final InputSource source)
            throws ParserConfigurationException, SAXException, IOException {
        super(source);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public XmlNodeFactory getXmlNodefactory() {
        return NODE_FACTORY;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected Node createRootNode() {
        final Document document = getDocument();
        final Node node = document.createElement(Grammar.TAG_NAME);
        return new Grammar(node);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected NodeList getXmlNodeList(final NodeList nodeList) {
        return new XmlNodeList(NODE_FACTORY, nodeList);
    }

    /**
     * Get the one and only child of this document: The grammar node.
     *
     * @return The grammar child, null if there is
     *         none.
     */
    public Grammar getGrammar() {
        NodeList grammars = getElementsByTagName(Grammar.TAG_NAME);
        if (grammars.getLength() == 0) {
            grammars = getElementsByTagNameNS("*", Grammar.TAG_NAME);
            if (grammars.getLength() == 0) {
                return null;
            }
        }

        return (Grammar) grammars.item(0);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected String getDefaultNamespaceURI() {
        return Grammar.DEFAULT_XMLNS;
    }

    /**
     * Sets the simplest grammar possible as root with the given id and text.
     * @param id the id of the grammar
     * @param text the grammar text
     * @return the grammar
     * @since 0.7.5
     */
    public Grammar setGrammarSimple(final String id, final String text) {
        final Grammar grammar = getGrammar();
        final Rule rule = grammar.appendChild(Rule.class);
        rule.addText(text);
        rule.setId(id);
        grammar.setRoot(rule);
        return grammar;
    }
}