Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


XPathProcessor.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 #if !defined(XPATHPROCESSOR_HEADER_GUARD_1357924680)
19 #define XPATHPROCESSOR_HEADER_GUARD_1357924680
20 
21 
22 
23 // Base include file. Must be first.
25 
26 
27 
28 // $$$ ToDo: This is necessary while XalanDOMString is still a typedef...
30 
31 
32 
33 
34 XALAN_DECLARE_XERCES_CLASS(Locator)
35 
36 
37 
38 XALAN_CPP_NAMESPACE_BEGIN
39 
40 
41 
42 XALAN_USING_XERCES(Locator)
43 
44 
45 
46 class Function;
47 class PrefixResolver;
48 class XPath;
50 
51 
52 
54 {
55 public:
56 
57  typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator LocatorType;
58 
59  explicit
61 
62  virtual
63  ~XPathProcessor();
64 
65  /**
66  * Given a string, make an XPath object, in order that a parse doesn't
67  * have to be done each time the expression is executed.
68  *
69  * @param pathObj XPath object to be initialized
70  * @param constructionContext The construction context
71  * @param expression expression that will be evaluated
72  * @param resolver prefix resolver to use
73  * @param locator the Locator to use for error report. May be null
74  * @param allowVariableReferences If true, variable references are allowed.
75  * @param allowKeyFunction If true, calls to the key() function are allowed.
76  */
77  virtual void
78  initXPath(
79  XPath& pathObj,
80  XPathConstructionContext& constructionContext,
81  const XalanDOMString& expression,
82  const PrefixResolver& resolver,
83  const Locator* locator = 0,
84  bool allowVariableReferences = true,
85  bool allowKeyFunction = true) = 0;
86 
87  /**
88  * Given a string, create an XSLT Match Pattern object.
89  *
90  * @param pathObj XPath object to be initialized
91  * @param constructionContext The construction context
92  * @param expression expression that will be evaluated
93  * @param resolver prefix resolver to use
94  * @param locator the Locator to use for error report. May be null
95  * @param allowVariableReferences If true, variable references are allowed.
96  * @param allowKeyFunction If true, calls to the key() function are allowed.
97  */
98  virtual void
99  initMatchPattern(
100  XPath& pathObj,
101  XPathConstructionContext& constructionContext,
102  const XalanDOMString& expression,
103  const PrefixResolver& resolver,
104  const Locator* locator = 0,
105  bool allowVariableReferences = true,
106  bool allowKeyFunction = true) = 0;
107 
108  /**
109  * Given a string, and a reference to a function object, install the
110  * function with the given name.
111  *
112  * @param theFunctionName name of function
113  * @param theFunction function object corresponding to name
114  */
115  static void
116  installFunction(
117  const XalanDOMString& theFunctionName,
118  const Function& theFunction);
119 };
120 
121 
122 
123 XALAN_CPP_NAMESPACE_END
124 
125 
126 
127 #endif // XPATHPROCESSOR_HEADER_GUARD_1357924680
XERCES_CPP_NAMESPACE_QUALIFIER Locator LocatorType
Definition: XPath.hpp:64
This class defines an interface for classes that resolve namespace prefixes to their URIs...
XALAN_CPP_NAMESPACE_BEGIN XALAN_USING_XERCES(Locator)
#define XALAN_XPATH_EXPORT

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo