forms/source/xforms/pathexpression.hxx

   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: pathexpression.hxx,v $
  10  * $Revision: 1.5 $
  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 _PATHEXPRESSION_HXX
  32 #define _PATHEXPRESSION_HXX
  33
  34
  35 // include for parent class
  36 #include "computedexpression.hxx"
  37
  38 // includes for member variables
  39 #include <vector>
  40
  41 // forward declaractions
  42 namespace com { namespace sun { namespace star
  43 {
  44     namespace xml { namespace dom
  45     {
  46         class XNodeList;
  47         namespace events { class XEventListener; }
  48     } }
  49 } } }
  50
  51
  52
  53 namespace xforms
  54 {
  55
  56 /** PathExpression represents an XPath Expression and caches results */
  57 class PathExpression : public ComputedExpression
  58 {
  59 public:
  60     typedef std::vector<com::sun::star::uno::Reference<com::sun::star::xml::dom::XNode> > NodeVector_t;
  61
  62 private:
  63     /// the node-list result from the last bind (cached from mxResult)
  64     NodeVector_t maNodes;
  65
  66 protected:
  67     /// get expression for evaluation
  68     const rtl::OUString _getExpressionForEvaluation() const;
  69
  70
  71 public:
  72     PathExpression();
  73     ~PathExpression();
  74
  75     /// set the expression string
  76     /// (overridden to do remove old listeners)
  77     /// (also defines simple expressions)
  78     void setExpression( const rtl::OUString& rExpression );
  79
  80
  81     /// evaluate the expression relative to the content node.
  82     bool evaluate( const xforms::EvaluationContext& rContext );
  83
  84
  85     // get the result of this expression as node/node list/...
  86     com::sun::star::uno::Reference<com::sun::star::xml::dom::XNode> getNode() const;
  87     const NodeVector_t getNodeList() const;
  88     com::sun::star::uno::Reference<com::sun::star::xml::dom::XNodeList> getXNodeList() const;
  89
  90 };
  91
  92 } // namespace xforms
  93
  94 #endif