001 /* XPath.java -- 002 Copyright (C) 2004 Free Software Foundation, Inc. 003 004 This file is part of GNU Classpath. 005 006 GNU Classpath is free software; you can redistribute it and/or modify 007 it under the terms of the GNU General Public License as published by 008 the Free Software Foundation; either version 2, or (at your option) 009 any later version. 010 011 GNU Classpath is distributed in the hope that it will be useful, but 012 WITHOUT ANY WARRANTY; without even the implied warranty of 013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 General Public License for more details. 015 016 You should have received a copy of the GNU General Public License 017 along with GNU Classpath; see the file COPYING. If not, write to the 018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 019 02110-1301 USA. 020 021 Linking this library statically or dynamically with other modules is 022 making a combined work based on this library. Thus, the terms and 023 conditions of the GNU General Public License cover the whole 024 combination. 025 026 As a special exception, the copyright holders of this library give you 027 permission to link this library with independent modules to produce an 028 executable, regardless of the license terms of these independent 029 modules, and to copy and distribute the resulting executable under 030 terms of your choice, provided that you also meet, for each linked 031 independent module, the terms and conditions of the license of that 032 module. An independent module is a module which is not derived from 033 or based on this library. If you modify this library, you may extend 034 this exception to your version of the library, but you are not 035 obligated to do so. If you do not wish to do so, delete this 036 exception statement from your version. */ 037 038 package javax.xml.xpath; 039 040 import javax.xml.namespace.NamespaceContext; 041 import javax.xml.namespace.QName; 042 import org.xml.sax.InputSource; 043 044 /** 045 * Interface to the XPath evaluation environment. 046 * @since 1.3 047 */ 048 public interface XPath 049 { 050 051 /** 052 * Resets the environment. 053 */ 054 void reset(); 055 056 void setXPathVariableResolver(XPathVariableResolver resolver); 057 058 XPathVariableResolver getXPathVariableResolver(); 059 060 void setXPathFunctionResolver(XPathFunctionResolver resolver); 061 062 XPathFunctionResolver getXPathFunctionResolver(); 063 064 void setNamespaceContext(NamespaceContext nsContext); 065 066 NamespaceContext getNamespaceContext(); 067 068 /** 069 * Compiles an XPath expression for future evaluation. 070 * @param expression the expression 071 */ 072 XPathExpression compile(String expression) 073 throws XPathExpressionException; 074 075 /** 076 * Evaluates an expression. 077 * @param expression the expression 078 * @param item the expression context 079 * @param returnType the desired return type 080 */ 081 Object evaluate(String expression, 082 Object item, 083 QName returnType) 084 throws XPathExpressionException; 085 086 /** 087 * Evaluates an expression and returns the result as a string. 088 * @param expression the expression 089 * @param item the expression context 090 */ 091 String evaluate(String expression, 092 Object item) 093 throws XPathExpressionException; 094 095 /** 096 * Evaluates an expression. 097 * @param expression the expression 098 * @param source the source to load the expression context from 099 * @param returnType the desired return type 100 */ 101 Object evaluate(String expression, 102 InputSource source, 103 QName returnType) 104 throws XPathExpressionException; 105 106 /** 107 * Evaluates an expression and returns the result as a string. 108 * @param expression the expression 109 * @param source the source to load the expression context from 110 */ 111 String evaluate(String expression, 112 InputSource source) 113 throws XPathExpressionException; 114 115 }