/*

 * reserved comment block

 * DO NOT REMOVE OR ALTER!

 */

/*

 * The Apache Software License, Version 1.1

 *

 *

 * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights

 * reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 *

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 *

 * 2. Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in

 *    the documentation and/or other materials provided with the

 *    distribution.

 *

 * 3. The end-user documentation included with the redistribution,

 *    if any, must include the following acknowledgment:

 *       "This product includes software developed by the

 *        Apache Software Foundation (http://www.apache.org/)."

 *    Alternately, this acknowledgment may appear in the software itself,

 *    if and wherever such third-party acknowledgments normally appear.

 *

 * 4. The names "Xerces" and "Apache Software Foundation" must

 *    not be used to endorse or promote products derived from this

 *    software without prior written permission. For written

 *    permission, please contact apache@apache.org.

 *

 * 5. Products derived from this software may not be called "Apache",

 *    nor may "Apache" appear in their name, without prior written

 *    permission of the Apache Software Foundation.

 *

 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED

 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR

 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

 * SUCH DAMAGE.

 * ====================================================================

 *

 * This software consists of voluntary contributions made by many

 * individuals on behalf of the Apache Software Foundation and was

 * originally based on software copyright (c) 1999, International

 * Business Machines, Inc., http://www.apache.org.  For more

 * information on the Apache Software Foundation, please see

 * <http://www.apache.org/>.

 */

package com.sun.org.apache.xerces.internal.impl;

import com.sun.org.apache.xerces.internal.impl.msg.XMLMessageFormatter;

import com.sun.org.apache.xerces.internal.util.SymbolTable;

import com.sun.org.apache.xerces.internal.util.XMLSymbols;

import com.sun.org.apache.xerces.internal.xni.Augmentations;

import com.sun.org.apache.xerces.internal.xni.NamespaceContext;

import com.sun.org.apache.xerces.internal.xni.QName;

import com.sun.org.apache.xerces.internal.xni.XMLAttributes;

import com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler;

import com.sun.org.apache.xerces.internal.xni.XMLLocator;

import com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier;

import com.sun.org.apache.xerces.internal.xni.XMLString;

import com.sun.org.apache.xerces.internal.xni.XNIException;

import com.sun.org.apache.xerces.internal.xni.parser.XMLComponent;

import com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager;

import com.sun.org.apache.xerces.internal.xni.parser.XMLConfigurationException;

import com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentFilter;

import com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource;

/**

 * This class performs namespace binding on the startElement and endElement

 * method calls and passes all other methods through to the registered

 * document handler. This class can be configured to only pass the

 * start and end prefix mappings (start/endPrefixMapping).

 * <p>

 * This component requires the following features and properties from the

 * component manager that uses it:

 * <ul>

 *  <li>http://xml.org/sax/features/namespaces</li>

 *  <li>http://apache.org/xml/properties/internal/symbol-table</li>

 *  <li>http://apache.org/xml/properties/internal/error-reporter</li>

 * </ul>

 *

 * @xerces.internal

 *

 * @author Andy Clark, IBM

 *

 */

public class XMLNamespaceBinder

    implements XMLComponent, XMLDocumentFilter {

    //

    // Constants

    //

    // feature identifiers

    /** Feature identifier: namespaces. */

    protected static final String NAMESPACES =

        Constants.SAX_FEATURE_PREFIX + Constants.NAMESPACES_FEATURE;

    // property identifiers

    /** Property identifier: symbol table. */

    protected static final String SYMBOL_TABLE =

        Constants.XERCES_PROPERTY_PREFIX + Constants.SYMBOL_TABLE_PROPERTY;

    /** Property identifier: error reporter. */

    protected static final String ERROR_REPORTER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.ERROR_REPORTER_PROPERTY;

    // recognized features and properties

    /** Recognized features. */

    private static final String[] RECOGNIZED_FEATURES = {

        NAMESPACES,

    };

    /** Feature defaults. */

    private static final Boolean[] FEATURE_DEFAULTS = {

        null,

    };

    /** Recognized properties. */

    private static final String[] RECOGNIZED_PROPERTIES = {

        SYMBOL_TABLE,

        ERROR_REPORTER,

    };

    /** Property defaults. */

    private static final Object[] PROPERTY_DEFAULTS = {

        null,

        null,

    };

    //

    // Data

    //

    // features

    /** Namespaces. */

    protected boolean fNamespaces;

    // properties

    /** Symbol table. */

    protected SymbolTable fSymbolTable;

    /** Error reporter. */

    protected XMLErrorReporter fErrorReporter;

    // handlers

    /** Document handler. */

    protected XMLDocumentHandler fDocumentHandler;

    protected XMLDocumentSource fDocumentSource;

    // settings

    /** Only pass start and end prefix mapping events. */

    protected boolean fOnlyPassPrefixMappingEvents;

    // shared context

    /** Namespace context. */

    private NamespaceContext fNamespaceContext;

    // temp vars

    /** Attribute QName. */

    private QName fAttributeQName = new QName();

    //

    // Constructors

    //

    /** Default constructor. */

    public XMLNamespaceBinder() {

    } // <init>()

    //

    // Public methods

    //

    // settings

    /**

     * Sets whether the namespace binder only passes the prefix mapping

     * events to the registered document handler or passes all document

     * events.

     *

     * @param onlyPassPrefixMappingEvents True to pass only the prefix

     *                                    mapping events; false to pass

     *                                    all events.

     */

    public void setOnlyPassPrefixMappingEvents(boolean onlyPassPrefixMappingEvents) {

        fOnlyPassPrefixMappingEvents = onlyPassPrefixMappingEvents;

    } // setOnlyPassPrefixMappingEvents(boolean)

    /**

     * Returns true if the namespace binder only passes the prefix mapping

     * events to the registered document handler; false if the namespace

     * binder passes all document events.

     */

    public boolean getOnlyPassPrefixMappingEvents() {

        return fOnlyPassPrefixMappingEvents;

    } // getOnlyPassPrefixMappingEvents():boolean

    //

    // XMLComponent methods

    //

    /**

     * Resets the component. The component can query the component manager

     * about any features and properties that affect the operation of the

     * component.

     *

     * @param componentManager The component manager.

     *

     * @throws SAXException Thrown by component on initialization error.

     *                      For example, if a feature or property is

     *                      required for the operation of the component, the

     *                      component manager may throw a

     *                      SAXNotRecognizedException or a

     *                      SAXNotSupportedException.

     */

    public void reset(XMLComponentManager componentManager)

        throws XNIException {

        // features

        fNamespaces = componentManager.getFeature(NAMESPACES, true);

        // Xerces properties

        fSymbolTable = (SymbolTable)componentManager.getProperty(SYMBOL_TABLE);

        fErrorReporter = (XMLErrorReporter)componentManager.getProperty(ERROR_REPORTER);

    } // reset(XMLComponentManager)

    /**

     * Returns a list of feature identifiers that are recognized by

     * this component. This method may return null if no features

     * are recognized by this component.

     */

    public String[] getRecognizedFeatures() {

        return (String[])(RECOGNIZED_FEATURES.clone());

    } // getRecognizedFeatures():String[]

    /**

     * Sets the state of a feature. This method is called by the component

     * manager any time after reset when a feature changes state.

     * <p>

     * <strong>Note:</strong> Components should silently ignore features

     * that do not affect the operation of the component.

     *

     * @param featureId The feature identifier.

     * @param state     The state of the feature.

     *

     * @throws SAXNotRecognizedException The component should not throw

     *                                   this exception.

     * @throws SAXNotSupportedException The component should not throw

     *                                  this exception.

     */

    public void setFeature(String featureId, boolean state)

        throws XMLConfigurationException {

    } // setFeature(String,boolean)

    /**

     * Returns a list of property identifiers that are recognized by

     * this component. This method may return null if no properties

     * are recognized by this component.

     */

    public String[] getRecognizedProperties() {

        return (String[])(RECOGNIZED_PROPERTIES.clone());

    } // getRecognizedProperties():String[]

    /**

     * Sets the value of a property during parsing.

     *

     * @param propertyId

     * @param value

     */

    public void setProperty(String propertyId, Object value)

        throws XMLConfigurationException {

        // Xerces properties

        if (propertyId.startsWith(Constants.XERCES_PROPERTY_PREFIX)) {

                final int suffixLength = propertyId.length() - Constants.XERCES_PROPERTY_PREFIX.length();

            if (suffixLength == Constants.SYMBOL_TABLE_PROPERTY.length() &&

                propertyId.endsWith(Constants.SYMBOL_TABLE_PROPERTY)) {

                fSymbolTable = (SymbolTable)value;

            }

            else if (suffixLength == Constants.ERROR_REPORTER_PROPERTY.length() &&

                propertyId.endsWith(Constants.ERROR_REPORTER_PROPERTY)) {

                fErrorReporter = (XMLErrorReporter)value;

            }

            return;

        }

    } // setProperty(String,Object)

    /**

     * Returns the default state for a feature, or null if this

     * component does not want to report a default value for this

     * feature.

     *

     * @param featureId The feature identifier.

     *

     * @since Xerces 2.2.0

     */

    public Boolean getFeatureDefault(String featureId) {

        for (int i = 0; i < RECOGNIZED_FEATURES.length; i++) {

            if (RECOGNIZED_FEATURES[i].equals(featureId)) {

                return FEATURE_DEFAULTS[i];

            }

        }

        return null;

    } // getFeatureDefault(String):Boolean

    /**

     * Returns the default state for a property, or null if this

     * component does not want to report a default value for this

     * property.

     *

     * @param propertyId The property identifier.

     *

     * @since Xerces 2.2.0

     */

    public Object getPropertyDefault(String propertyId) {

        for (int i = 0; i < RECOGNIZED_PROPERTIES.length; i++) {

            if (RECOGNIZED_PROPERTIES[i].equals(propertyId)) {

                return PROPERTY_DEFAULTS[i];

            }

        }

        return null;

    } // getPropertyDefault(String):Object

    //

    // XMLDocumentSource methods

    //

    /** Sets the document handler to receive information about the document. */

    public void setDocumentHandler(XMLDocumentHandler documentHandler) {

        fDocumentHandler = documentHandler;

    } // setDocumentHandler(XMLDocumentHandler)

    /** Returns the document handler */

    public XMLDocumentHandler getDocumentHandler() {

        return fDocumentHandler;

    } // setDocumentHandler(XMLDocumentHandler)

    //

    // XMLDocumentHandler methods

    //

    /** Sets the document source */

    public void setDocumentSource(XMLDocumentSource source){

        fDocumentSource = source;

    } // setDocumentSource

    /** Returns the document source */

    public XMLDocumentSource getDocumentSource (){

        return fDocumentSource;

    } // getDocumentSource

    /**

     * This method notifies the start of a general entity.

     * <p>

     * <strong>Note:</strong> This method is not called for entity references

     * appearing as part of attribute values.

     *

     * @param name     The name of the general entity.

     * @param identifier The resource identifier.

     * @param encoding The auto-detected IANA encoding name of the entity

     *                 stream. This value will be null in those situations

     *                 where the entity encoding is not auto-detected (e.g.

     *                 internal entities or a document entity that is

     *                 parsed from a java.io.Reader).

     * @param augs     Additional information that may include infoset augmentations

     *

     * @exception XNIException Thrown by handler to signal an error.

     */

    public void startGeneralEntity(String name,

                                   XMLResourceIdentifier identifier,

                                   String encoding, Augmentations augs)

        throws XNIException {

        if (fDocumentHandler != null && !fOnlyPassPrefixMappingEvents) {

            fDocumentHandler.startGeneralEntity(name, identifier, encoding, augs);

        }

    } // startEntity(String,String,String,String,String)

    /**

     * Notifies of the presence of a TextDecl line in an entity. If present,

     * this method will be called immediately following the startEntity call.

     * <p>

     * <strong>Note:</strong> This method will never be called for the

     * document entity; it is only called for external general entities

     * referenced in document content.

     * <p>

     * <strong>Note:</strong> This method is not called for entity references

     * appearing as part of attribute values.

     *

     * @param version  The XML version, or null if not specified.

     * @param encoding The IANA encoding name of the entity.

     * @param augs     Additional information that may include infoset augmentations

     *

     * @throws XNIException Thrown by handler to signal an error.

     */

    public void textDecl(String version, String encoding, Augmentations augs)

        throws XNIException {

        if (fDocumentHandler != null && !fOnlyPassPrefixMappingEvents) {

            fDocumentHandler.textDecl(version, encoding, augs);

        }

    } // textDecl(String,String)

    /**

     * The start of the document.

     *

     * @param locator  The system identifier of the entity if the entity

     *                 is external, null otherwise.

     * @param encoding The auto-detected IANA encoding name of the entity

     *                 stream. This value will be null in those situations

     *                 where the entity encoding is not auto-detected (e.g.

     *                 internal entities or a document entity that is

     *                 parsed from a java.io.Reader).

     * @param namespaceContext

     *                 The namespace context in effect at the

     *                 start of this document.

     *                 This object represents the current context.

     *                 Implementors of this class are responsible

     *                 for copying the namespace bindings from the

     *                 the current context (and its parent contexts)

     *                 if that information is important.

     * @param augs     Additional information that may include infoset augmentations

     *

     * @throws XNIException Thrown by handler to signal an error.

     */

        public void startDocument(XMLLocator locator, String encoding,

                                NamespaceContext namespaceContext, Augmentations augs)

                                      throws XNIException {

                fNamespaceContext = namespaceContext;

                if (fDocumentHandler != null && !fOnlyPassPrefixMappingEvents) {

                        fDocumentHandler.startDocument(locator, encoding, namespaceContext, augs);

                }

        } // startDocument(XMLLocator,String)

    /**

     * Notifies of the presence of an XMLDecl line in the document. If

     * present, this method will be called immediately following the

     * startDocument call.

     *

     * @param version    The XML version.

     * @param encoding   The IANA encoding name of the document, or null if

     *                   not specified.

     * @param standalone The standalone value, or null if not specified.

     * @param augs     Additional information that may include infoset augmentations

     *

     * @throws XNIException Thrown by handler to signal an error.

     */

    public void xmlDecl(String version, String encoding, String standalone, Augmentations augs)

        throws XNIException {

        if (fDocumentHandler != null && !fOnlyPassPrefixMappingEvents) {

            fDocumentHandler.xmlDecl(version, encoding, standalone, augs);

        }

    } // xmlDecl(String,String,String)

    /**

     * Notifies of the presence of the DOCTYPE line in the document.

     *

     * @param rootElement The name of the root element.

     * @param publicId    The public identifier if an external DTD or null

     *                    if the external DTD is specified using SYSTEM.

     * @param systemId    The system identifier if an external DTD, null

     *                    otherwise.

     * @param augs     Additional information that may include infoset augmentations

     *

     * @throws XNIException Thrown by handler to signal an error.

     */

    public void doctypeDecl(String rootElement,

                            String publicId, String systemId, Augmentations augs)

        throws XNIException {

        if (fDocumentHandler != null && !fOnlyPassPrefixMappingEvents) {

            fDocumentHandler.doctypeDecl(rootElement, publicId, systemId, augs);

        }

    } // doctypeDecl(String,String,String)

    /**

     * A comment.

     *

     * @param text The text in the comment.

     * @param augs     Additional information that may include infoset augmentations

     *

     * @throws XNIException Thrown by application to signal an error.

     */

    public void comment(XMLString text, Augmentations augs) throws XNIException {

        if (fDocumentHandler != null && !fOnlyPassPrefixMappingEvents) {

            fDocumentHandler.comment(text, augs);

        }

    } // comment(XMLString)

    /**

     * A processing instruction. Processing instructions consist of a

     * target name and, optionally, text data. The data is only meaningful

     * to the application.

     * <p>

     * Typically, a processing instruction's data will contain a series

     * of pseudo-attributes. These pseudo-attributes follow the form of

     * element attributes but are <strong>not</strong> parsed or presented

     * to the application as anything other than text. The application is

     * responsible for parsing the data.

     *