/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.xerces.xinclude;

import org.apache.xerces.xni.NamespaceContext;

This is an implementation of NamespaceContext which is intended to be used for
XInclude processing.  It enables each context to be marked as invalid, if necessary,
to indicate that the namespaces recorded on those contexts won't be apparent in the
resulting infoset.
Author:
Peter McCracken, IBM
Version:
$Id: XIncludeNamespaceSupport.java 447243 2006-09-18 05:15:27Z mrglavas $/**
 * This is an implementation of NamespaceContext which is intended to be used for
 * XInclude processing.  It enables each context to be marked as invalid, if necessary,
 * to indicate that the namespaces recorded on those contexts won't be apparent in the
 * resulting infoset.
 * 
 * @author Peter McCracken, IBM
 * 
 * @version $Id: XIncludeNamespaceSupport.java 447243 2006-09-18 05:15:27Z mrglavas $
 */
public class XIncludeNamespaceSupport extends MultipleScopeNamespaceSupport {

    
This stores whether or not the context at the matching depth was valid.
/**
     * This stores whether or not the context at the matching depth was valid.
     */
    private boolean[] fValidContext = new boolean[8];

    /**
     * 
     */
    public XIncludeNamespaceSupport() {
        super();
    }

    
Params:
context – /**
     * @param context
     */
    public XIncludeNamespaceSupport(NamespaceContext context) {
        super(context);
    }

    
Pushes a new context onto the stack.
/**
     * Pushes a new context onto the stack.
     */
    public void pushContext() {
        super.pushContext();
        if (fCurrentContext + 1 == fValidContext.length) {
            boolean[] contextarray = new boolean[fValidContext.length * 2];
            System.arraycopy(fValidContext, 0, contextarray, 0, fValidContext.length);
            fValidContext = contextarray;
        }

        fValidContext[fCurrentContext] = true;
    }

    
This method is used to set a context invalid for XInclude namespace processing.
Any context defined by an <include> or <fallback> element is not
valid for processing the include parent's [in-scope namespaces]. Thus, contexts
defined by these elements are set to invalid by the XInclude processor using
this method.
/**
     * This method is used to set a context invalid for XInclude namespace processing.
     * Any context defined by an &lt;include&gt; or &lt;fallback&gt; element is not
     * valid for processing the include parent's [in-scope namespaces]. Thus, contexts
     * defined by these elements are set to invalid by the XInclude processor using
     * this method.
     */    
    public void setContextInvalid() {
        fValidContext[fCurrentContext] = false;
    }
    
    
This returns the namespace URI which was associated with the given pretext, in
the context that existed at the include parent of the current element.  The
include parent is the last element, before the current one, which was not set
to an invalid context using setContextInvalid()
Params:
prefix – the prefix of the desired URI
Returns:
the URI corresponding to the prefix in the context of the include parent/**
     * This returns the namespace URI which was associated with the given pretext, in
     * the context that existed at the include parent of the current element.  The
     * include parent is the last element, before the current one, which was not set
     * to an invalid context using setContextInvalid()
     * 
     * @param prefix the prefix of the desired URI
     * @return the URI corresponding to the prefix in the context of the include parent
     */
    public String getURIFromIncludeParent(String prefix) {
        int lastValidContext = fCurrentContext - 1;
        while (lastValidContext > 0 && !fValidContext[lastValidContext]) {
            lastValidContext--;
        }
        return getURI(prefix, lastValidContext);
    }
}