com.sun.org.apache.xalan.internal.extensions.ExpressionContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxp-ri Show documentation
Show all versions of jaxp-ri Show documentation
Java API for XML Processing Reference Implementation
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* 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.
*/
/*
* $Id: ExpressionContext.java,v 1.10 2010-11-01 04:34:11 joehw Exp $
*/
package com.sun.org.apache.xalan.internal.extensions;
import javax.xml.transform.ErrorListener;
import com.sun.org.apache.xpath.internal.objects.XObject;
import org.w3c.dom.Node;
import org.w3c.dom.traversal.NodeIterator;
/**
* An object that implements this interface can supply
* information about the current XPath expression context.
*/
public interface ExpressionContext
{
/**
* Get the current context node.
* @return The current context node.
*/
public Node getContextNode();
/**
* Get the current context node list.
* @return An iterator for the current context list, as
* defined in XSLT.
*/
public NodeIterator getContextNodes();
/**
* Get the error listener.
* @return The registered error listener.
*/
public ErrorListener getErrorListener();
/**
* Get the value of a node as a number.
* @param n Node to be converted to a number. May be null.
* @return value of n as a number.
*/
public double toNumber(Node n);
/**
* Get the value of a node as a string.
* @param n Node to be converted to a string. May be null.
* @return value of n as a string, or an empty string if n is null.
*/
public String toString(Node n);
/**
* Get a variable based on it's qualified name.
*
* @param qname The qualified name of the variable.
*
* @return The evaluated value of the variable.
*
* @throws javax.xml.transform.TransformerException
*/
public XObject getVariableOrParam(com.sun.org.apache.xml.internal.utils.QName qname)
throws javax.xml.transform.TransformerException;
/**
* Get the XPathContext that owns this ExpressionContext.
*
* Note: exslt:function requires the XPathContext to access
* the variable stack and TransformerImpl.
*
* @return The current XPathContext.
* @throws javax.xml.transform.TransformerException
*/
public com.sun.org.apache.xpath.internal.XPathContext getXPathContext()
throws javax.xml.transform.TransformerException;
}