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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module xml { module xpath {
  22
  23
  24 interface XXPathAPI : com::sun::star::uno::XInterface
  25 {
  26
  27     void registerNS(
  28             [in] string prefix,
  29             [in] string url);
  30
  31     void unregisterNS(
  32             [in] string prefix,
  33             [in] string url);
  34
  35     void registerExtension( [in] string serviceName );
  36     void registerExtensionInstance(
  37             [in] com::sun::star::xml::xpath::XXPathExtension aExtension);
  38
  39     /** Evaluate XPath Expression.
  40
  41         @param contextNode
  42             the context node (expression is relative to this node)
  43
  44         @param expr
  45             the XPath expression
  46
  47         @throws XPathException
  48             if the expression is malformed, or evaluation fails
  49
  50         @returns
  51             an object representing the result of the XPath evaluation
  52
  53         @see XXPathObject
  54      */
  55     XXPathObject eval(
  56             [in] com::sun::star::xml::dom::XNode contextNode,
  57             [in] string expr)
  58         raises( com::sun::star::xml::xpath::XPathException );
  59
  60     /** Evaluate XPath Expression.
  61
  62         @param contextNode
  63             the context node (expression is relative to this node)
  64
  65         @param expr
  66             the XPath expression
  67
  68         @param namespaceNode
  69             all namespaces declared on this node will be registered
  70
  71         @throws XPathException
  72             if the expression is malformed, or evaluation fails
  73
  74         @returns
  75             an object representing the result of the XPath evaluation
  76
  77         @see XXPathObject
  78      */
  79     XXPathObject evalNS(
  80             [in] com::sun::star::xml::dom::XNode contextNode,
  81             [in] string expr,
  82             [in] com::sun::star::xml::dom::XNode namespaceNode)
  83         raises( com::sun::star::xml::xpath::XPathException );
  84
  85     /** Evaluate an XPath expression to select a list of nodes.
  86
  87         @param contextNode
  88             the context node (expression is relative to this node)
  89
  90         @param expr
  91             the XPath expression
  92
  93         @throws XPathException
  94             if the expression is malformed, or evaluation fails
  95
  96         @returns
  97             result of the XPath evaluation: a list of nodes
  98
  99         @see XNodeList
 100      */
 101     com::sun::star::xml::dom::XNodeList selectNodeList(
 102             [in] com::sun::star::xml::dom::XNode contextNode,
 103             [in] string expr)
 104         raises( com::sun::star::xml::xpath::XPathException );
 105
 106     /** Evaluate an XPath expression to select a list of nodes.
 107
 108         @param contextNode
 109             the context node (expression is relative to this node)
 110
 111         @param expr
 112             the XPath expression
 113
 114         @param namespaceNode
 115             all namespaces declared on this node will be registered
 116
 117         @throws XPathException
 118             if the expression is malformed, or evaluation fails
 119
 120         @returns
 121             result of the XPath evaluation: a list of nodes
 122
 123         @see XNodeList
 124      */
 125     com::sun::star::xml::dom::XNodeList selectNodeListNS(
 126             [in] com::sun::star::xml::dom::XNode contextNode,
 127             [in] string expr,
 128             [in] com::sun::star::xml::dom::XNode namespaceNode)
 129         raises( com::sun::star::xml::xpath::XPathException );
 130
 131     /** Evaluate an XPath expression to select a single node.
 132
 133         @param contextNode
 134             the context node (expression is relative to this node)
 135
 136         @param expr
 137             the XPath expression
 138
 139         @throws XPathException
 140             if the expression is malformed, or evaluation fails
 141
 142         @returns
 143             result of the XPath evaluation: a single node
 144     */
 145     com::sun::star::xml::dom::XNode selectSingleNode(
 146             [in] com::sun::star::xml::dom::XNode contextNode,
 147             [in] string expr)
 148         raises( com::sun::star::xml::xpath::XPathException );
 149
 150     /** Evaluate an XPath expression to select a single node.
 151
 152         @param contextNode
 153             the context node (expression is relative to this node)
 154
 155         @param expr
 156             the XPath expression
 157
 158         @param namespaceNode
 159             all namespaces declared on this node will be registered
 160
 161         @throws XPathException
 162             if the expression is malformed, or evaluation fails
 163
 164         @returns
 165             result of the XPath evaluation: a single node
 166     */
 167     com::sun::star::xml::dom::XNode selectSingleNodeNS(
 168             [in] com::sun::star::xml::dom::XNode contextNode,
 169             [in] string expr,
 170             [in] com::sun::star::xml::dom::XNode namespaceNode)
 171         raises( com::sun::star::xml::xpath::XPathException );
 172
 173 };
 174
 175 }; }; }; }; };
 176
 177 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */