KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > xpath > ExprEnvironment


1 /*
2  * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
3  *
4  * This file is part of Resin(R) Open Source
5  *
6  * Each copy or derived work must preserve the copyright notice and this
7  * notice unmodified.
8  *
9  * Resin Open Source is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * Resin Open Source is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17  * of NON-INFRINGEMENT. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Resin Open Source; if not, write to the
22  * Free SoftwareFoundation, Inc.
23  * 59 Temple Place, Suite 330
24  * Boston, MA 02111-1307 USA
25  *
26  * @author Scott Ferguson
27  */

28
29 package com.caucho.xpath;
30
31 import com.caucho.xpath.expr.Var;
32
33 import org.w3c.dom.Document JavaDoc;
34 import org.w3c.dom.Node JavaDoc;
35
36 /**
37  * Adds variable environment.
38  */

39 public interface ExprEnvironment {
40   /**
41    * Returns the value associated with name.
42    *
43    * <p><em>name must be interned</em>
44    */

45   public Var getVar(String JavaDoc name);
46   
47   /**
48    * Returns the value associated with name.
49    *
50    * <p><em>name must be interned</em>
51    */

52   public XPathFun getFunction(String JavaDoc name);
53   
54   /**
55    * Sets the node context.
56    */

57   public Node JavaDoc setContextNode(Node JavaDoc node);
58   /**
59    * Returns the StylesheetEnv
60    */

61   public StylesheetEnv getStylesheetEnv();
62   /**
63    * Return context node from the XPath expression context.
64    */

65   Node JavaDoc getContextNode();
66   
67   /**
68    * Returns the context position from the XPath expression context.
69    */

70   int getContextPosition();
71   
72   /**
73    * Returns the context size from the XPath expression context.
74    */

75   int getContextSize();
76   
77   /**
78    * Returns the current node from the XSLT context; the same
79    * as calling current() function from the XPath expression context.
80    */

81   Node JavaDoc getCurrentNode();
82   
83   /**
84    * Returns a Document to be used for creating nodes.
85    */

86   Document JavaDoc getOwnerDocument();
87   /**
88    * Returns an Object representing the value of the system property
89    * whose expanded-name has the specified namespace URI and local part.
90    */

91   Object JavaDoc systemProperty(String JavaDoc namespaceURI, String JavaDoc localName);
92   /**
93    * Returns the string-value of the specified Node.
94    */

95   String JavaDoc stringValue(Node JavaDoc n);
96 }
97
Popular Tags