/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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 General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.tools.internal.xjc.reader.internalizer;

import java.util.Set;

import com.sun.tools.internal.xjc.reader.Const;

import com.sun.xml.internal.bind.marshaller.SAX2DOMEx;

import org.w3c.dom.Document;

import org.w3c.dom.Element;

import org.w3c.dom.Node;

import org.xml.sax.Attributes;

import org.xml.sax.Locator;

/**

 * Builds DOM while keeping the location information.

 *

 * <p>

 * This class also looks for outer most <jaxb:bindings>

 * customizations.

 *

 * @author

 *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

 */

class DOMBuilder extends SAX2DOMEx {

    /**

     * Grows a DOM tree under the given document, and

     * stores location information to the given table.

     *

     * @param outerMostBindings

     *      This set will receive newly found outermost

     *      jaxb:bindings customizations.

     */

    public DOMBuilder( Document dom, LocatorTable ltable, Set outerMostBindings ) {

        super( dom );

        this.locatorTable = ltable;

        this.outerMostBindings = outerMostBindings;

    }

    /** Location information will be stored into this object. */

    private final LocatorTable locatorTable;

    private final Set outerMostBindings;

    private Locator locator;

    public void setDocumentLocator(Locator locator) {

        this.locator = locator;

        super.setDocumentLocator(locator);

    }

    public void startElement(String namespaceURI, String localName, String qName, Attributes atts) {

        super.startElement(namespaceURI, localName, qName, atts);

        Element e = getCurrentElement();

        locatorTable.storeStartLocation( e, locator );

        // check if this element is an outer-most <jaxb:bindings>

        if( Const.JAXB_NSURI.equals(e.getNamespaceURI())

        &&  "bindings".equals(e.getLocalName()) ) {

            // if this is the root node (meaning that this file is an

            // external binding file) or if the parent is XML Schema element

            // (meaning that this is an "inlined" external binding)

            Node p = e.getParentNode();

            if( p instanceof Document

            ||( p instanceof Element && !e.getNamespaceURI().equals(p.getNamespaceURI()))) {

                outerMostBindings.add(e);   // remember this value

            }

        }

    }

    public void endElement(String namespaceURI, String localName, String qName) {

        locatorTable.storeEndLocation( getCurrentElement(), locator );

        super.endElement(namespaceURI, localName, qName);

    }

}