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