/*
 * The Relaxer artifact
 * Copyright (c) 2000-2004, ASAMI Tomoharu, All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer. 
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package org.doubletype.ossa.xml;

import java.io.*;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.Writer;
import java.net.URL;
import javax.xml.parsers.*;
import org.w3c.dom.*;
import org.xml.sax.*;

/**
 * <b>XModule</b> is generated from glyph.rng by Relaxer.
 * This class is derived from:
 * 
 * <!-- for programmer
 * <element name="module" ns="http://doubletype.org/ns/glyph/0.0">
 * 			<attribute name="name"/>
 * 			<ref name="invoke"/>
 * 			<oneOrMore>
 * 				<ref name="contourPoint"/>
 * 			</oneOrMore>
 * 		</element>-->
 * <!-- for javadoc -->
 * <pre> &lt;element name="module" ns="http://doubletype.org/ns/glyph/0.0"&gt;
 * 			&lt;attribute name="name"/&gt;
 * 			&lt;ref name="invoke"/&gt;
 * 			&lt;oneOrMore&gt;
 * 				&lt;ref name="contourPoint"/&gt;
 * 			&lt;/oneOrMore&gt;
 * 		&lt;/element&gt;</pre>
 *
 * @version glyph.rng (Tue Nov 09 20:22:48 EST 2004)
 * @author  Relaxer 1.1b (http://www.relaxer.org)
 */
@SuppressWarnings("all")
public class XModule implements java.io.Serializable, Cloneable, IRNode {
    private String name_;
    private XInvoke invoke_;
    // List<XContourPoint>
    private java.util.List<XContourPoint> contourPoint_ = new java.util.ArrayList<>();
    private IRNode parentRNode_;

    /**
     * Creates a <code>XModule</code>.
     *
     */
    public XModule() {
        name_ = "";
    }

    /**
     * Creates a <code>XModule</code>.
     *
     * @param source
     */
    public XModule(XModule source) {
        setup(source);
    }

    /**
     * Creates a <code>XModule</code> by the Stack <code>stack</code>
     * that contains Elements.
     * This constructor is supposed to be used internally
     * by the Relaxer system.
     *
     * @param stack
     */
    public XModule(RStack stack) {
        setup(stack);
    }

    /**
     * Creates a <code>XModule</code> by the Document <code>doc</code>.
     *
     * @param doc
     */
    public XModule(Document doc) {
        setup(doc.getDocumentElement());
    }

    /**
     * Creates a <code>XModule</code> by the Element <code>element</code>.
     *
     * @param element
     */
    public XModule(Element element) {
        setup(element);
    }

    /**
     * Creates a <code>XModule</code> by the File <code>file</code>.
     *
     * @param file
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public XModule(File file) throws IOException, SAXException, ParserConfigurationException {
        setup(file);
    }

    /**
     * Creates a <code>XModule</code>
     * by the String representation of URI <code>uri</code>.
     *
     * @param uri
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public XModule(String uri) throws IOException, SAXException, ParserConfigurationException {
        setup(uri);
    }

    /**
     * Creates a <code>XModule</code> by the URL <code>url</code>.
     *
     * @param url
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public XModule(URL url) throws IOException, SAXException, ParserConfigurationException {
        setup(url);
    }

    /**
     * Creates a <code>XModule</code> by the InputStream <code>in</code>.
     *
     * @param in
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public XModule(InputStream in) throws IOException, SAXException, ParserConfigurationException {
        setup(in);
    }

    /**
     * Creates a <code>XModule</code> by the InputSource <code>is</code>.
     *
     * @param is
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public XModule(InputSource is) throws IOException, SAXException, ParserConfigurationException {
        setup(is);
    }

    /**
     * Creates a <code>XModule</code> by the Reader <code>reader</code>.
     *
     * @param reader
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public XModule(Reader reader) throws IOException, SAXException, ParserConfigurationException {
        setup(reader);
    }

    /**
     * Initializes the <code>XModule</code> by the XModule <code>source</code>.
     *
     * @param source
     */
    public void setup(XModule source) {
        int size;
        name_ = source.name_;
        if (source.invoke_ != null) {
            setInvoke((XInvoke)source.getInvoke().clone());
        }
        this.contourPoint_.clear();
        size = source.contourPoint_.size();
        for (int i = 0;i < size;i++) {
            addContourPoint((XContourPoint)source.getContourPoint(i).clone());
        }
    }

    /**
     * Initializes the <code>XModule</code> by the Document <code>doc</code>.
     *
     * @param doc
     */
    public void setup(Document doc) {
        setup(doc.getDocumentElement());
    }

    /**
     * Initializes the <code>XModule</code> by the Element <code>element</code>.
     *
     * @param element
     */
    public void setup(Element element) {
        init(element);
    }

    /**
     * Initializes the <code>XModule</code> by the Stack <code>stack</code>
     * that contains Elements.
     * This constructor is supposed to be used internally
     * by the Relaxer system.
     *
     * @param stack
     */
    public void setup(RStack stack) {
        init(stack.popElement());
    }

    /**
     * @param element
     */
    private void init(Element element) {
        IGlyphFactory factory = GlyphFactory.getFactory();
        RStack stack = new RStack(element);
        name_ = URelaxer.getAttributePropertyAsString(element, "name");
        setInvoke(factory.createXInvoke(stack));
        contourPoint_.clear();
        while (true) {
            if (XContourPoint.isMatch(stack)) {
                addContourPoint(factory.createXContourPoint(stack));
            } else {
                break;
            }
        }
    }

    /**
     * @return Object
     */
    public Object clone() {
        IGlyphFactory factory = GlyphFactory.getFactory();
        return (factory.createXModule((XModule)this));
    }

    /**
     * Creates a DOM representation of the object.
     * Result is appended to the Node <code>parent</code>.
     *
     * @param parent
     */
    public void makeElement(Node parent) {
        Document doc;
        if (parent instanceof Document) {
            doc = (Document)parent;
        } else {
            doc = parent.getOwnerDocument();
        }
        Element element = doc.createElement("module");
        int size;
        if (this.name_ != null) {
            URelaxer.setAttributePropertyByString(element, "name", this.name_);
        }
        this.invoke_.makeElement(element);
        size = this.contourPoint_.size();
        for (int i = 0;i < size;i++) {
            XContourPoint value = (XContourPoint)this.contourPoint_.get(i);
            value.makeElement(element);
        }
        parent.appendChild(element);
    }

    /**
     * Initializes the <code>XModule</code> by the File <code>file</code>.
     *
     * @param file
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public void setup(File file) throws IOException, SAXException, ParserConfigurationException {
        setup(file.toURI().toURL());
    }

    /**
     * Initializes the <code>XModule</code>
     * by the String representation of URI <code>uri</code>.
     *
     * @param uri
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public void setup(String uri) throws IOException, SAXException, ParserConfigurationException {
        setup(UJAXP.getDocument(uri, UJAXP.FLAG_NONE));
    }

    /**
     * Initializes the <code>XModule</code> by the URL <code>url</code>.
     *
     * @param url
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public void setup(URL url) throws IOException, SAXException, ParserConfigurationException {
        setup(UJAXP.getDocument(url, UJAXP.FLAG_NONE));
    }

    /**
     * Initializes the <code>XModule</code> by the InputStream <code>in</code>.
     *
     * @param in
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public void setup(InputStream in) throws IOException, SAXException, ParserConfigurationException {
        setup(UJAXP.getDocument(in, UJAXP.FLAG_NONE));
    }

    /**
     * Initializes the <code>XModule</code> by the InputSource <code>is</code>.
     *
     * @param is
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public void setup(InputSource is) throws IOException, SAXException, ParserConfigurationException {
        setup(UJAXP.getDocument(is, UJAXP.FLAG_NONE));
    }

    /**
     * Initializes the <code>XModule</code> by the Reader <code>reader</code>.
     *
     * @param reader
     * @exception IOException
     * @exception SAXException
     * @exception ParserConfigurationException
     */
    public void setup(Reader reader) throws IOException, SAXException, ParserConfigurationException {
        setup(UJAXP.getDocument(reader, UJAXP.FLAG_NONE));
    }

    /**
     * Creates a DOM document representation of the object.
     *
     * @exception ParserConfigurationException
     * @return Document
     */
    public Document makeDocument() throws ParserConfigurationException {
        Document doc = UJAXP.makeDocument();
        makeElement(doc);
        return (doc);
    }

    /**
     * Gets the String property <b>name</b>.
     *
     * @return String
     */
    public String getName() {
        return (name_);
    }

    /**
     * Sets the String property <b>name</b>.
     *
     * @param name
     */
    public void setName(String name) {
        this.name_ = name;
    }

    /**
     * Gets the XInvoke property <b>invoke</b>.
     *
     * @return XInvoke
     */
    public XInvoke getInvoke() {
        return (invoke_);
    }

    /**
     * Sets the XInvoke property <b>invoke</b>.
     *
     * @param invoke
     */
    public void setInvoke(XInvoke invoke) {
        this.invoke_ = invoke;
        if (invoke != null) {
            invoke.rSetParentRNode(this);
        }
    }

    /**
     * Gets the XContourPoint property <b>contourPoint</b>.
     *
     * @return XContourPoint[]
     */
    public XContourPoint[] getContourPoint() {
        XContourPoint[] array = new XContourPoint[contourPoint_.size()];
        return ((XContourPoint[])contourPoint_.toArray(array));
    }

    /**
     * Sets the XContourPoint property <b>contourPoint</b>.
     *
     * @param contourPoint
     */
    public void setContourPoint(XContourPoint[] contourPoint) {
        this.contourPoint_.clear();
        for (int i = 0;i < contourPoint.length;i++) {
            addContourPoint(contourPoint[i]);
        }
        for (int i = 0;i < contourPoint.length;i++) {
            contourPoint[i].rSetParentRNode(this);
        }
    }

    /**
     * Sets the XContourPoint property <b>contourPoint</b>.
     *
     * @param contourPoint
     */
    public void setContourPoint(XContourPoint contourPoint) {
        this.contourPoint_.clear();
        addContourPoint(contourPoint);
        if (contourPoint != null) {
            contourPoint.rSetParentRNode(this);
        }
    }

    /**
     * Adds the XContourPoint property <b>contourPoint</b>.
     *
     * @param contourPoint
     */
    public void addContourPoint(XContourPoint contourPoint) {
        this.contourPoint_.add(contourPoint);
        if (contourPoint != null) {
            contourPoint.rSetParentRNode(this);
        }
    }

    /**
     * Adds the XContourPoint property <b>contourPoint</b>.
     *
     * @param contourPoint
     */
    public void addContourPoint(XContourPoint[] contourPoint) {
        for (int i = 0;i < contourPoint.length;i++) {
            addContourPoint(contourPoint[i]);
        }
        for (int i = 0;i < contourPoint.length;i++) {
            contourPoint[i].rSetParentRNode(this);
        }
    }

    /**
     * Gets number of the XContourPoint property <b>contourPoint</b>.
     *
     * @return int
     */
    public int sizeContourPoint() {
        return (contourPoint_.size());
    }

    /**
     * Gets the XContourPoint property <b>contourPoint</b> by index.
     *
     * @param index
     * @return XContourPoint
     */
    public XContourPoint getContourPoint(int index) {
        return ((XContourPoint)contourPoint_.get(index));
    }

    /**
     * Sets the XContourPoint property <b>contourPoint</b> by index.
     *
     * @param index
     * @param contourPoint
     */
    public void setContourPoint(int index, XContourPoint contourPoint) {
        this.contourPoint_.set(index, contourPoint);
        if (contourPoint != null) {
            contourPoint.rSetParentRNode(this);
        }
    }

    /**
     * Adds the XContourPoint property <b>contourPoint</b> by index.
     *
     * @param index
     * @param contourPoint
     */
    public void addContourPoint(int index, XContourPoint contourPoint) {
        this.contourPoint_.add(index, contourPoint);
        if (contourPoint != null) {
            contourPoint.rSetParentRNode(this);
        }
    }

    /**
     * Remove the XContourPoint property <b>contourPoint</b> by index.
     *
     * @param index
     */
    public void removeContourPoint(int index) {
        this.contourPoint_.remove(index);
    }

    /**
     * Remove the XContourPoint property <b>contourPoint</b> by object.
     *
     * @param contourPoint
     */
    public void removeContourPoint(XContourPoint contourPoint) {
        this.contourPoint_.remove(contourPoint);
    }

    /**
     * Clear the XContourPoint property <b>contourPoint</b>.
     *
     */
    public void clearContourPoint() {
        this.contourPoint_.clear();
    }

    /**
     * Makes an XML text representation.
     *
     * @return String
     */
    public String makeTextDocument() {
        StringBuffer buffer = new StringBuffer();
        makeTextElement(buffer);
        return (new String(buffer));
    }

    /**
     * Makes an XML text representation.
     *
     * @param buffer
     */
    public void makeTextElement(StringBuffer buffer) {
        int size;
        buffer.append("<module");
        if (name_ != null) {
            buffer.append(" name=\"");
            buffer.append(URelaxer.escapeAttrQuot(URelaxer.getString(getName())));
            buffer.append("\"");
        }
        buffer.append(">");
        invoke_.makeTextElement(buffer);
        size = this.contourPoint_.size();
        for (int i = 0;i < size;i++) {
            XContourPoint value = (XContourPoint)this.contourPoint_.get(i);
            value.makeTextElement(buffer);
        }
        buffer.append("</module>");
    }

    /**
     * Makes an XML text representation.
     *
     * @param buffer
     * @exception IOException
     */
    public void makeTextElement(Writer buffer) throws IOException {
        int size;
        buffer.write("<module");
        if (name_ != null) {
            buffer.write(" name=\"");
            buffer.write(URelaxer.escapeAttrQuot(URelaxer.getString(getName())));
            buffer.write("\"");
        }
        buffer.write(">");
        invoke_.makeTextElement(buffer);
        size = this.contourPoint_.size();
        for (int i = 0;i < size;i++) {
            XContourPoint value = (XContourPoint)this.contourPoint_.get(i);
            value.makeTextElement(buffer);
        }
        buffer.write("</module>");
    }

    /**
     * Makes an XML text representation.
     *
     * @param buffer
     */
    public void makeTextElement(PrintWriter buffer) {
        int size;
        buffer.print("<module");
        if (name_ != null) {
            buffer.print(" name=\"");
            buffer.print(URelaxer.escapeAttrQuot(URelaxer.getString(getName())));
            buffer.print("\"");
        }
        buffer.print(">");
        invoke_.makeTextElement(buffer);
        size = this.contourPoint_.size();
        for (int i = 0;i < size;i++) {
            XContourPoint value = (XContourPoint)this.contourPoint_.get(i);
            value.makeTextElement(buffer);
        }
        buffer.print("</module>");
    }

    /**
     * Makes an XML text representation.
     *
     * @param buffer
     */
    public void makeTextAttribute(StringBuffer buffer) {
    }

    /**
     * Makes an XML text representation.
     *
     * @param buffer
     * @exception IOException
     */
    public void makeTextAttribute(Writer buffer) throws IOException {
    }

    /**
     * Makes an XML text representation.
     *
     * @param buffer
     */
    public void makeTextAttribute(PrintWriter buffer) {
    }

    /**
     * Gets the property value as String.
     *
     * @return String
     */
    public String getNameAsString() {
        return (URelaxer.getString(getName()));
    }

    /**
     * Sets the property value by String.
     *
     * @param string
     */
    public void setNameByString(String string) {
        setName(string);
    }

    /**
     * Returns a String representation of this object.
     * While this method informs as XML format representaion, 
     *  it's purpose is just information, not making 
     * a rigid XML documentation.
     *
     * @return String
     */
    public String toString() {
        try {
            return (makeTextDocument());
        } catch (Exception e) {
            return (super.toString());
        }
    }

    /**
     * Gets the IRNode property <b>parentRNode</b>.
     *
     * @return IRNode
     */
    public IRNode rGetParentRNode() {
        return (parentRNode_);
    }

    /**
     * Sets the IRNode property <b>parentRNode</b>.
     *
     * @param parentRNode
     */
    public void rSetParentRNode(IRNode parentRNode) {
        this.parentRNode_ = parentRNode;
    }

    /**
     * Gets child RNodes.
     *
     * @return IRNode[]
     */
    public IRNode[] rGetRNodes() {
        java.util.List<IRNode> classNodes = new java.util.ArrayList<>();
        if (invoke_ != null) {
            classNodes.add(invoke_);
        }
        classNodes.addAll(contourPoint_);
        IRNode[] nodes = new IRNode[classNodes.size()];
        return ((IRNode[])classNodes.toArray(nodes));
    }

    /**
     * Tests if a Element <code>element</code> is valid
     * for the <code>XModule</code>.
     *
     * @param element
     * @return boolean
     */
    public static boolean isMatch(Element element) {
        if (!URelaxer.isTargetElement(element, "module")) {
            return (false);
        }
        RStack target = new RStack(element);
        boolean $match$ = false;
        IGlyphFactory factory = GlyphFactory.getFactory();
        Element child;
        if (!URelaxer.hasAttributeHungry(target, "name")) {
            return (false);
        }
        $match$ = true;
        if (!XInvoke.isMatchHungry(target)) {
            return (false);
        }
        $match$ = true;
        if (!XContourPoint.isMatchHungry(target)) {
            return (false);
        }
        $match$ = true;
        while (true) {
            if (!XContourPoint.isMatchHungry(target)) {
                break;
            }
            $match$ = true;
        }
        if (!target.isEmptyElement()) {
            return (false);
        }
        return (true);
    }

    /**
     * Tests if elements contained in a Stack <code>stack</code>
     * is valid for the <code>XModule</code>.
     * This mehtod is supposed to be used internally
     * by the Relaxer system.
     *
     * @param stack
     * @return boolean
     */
    public static boolean isMatch(RStack stack) {
        Element element = stack.peekElement();
        if (element == null) {
            return (false);
        }
        return (isMatch(element));
    }

    /**
     * Tests if elements contained in a Stack <code>stack</code>
     * is valid for the <code>XModule</code>.
     * This method consumes the stack contents during matching operation.
     * This mehtod is supposed to be used internally
     * by the Relaxer system.
     *
     * @param stack
     * @return boolean
     */
    public static boolean isMatchHungry(RStack stack) {
        Element element = stack.peekElement();
        if (element == null) {
            return (false);
        }
        if (isMatch(element)) {
            stack.popElement();
            return (true);
        } else {
            return (false);
        }
    }
}
