xref: /aoo42x/main/unoxml/source/dom/entitiesmap.hxx (revision 7f654276)
1*7f654276SAndrew Rist /**************************************************************
2*7f654276SAndrew Rist  *
3*7f654276SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*7f654276SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*7f654276SAndrew Rist  * distributed with this work for additional information
6*7f654276SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*7f654276SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*7f654276SAndrew Rist  * "License"); you may not use this file except in compliance
9*7f654276SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*7f654276SAndrew Rist  *
11*7f654276SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*7f654276SAndrew Rist  *
13*7f654276SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*7f654276SAndrew Rist  * software distributed under the License is distributed on an
15*7f654276SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*7f654276SAndrew Rist  * KIND, either express or implied.  See the License for the
17*7f654276SAndrew Rist  * specific language governing permissions and limitations
18*7f654276SAndrew Rist  * under the License.
19*7f654276SAndrew Rist  *
20*7f654276SAndrew Rist  *************************************************************/
21*7f654276SAndrew Rist 
22*7f654276SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef DOM_ENTITIESMAP_HXX
25cdf0e10cSrcweir #define DOM_ENTITIESMAP_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include <sal/types.h>
28cdf0e10cSrcweir #include <rtl/ref.hxx>
29cdf0e10cSrcweir 
30cdf0e10cSrcweir #include <com/sun/star/uno/Reference.h>
31cdf0e10cSrcweir #include <com/sun/star/xml/dom/XNode.hpp>
32cdf0e10cSrcweir #include <com/sun/star/xml/dom/XNamedNodeMap.hpp>
33cdf0e10cSrcweir 
34cdf0e10cSrcweir #include <cppuhelper/implbase1.hxx>
35cdf0e10cSrcweir 
36cdf0e10cSrcweir 
37cdf0e10cSrcweir using ::rtl::OUString;
38cdf0e10cSrcweir using namespace com::sun::star::uno;
39cdf0e10cSrcweir using namespace com::sun::star::xml::dom;
40cdf0e10cSrcweir 
41cdf0e10cSrcweir namespace DOM
42cdf0e10cSrcweir {
43cdf0e10cSrcweir     class CDocumentType;
44cdf0e10cSrcweir 
45cdf0e10cSrcweir     class CEntitiesMap
46cdf0e10cSrcweir         : public cppu::WeakImplHelper1< XNamedNodeMap >
47cdf0e10cSrcweir     {
48cdf0e10cSrcweir     private:
49cdf0e10cSrcweir         ::rtl::Reference<CDocumentType> const m_pDocType;
50cdf0e10cSrcweir         ::osl::Mutex & m_rMutex;
51cdf0e10cSrcweir 
52cdf0e10cSrcweir     public:
53cdf0e10cSrcweir         CEntitiesMap(::rtl::Reference<CDocumentType> const& pDocType,
54cdf0e10cSrcweir                 ::osl::Mutex & rMutex);
55cdf0e10cSrcweir 
56cdf0e10cSrcweir         /**
57cdf0e10cSrcweir         The number of nodes in this map.
58cdf0e10cSrcweir         */
59cdf0e10cSrcweir         virtual sal_Int32 SAL_CALL getLength() throw (RuntimeException);
60cdf0e10cSrcweir 
61cdf0e10cSrcweir         /**
62cdf0e10cSrcweir         Retrieves a node specified by local name
63cdf0e10cSrcweir         */
64cdf0e10cSrcweir         virtual Reference< XNode > SAL_CALL
65cdf0e10cSrcweir             getNamedItem(const OUString& name) throw (RuntimeException);
66cdf0e10cSrcweir 
67cdf0e10cSrcweir         /**
68cdf0e10cSrcweir         Retrieves a node specified by local name and namespace URI.
69cdf0e10cSrcweir         */
70cdf0e10cSrcweir         virtual Reference< XNode > SAL_CALL getNamedItemNS(
71cdf0e10cSrcweir                 OUString const& namespaceURI, OUString const& localName)
72cdf0e10cSrcweir             throw (RuntimeException);
73cdf0e10cSrcweir 
74cdf0e10cSrcweir         /**
75cdf0e10cSrcweir         Returns the indexth item in the map.
76cdf0e10cSrcweir         */
77cdf0e10cSrcweir         virtual Reference< XNode > SAL_CALL
78cdf0e10cSrcweir             item(sal_Int32 index) throw (RuntimeException);
79cdf0e10cSrcweir 
80cdf0e10cSrcweir         /**
81cdf0e10cSrcweir         Removes a node specified by name.
82cdf0e10cSrcweir         */
83cdf0e10cSrcweir         virtual Reference< XNode > SAL_CALL
84cdf0e10cSrcweir             removeNamedItem(OUString const& name) throw (RuntimeException);
85cdf0e10cSrcweir 
86cdf0e10cSrcweir         /**
87cdf0e10cSrcweir         // Removes a node specified by local name and namespace URI.
88cdf0e10cSrcweir         */
89cdf0e10cSrcweir         virtual Reference< XNode > SAL_CALL removeNamedItemNS(
90cdf0e10cSrcweir                 OUString const& namespaceURI, OUString const& localName)
91cdf0e10cSrcweir             throw (RuntimeException);
92cdf0e10cSrcweir 
93cdf0e10cSrcweir         /**
94cdf0e10cSrcweir         // Adds a node using its nodeName attribute.
95cdf0e10cSrcweir         */
96cdf0e10cSrcweir         virtual Reference< XNode > SAL_CALL
97cdf0e10cSrcweir             setNamedItem(Reference< XNode > const& arg)
98cdf0e10cSrcweir             throw (RuntimeException);
99cdf0e10cSrcweir 
100cdf0e10cSrcweir         /**
101cdf0e10cSrcweir         Adds a node using its namespaceURI and localName.
102cdf0e10cSrcweir         */
103cdf0e10cSrcweir         virtual Reference< XNode > SAL_CALL
104cdf0e10cSrcweir             setNamedItemNS(Reference< XNode > const& arg)
105cdf0e10cSrcweir             throw (RuntimeException);
106cdf0e10cSrcweir     };
107cdf0e10cSrcweir }
108cdf0e10cSrcweir 
109cdf0e10cSrcweir #endif
110