source: icXML/icXML-devel/src/xercesc/framework/psvi/XSNamedMap.hpp @ 2722

Last change on this file since 2722 was 2722, checked in by cameron, 6 years ago

Original Xerces files with import mods for icxercesc

File size: 4.5 KB
Line 
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements.  See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License.  You may obtain a copy of the License at
8 *
9 *      http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id: XSNamedMap.hpp 674012 2008-07-04 11:18:21Z borisk $
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_XSNAMEDMAP_HPP)
23#define XERCESC_INCLUDE_GUARD_XSNAMEDMAP_HPP
24
25
26#include <xercesc/util/XMemory.hpp>
27#include <xercesc/util/RefHash2KeysTableOf.hpp>
28#include <xercesc/util/RefVectorOf.hpp>
29
30XERCES_CPP_NAMESPACE_BEGIN
31
32class XMLStringPool;
33
34/*
35 * This template provides convenient mappings between name,namespace
36 * pairs and individual components, as well as means to iterate through all the
37 * named components on some object.
38 */
39
40template <class TVal> class XSNamedMap: public XMemory
41{
42public:
43    // -----------------------------------------------------------------------
44    //  Constructors and Destructor
45    // -----------------------------------------------------------------------
46    /** @name Constructors */
47    //@{
48
49    XSNamedMap(const XMLSize_t maxElems,
50        const XMLSize_t modulus,
51        XMLStringPool* uriStringPool,
52        const bool adoptElems,
53        MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
54    );
55    //@}
56
57    /** @name Destructor */
58    //@{
59    ~XSNamedMap();
60
61    //@}
62
63    // -----------------------------------------------------------------------
64    //  XSNamedMap methods
65    // -----------------------------------------------------------------------
66    /** @name XSNamedMap methods */
67    //@{
68
69    /**
70     * The number of <code>XSObjects</code> in the <code>XSObjectList</code>.
71     * The range of valid child object indices is 0 to
72     * <code>mapLength-1</code> inclusive.
73     */
74    XMLSize_t getLength() const;
75
76    /**
77     *  Returns the <code>index</code>th item in the collection. The index
78     * starts at 0. If <code>index</code> is greater than or equal to the
79     * number of objects in the list, this returns <code>null</code>.
80     * @param index  index into the collection.
81     * @return  The <code>XSObject</code> at the <code>index</code>th
82     *   position in the <code>XSObjectList</code>, or <code>null</code> if
83     *   that is not a valid index.
84     */
85    TVal *item(XMLSize_t index);
86    const TVal *item(XMLSize_t index) const;
87
88    /**
89     * Retrieves a component specified by local name and namespace URI.
90     * <br>applications must use the value null as the
91     * <code>compNamespace</code> parameter for components whose targetNamespace property
92     * is absent.
93     * @param compNamespace The namespace URI of the component to retrieve.
94     * @param localName The local name of the component to retrieve.
95     * @return A component (of any type) with the specified local
96     *   name and namespace URI, or <code>null</code> if they do not
97     *   identify any node in this map.
98     */
99    TVal *itemByName(const XMLCh *compNamespace,
100                              const XMLCh *localName);
101
102    //@}
103
104    //----------------------------------
105    /** methods needed by implementation */
106
107    //@{
108    void addElement(TVal* const toAdd, const XMLCh* key1, const XMLCh* key2);
109    //@}
110
111
112private :
113    // -----------------------------------------------------------------------
114    //  Unimplemented constructors and operators
115    // -----------------------------------------------------------------------
116    XSNamedMap(const XSNamedMap<TVal>&);
117    XSNamedMap<TVal>& operator=(const XSNamedMap<TVal>&);
118
119    // -----------------------------------------------------------------------
120    //  Data members
121    //
122    // fMemoryManager
123    //  manager used to allocate memory needed by this object
124    MemoryManager *const        fMemoryManager;
125    XMLStringPool*              fURIStringPool;
126    RefVectorOf<TVal>*          fVector;
127    RefHash2KeysTableOf<TVal>*  fHash;
128};
129
130
131
132XERCES_CPP_NAMESPACE_END
133
134#if !defined(XERCES_TMPLSINC)
135#include <xercesc/framework/psvi/XSNamedMap.c>
136#endif
137
138#endif
Note: See TracBrowser for help on using the repository browser.