1 // Copyright (c) 2004-2010 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // RSqlMap template class implementation.
15 // //////////////////// TSqlPair implementation //////////////////////////////////
21 Initializes TSqlPair data members using the supplied parameter values.
23 @param aKey Key part of TSqlPair object
24 @param aData Data part of TSqlPair object
26 template <class KEY, class DATA, class REFCNTR>
27 TSqlPair<KEY, DATA, REFCNTR>::TSqlPair(const KEY& aKey, const DATA& aData) :
34 Initializes TSqlPair data members using the supplied parameter value.
36 @param aKey Key part of TSqlPair object
38 template <class KEY, class DATA, class REFCNTR>
39 TSqlPair<KEY, DATA, REFCNTR>::TSqlPair(const KEY& aKey) :
45 Initializes TSqlPair data members with their default values.
47 template <class KEY, class DATA, class REFCNTR>
48 TSqlPair<KEY, DATA, REFCNTR>::TSqlPair()
52 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
53 /////////////////////// RSqlMap implementation ///////////////////////////////////
54 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
57 @param aOrder An object of TLinearOrder< TSqlPair<KEY, DATA, REFCNTR> > type, which will be used when
58 new elements are inserted into the collection (to determine their order).
59 @param aDestructor An object of TSqlPairDestructor<KEY, DATA> type which will be used for the destruction of
60 KEY and DATA TSqlPair data members.
62 template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR>
63 RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>::RSqlMap(const TLinearOrder< TSqlPair<KEY, DATA, REFCNTR> >& aOrder, const DESTRUCTOR& aDestructor) :
65 iDestructor(aDestructor)
70 Closes RSqlMap instance and destroys all RSqlMap data.
72 template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR>
73 void RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>::Close()
75 TInt idx = iSet.Count();
78 TSqlPair<KEY, DATA, REFCNTR>& pair = iSet[idx];
79 iDestructor.Destroy(pair.iKey, pair.iData);
85 This method will create and insert new (KEY, DATA, REFCNTR) pair in the map.
87 RSqlMap class maintains a set of reference counted objects.
88 If an object with aKey key is already in the map, no insertion will occur, the reference counter
89 of the existing object will be incremented.
91 @param aKey The key part of TSqlPair object, which will be inserted
92 @param aData The data part of TSqlPair object, which will be inserted
94 @return System-wide error code if the insertion fails, reference counter value otherwise.
96 template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR>
97 TInt RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>::Insert(const KEY& aKey, const DATA& aData)
99 TInt idx = iSet.FindInOrder(TSqlPair<KEY, DATA, REFCNTR>(aKey), iOrder);
102 return iSet[idx].iRefCounter.Increment();
106 TInt err = iSet.InsertInOrder(TSqlPair<KEY, DATA, REFCNTR>(aKey, aData), iOrder);
107 return err == KErrNone ? 1 : err;
112 This method removes an element with aKey key from the map.
114 If there is no such element in the map, the debug verison of the method will panic.
116 RSqlMap class maintains a set of reference counted objects.
117 If an object with aKey key is in the map, the reference counter of the object will be decremented.
118 If the object's reference counter reaches 0 then the object will be destroyed.
120 @param aKey The key of TSqlPair object, which has to be removed from the collection.
122 @panic 7 In _DEBUG mode if there is no entry with aKey key in the RSqlMap container.
124 template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR>
125 void RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>::Remove(const KEY& aKey)
127 TInt idx = iSet.FindInOrder(TSqlPair<KEY, DATA, REFCNTR>(aKey), iOrder);
128 if(idx != KErrNotFound)
130 TSqlPair<KEY, DATA, REFCNTR>& pair = iSet[idx];
131 if(pair.iRefCounter.Decrement() == 0)
133 iDestructor.Destroy(pair.iKey, pair.iData);
136 //This is used prevent the failure of the resource allocation checking in debug mode.
137 if(iSet.Count() == 0)
145 __ASSERT_DEBUG(EFalse, __SQLPANIC(ESqlPanicInternalError));
149 This method performs a search for an element with aKey key in the map.
150 If such element exists, the method will return a pointer to it.
151 If not, then the method will return NULL.
153 @param aKey The search key.
155 @return A pointer to the found element or NULL.
157 template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR>
158 TSqlPair<KEY, DATA, REFCNTR>* RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>::Entry(const KEY& aKey)
160 TInt idx = iSet.FindInOrder(TSqlPair<KEY, DATA, REFCNTR>(aKey), iOrder);
161 return idx == KErrNotFound ? NULL : &iSet[idx];
164 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
165 /////////////////////// TSqlMapIterator implementation ////////////////////////////////
166 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
169 Initializes TSqlMapIterator instance.
171 @param aMap A const reference to the RSqlMap object, which will be iterated.
173 template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR>
174 TSqlMapIterator<KEY, DATA, REFCNTR, DESTRUCTOR>::TSqlMapIterator(const RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>& aMap) :
181 If iterator's current position is not beyond the end of the map,
182 the iterator will retrieve current map entry into aPair argument, advance iterator position
183 by 1 and return ETrue.
185 Otherwise the iterator will return EFalse.
187 @param aPair An output parameter, which references the location, where the next RSqlMap element will be stored.
189 @return ETrue The next RSqlMap element successfully loaded into aPair parameter. This is not the
190 end of RSqlMap collection.
191 @return EFalse The next RSqlMap element successfully loaded into aPair parameter. This is the
192 end of RSqlMap collection. Do not call Next() anymore.
194 template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR>
195 TBool TSqlMapIterator<KEY, DATA, REFCNTR, DESTRUCTOR>::Next(TSqlPair<KEY, DATA, REFCNTR>& aPair) const
197 return (iIndex < iMap.iSet.Count()) ? aPair = iMap.iSet[iIndex++], ETrue : EFalse;