unoxml/source/dom/entitiesmap.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: entitiesmap.hxx,v $
  10  * $Revision: 1.4 $
  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 _ENTITIESMAP_HXX
  32 #define _ENTITIESMAP_HXX
  33
  34 #include <map>
  35 #include <sal/types.h>
  36 #include <cppuhelper/implbase1.hxx>
  37 #include <com/sun/star/uno/Reference.h>
  38 #include <com/sun/star/uno/Exception.hpp>
  39 #include <com/sun/star/xml/dom/XNode.hpp>
  40 #include <com/sun/star/xml/dom/XNamedNodeMap.hpp>
  41 #include "document.hxx"
  42 #include "documenttype.hxx"
  43
  44 using ::rtl::OUString;
  45 using namespace com::sun::star::uno;
  46 using namespace com::sun::star::lang;
  47 using namespace com::sun::star::xml::dom;
  48
  49 namespace DOM
  50 {
  51     class CEntitiesMap : public cppu::WeakImplHelper1< XNamedNodeMap >
  52     {
  53     private:
  54         const CDocumentType* m_pDocType;
  55     public:
  56         CEntitiesMap(const CDocumentType* aDocType);
  57
  58         /**
  59         The number of nodes in this map.
  60         */
  61         virtual sal_Int32 SAL_CALL getLength() throw (RuntimeException);
  62
  63         /**
  64         Retrieves a node specified by local name
  65         */
  66         virtual Reference< XNode > SAL_CALL getNamedItem(const OUString& name) throw (RuntimeException);
  67
  68         /**
  69         Retrieves a node specified by local name and namespace URI.
  70         */
  71         virtual Reference< XNode > SAL_CALL getNamedItemNS(const OUString& namespaceURI, const OUString& localName) throw (RuntimeException);
  72
  73         /**
  74         Returns the indexth item in the map.
  75         */
  76         virtual Reference< XNode > SAL_CALL item(sal_Int32 index) throw (RuntimeException);
  77
  78         /**
  79         Removes a node specified by name.
  80         */
  81         virtual Reference< XNode > SAL_CALL removeNamedItem(const OUString& name) throw (RuntimeException);
  82
  83         /**
  84         // Removes a node specified by local name and namespace URI.
  85         */
  86         virtual Reference< XNode > SAL_CALL removeNamedItemNS(const OUString& namespaceURI, const OUString& localName) throw (RuntimeException);
  87
  88         /**
  89         // Adds a node using its nodeName attribute.
  90         */
  91         virtual Reference< XNode > SAL_CALL setNamedItem(const Reference< XNode >& arg) throw (RuntimeException);
  92
  93         /**
  94         Adds a node using its namespaceURI and localName.
  95         */
  96         virtual Reference< XNode > SAL_CALL setNamedItemNS(const Reference< XNode >& arg) throw (RuntimeException);
  97     };
  98 }
  99
 100 #endif