offapi/com/sun/star/xml/xpath/XXPathAPI.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XXPathAPI.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_xml_XPath_XXPathAPI_idl__
  32 #define __com_sun_star_xml_XPath_XXPathAPI_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_xml_dom_XNode_idl__
  38 #include <com/sun/star/xml/dom/XNode.idl>
  39 #endif
  40 #ifndef __com_sun_star_xml_dom_XNodeList_idl__
  41 #include <com/sun/star/xml/dom/XNodeList.idl>
  42 #endif
  43 #ifndef __com_sun_star_xml_xpath_XXPathObject_idl__
  44 #include <com/sun/star/xml/xpath/XXPathObject.idl>
  45 #endif
  46 #ifndef __com_sun_star_xml_xpath_XXPathExtension_idl__
  47 #include <com/sun/star/xml/xpath/XXPathExtension.idl>
  48 #endif
  49 #ifndef __com_sun_star_xml_XPath_XPathException_idl__
  50 #include <com/sun/star/xml/xpath/XPathException.idl>
  51 #endif
  52
  53
  54 module com { module sun { module star { module xml { module xpath {
  55
  56
  57 interface XXPathAPI : com::sun::star::uno::XInterface
  58 {
  59
  60     void registerNS(
  61             [in] string prefix,
  62             [in] string url);
  63
  64     void unregisterNS(
  65             [in] string prefix,
  66             [in] string url);
  67
  68     void registerExtension( [in] string serviceName );
  69     void registerExtensionInstance(
  70             [in] com::sun::star::xml::xpath::XXPathExtension aExtension);
  71
  72     /** Eval XPath Expression.
  73
  74         @param contextNode
  75             the context node (expression is relative to this node)
  76
  77         @param expr
  78             the XPath expression
  79
  80         @throws XPathException
  81             if the expression is malformed, or evaluation fails
  82
  83         @returns
  84             an object representing the result of the XPath evaluation
  85
  86         @see XXPathObject
  87      */
  88     XXPathObject eval(
  89             [in] com::sun::star::xml::dom::XNode contextNode,
  90             [in] string expr)
  91         raises( com::sun::star::xml::xpath::XPathException );
  92
  93     /** Eval XPath Expression.
  94
  95         @param contextNode
  96             the context node (expression is relative to this node)
  97
  98         @param expr
  99             the XPath expression
 100
 101         @param namespaceNode
 102             all namespaces declared on this node will be registered
 103
 104         @throws XPathException
 105             if the expression is malformed, or evaluation fails
 106
 107         @returns
 108             an object representing the result of the XPath evaluation
 109
 110         @see XXPathObject
 111      */
 112     XXPathObject evalNS(
 113             [in] com::sun::star::xml::dom::XNode contextNode,
 114             [in] string expr,
 115             [in] com::sun::star::xml::dom::XNode namespaceNode)
 116         raises( com::sun::star::xml::xpath::XPathException );
 117
 118     /** Evaluate an XPath expression to select a list of nodes.
 119
 120         @param contextNode
 121             the context node (expression is relative to this node)
 122
 123         @param expr
 124             the XPath expression
 125
 126         @throws XPathException
 127             if the expression is malformed, or evaluation fails
 128
 129         @returns
 130             result of the XPath evaluation: a list of nodes
 131
 132         @see XNodeList
 133      */
 134     com::sun::star::xml::dom::XNodeList selectNodeList(
 135             [in] com::sun::star::xml::dom::XNode contextNode,
 136             [in] string expr)
 137         raises( com::sun::star::xml::xpath::XPathException );
 138
 139     /** Evaluate an XPath expression to select a list of nodes.
 140
 141         @param contextNode
 142             the context node (expression is relative to this node)
 143
 144         @param expr
 145             the XPath expression
 146
 147         @param namespaceNode
 148             all namespaces declared on this node will be registered
 149
 150         @throws XPathException
 151             if the expression is malformed, or evaluation fails
 152
 153         @returns
 154             result of the XPath evaluation: a list of nodes
 155
 156         @see XNodeList
 157      */
 158     com::sun::star::xml::dom::XNodeList selectNodeListNS(
 159             [in] com::sun::star::xml::dom::XNode contextNode,
 160             [in] string str,
 161             [in] com::sun::star::xml::dom::XNode namespaceNode)
 162         raises( com::sun::star::xml::xpath::XPathException );
 163
 164     /** Evaluate an XPath expression to select a single node.
 165
 166         @param contextNode
 167             the context node (expression is relative to this node)
 168
 169         @param expr
 170             the XPath expression
 171
 172         @throws XPathException
 173             if the expression is malformed, or evaluation fails
 174
 175         @returns
 176             result of the XPath evaluation: a single node
 177     */
 178     com::sun::star::xml::dom::XNode selectSingleNode(
 179             [in] com::sun::star::xml::dom::XNode contextNode,
 180             [in] string expr)
 181         raises( com::sun::star::xml::xpath::XPathException );
 182
 183     /** Evaluate an XPath expression to select a single node.
 184
 185         @param contextNode
 186             the context node (expression is relative to this node)
 187
 188         @param expr
 189             the XPath expression
 190
 191         @param namespaceNode
 192             all namespaces declared on this node will be registered
 193
 194         @throws XPathException
 195             if the expression is malformed, or evaluation fails
 196
 197         @returns
 198             result of the XPath evaluation: a single node
 199     */
 200     com::sun::star::xml::dom::XNode selectSingleNodeNS(
 201             [in] com::sun::star::xml::dom::XNode contextNode,
 202             [in] string str,
 203             [in] com::sun::star::xml::dom::XNode namespaceNode)
 204         raises( com::sun::star::xml::xpath::XPathException );
 205
 206 };
 207
 208 }; }; }; }; };
 209
 210 #endif