forms/source/xforms/pathexpression.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef _PATHEXPRESSION_HXX
  29 #define _PATHEXPRESSION_HXX
  30
  31
  32 // include for parent class
  33 #include "computedexpression.hxx"
  34
  35 // includes for member variables
  36 #include <vector>
  37
  38 // forward declaractions
  39 namespace com { namespace sun { namespace star
  40 {
  41     namespace xml { namespace dom
  42     {
  43         class XNodeList;
  44         namespace events { class XEventListener; }
  45     } }
  46 } } }
  47
  48
  49
  50 namespace xforms
  51 {
  52
  53 /** PathExpression represents an XPath Expression and caches results */
  54 class PathExpression : public ComputedExpression
  55 {
  56 public:
  57     typedef std::vector<com::sun::star::uno::Reference<com::sun::star::xml::dom::XNode> > NodeVector_t;
  58
  59 private:
  60     /// the node-list result from the last bind (cached from mxResult)
  61     NodeVector_t maNodes;
  62
  63 protected:
  64     /// get expression for evaluation
  65     const rtl::OUString _getExpressionForEvaluation() const;
  66
  67
  68 public:
  69     PathExpression();
  70     ~PathExpression();
  71
  72     /// set the expression string
  73     /// (overridden to do remove old listeners)
  74     /// (also defines simple expressions)
  75     void setExpression( const rtl::OUString& rExpression );
  76
  77
  78     /// evaluate the expression relative to the content node.
  79     bool evaluate( const xforms::EvaluationContext& rContext );
  80
  81
  82     // get the result of this expression as node/node list/...
  83     com::sun::star::uno::Reference<com::sun::star::xml::dom::XNode> getNode() const;
  84     const NodeVector_t getNodeList() const;
  85     com::sun::star::uno::Reference<com::sun::star::xml::dom::XNodeList> getXNodeList() const;
  86
  87 };
  88
  89 } // namespace xforms
  90
  91 #endif