scripting/source/storage/XMLElement.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: XMLElement.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 #ifndef _SCRIPTING_XML_ELEMENT_HXX_
  31 #define _SCRIPTING_XML_ELEMENT_HXX_
  32
  33 #include <vector>
  34
  35 #include <cppuhelper/implbase1.hxx>
  36
  37 #include <com/sun/star/xml/sax/XExtendedDocumentHandler.hpp>
  38
  39 namespace scripting_impl
  40 {
  41 // for simplification
  42 #define css ::com::sun::star
  43 #define dcsssf ::drafts::com::sun::star::script::framework
  44
  45 /*##################################################################################################
  46
  47  EXPORTING
  48
  49 ##################################################################################################*/
  50
  51 //==================================================================================================
  52 class XMLElement : public ::cppu::WeakImplHelper1< css::xml::sax::XAttributeList >
  53 {
  54 public:
  55     inline XMLElement( ::rtl::OUString const & name, ::rtl::OUString const & chars )
  56     SAL_THROW( () )
  57             : _name( name ), _chars( chars )
  58     {
  59     }
  60
  61     inline XMLElement( ::rtl::OUString const & name )
  62     SAL_THROW( () )
  63             : _name( name )
  64     {
  65     }
  66
  67     /** Adds a sub element of element.
  68
  69      @param xElem element reference
  70     */
  71     void SAL_CALL addSubElement(
  72         css::uno::Reference< css::xml::sax::XAttributeList > const & xElem )
  73         SAL_THROW( () );
  74
  75     /** Gets sub element of given index.  The index follows order in which sub elements were added.
  76
  77      @param nIndex index of sub element
  78     */
  79     css::uno::Reference< css::xml::sax::XAttributeList > SAL_CALL getSubElement(
  80         sal_Int32 nIndex )
  81         SAL_THROW( () );
  82
  83     /** Adds an attribute to elements.
  84
  85      @param rAttrName qname of attribute
  86      @param rValue value string of element
  87     */
  88     void SAL_CALL addAttribute( ::rtl::OUString const & rAttrName,
  89         ::rtl::OUString const & rValue )
  90         SAL_THROW( () );
  91
  92     /** Gets the tag name (qname) of element.
  93
  94      @return
  95        qname of element
  96     */
  97     inline ::rtl::OUString SAL_CALL getName() SAL_THROW( () )
  98     {
  99         return _name;
 100     }
 101
 102     /** Dumps out element (and all sub elements).
 103
 104      @param xOut document handler to be written to
 105     */
 106     void SAL_CALL dump(
 107         css::uno::Reference< css::xml::sax::XExtendedDocumentHandler > const & xOut );
 108     /** Dumps out sub elements (and all further sub elements).
 109
 110      @param xOut document handler to be written to
 111     */
 112     void SAL_CALL dumpSubElements(
 113         css::uno::Reference< css::xml::sax::XExtendedDocumentHandler > const & xOut );
 114
 115     // XAttributeList
 116     virtual sal_Int16 SAL_CALL getLength()
 117         throw ( css::uno::RuntimeException );
 118     virtual ::rtl::OUString SAL_CALL getNameByIndex( sal_Int16 nPos )
 119          throw ( css::uno::RuntimeException );
 120     virtual ::rtl::OUString SAL_CALL getTypeByIndex( sal_Int16 nPos )
 121         throw ( css::uno::RuntimeException );
 122     virtual ::rtl::OUString SAL_CALL getTypeByName( ::rtl::OUString const & rName )
 123         throw ( css::uno::RuntimeException );
 124     virtual ::rtl::OUString SAL_CALL getValueByIndex( sal_Int16 nPos )
 125         throw ( css::uno::RuntimeException );
 126     virtual ::rtl::OUString SAL_CALL getValueByName( ::rtl::OUString const & rName )
 127         throw ( css::uno::RuntimeException );
 128
 129 protected:
 130     ::rtl::OUString _name;
 131
 132     ::rtl::OUString _chars;
 133
 134     ::std::vector< ::rtl::OUString > _attrNames;
 135     ::std::vector< ::rtl::OUString > _attrValues;
 136
 137     ::std::vector< css::uno::Reference<
 138     css::xml::sax::XAttributeList > > _subElems;
 139 };
 140
 141 }
 142
 143 #endif