xpath_rwapi/src2/org/apache/xpath/expression/StaticContext.java

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002-2003 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 "Xalan" 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) 2002, International
 * Business Machines Corporation., http://www.ibm.com.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.xpath.expression;

import java.util.Set;

import org.apache.xml.NamespaceContext;

/**
 * Static context of XPath expression. 
 * @see <a href="http://www.w3.org/TR/xpath20/#static_context">XPath 2.0 specification</a>
 * @author <a href="mailto:villard@us.ibm.com>Lionel Villard</a>
 * @version $Id$
 */
public interface StaticContext {
    
    short STRICT_POLICY = 0;
    short FLEXIBLE_POLICY = 1;

    /**
     * Gets the exception policy to apply.
     * @return short {@link #STRICT_POLICY} or {@link #FLEXIBLE_POLICY}
     */
    short getExceptionPolicy();

    /**
     * Gets in-scope namespaces.  
     */
    NamespaceContext getNamespaces();

    /**
     * Gets the default namespace for element and type names.
     * @return namespace 
     */
    String getDefaultNamepaceForElement();

    /**
     * Gets the default namespace for function names.
     * @return namespace 
     */
    String getDefaultNamepaceforFunction();

    /**
     * In-scope schema definitions. This is a set of (QName, type definition) pairs.
     * //@TODO
     */
    void getSchemaDefs();

    /**
     * In-scope variables. This is a set of (QName, type) pairs. 
     * //@TODO
     */
    Set getVariables();
    
    /**
     * In-scope functions. This is a set of (QName, function signature) pairs.
     * //@TODO
     */
    void getFunctions();
    
    /**
     * In-scope collations. This is a set of (URI, collation) pairs. 
     * //@TODO
     */
    void getCollations();

    /**
     * Default collation. 
     * //@TODO
     */
    void getDefaultCollation();
    
    /**
     * Base URI.
     * //@TODO
     */
    String getBaseURI();
}