1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SRC/Common/SqlMap.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,125 @@
1.4 +// Copyright (c) 2004-2010 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// RSqlMap template class declaration.
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __SQLMAP_H__
1.22 +#define __SQLMAP_H__
1.23 +
1.24 +#include "SqlAssert.h"
1.25 +
1.26 +//Forward declaration
1.27 +template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR> class RSqlMap;
1.28 +
1.29 +/**
1.30 +(KEY, DATA, REFCNTR) template pair class used by RSqlMap template class.
1.31 +
1.32 +The class has 3 template arguments:
1.33 + - KEY - the key part of the pair object;
1.34 + - DATA - the data part of the pair object;
1.35 + - REFCNTR - the reference counting part of the pair object;
1.36 + REFCNTR class has to provide "TInt Increment()" and "TInt Decrement()" methods.
1.37 +
1.38 +@see TSqlMapIterator
1.39 +@see RSqlMap
1.40 +
1.41 +@internalComponent
1.42 +*/
1.43 +template <class KEY, class DATA, class REFCNTR>
1.44 +NONSHARABLE_STRUCT(TSqlPair)
1.45 + {
1.46 + TSqlPair(const KEY& aKey, const DATA& aData);
1.47 + TSqlPair(const KEY& aKey);
1.48 + TSqlPair();
1.49 +
1.50 + KEY iKey;
1.51 + DATA iData;
1.52 + REFCNTR iRefCounter;
1.53 +
1.54 + };
1.55 +
1.56 +/**
1.57 +TSqlMapIterator class. It describes an object which can be used as a
1.58 +forward, read-only iterator for RSqlMap containers.
1.59 +
1.60 +The class has 4 template arguments:
1.61 + - KEY - the key part of the pair object;
1.62 + - DATA - the data part of the pair object;
1.63 + - REFCNTR - the reference counting part of the pair object;
1.64 + REFCNTR class has to provide "TInt Increment()" and "TInt Decrement()" methods.
1.65 + - DESTRUCTOR - the KEY and DATA objects destroying part of the pair object;
1.66 + DESTRUCTOR class has to provide "void Destroy(KEY& aKey, DATA& aData)" method.
1.67 +
1.68 +@see TSqlPair
1.69 +@see RSqlMap
1.70 +
1.71 +@internalComponent
1.72 +*/
1.73 +template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR>
1.74 +NONSHARABLE_CLASS(TSqlMapIterator)
1.75 + {
1.76 +public:
1.77 + TSqlMapIterator(const RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>& aMap);
1.78 + TBool Next(TSqlPair<KEY, DATA, REFCNTR>& aPair) const;
1.79 +
1.80 +private:
1.81 + const RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>& iMap;
1.82 + mutable TInt iIndex;
1.83 +
1.84 + };
1.85 +
1.86 +/**
1.87 +RSqlMap template class describes an object that controls an ordered sequence of reference counted entries.
1.88 +Each entry has a key of type KEY and an associated with it data of type DATA.
1.89 +
1.90 +The class has 4 template arguments:
1.91 + - KEY - the key part of the pair object;
1.92 + - DATA - the data part of the pair object;
1.93 + - REFCNTR - the reference counting part of the pair object;
1.94 + REFCNTR class has to provide "TInt Increment()" and "TInt Decrement()" methods.
1.95 + - DESTRUCTOR - the KEY and DATA objects destroying part of the pair object;
1.96 + DESTRUCTOR class has to provide "void Destroy(KEY& aKey, DATA& aData)" method.
1.97 +
1.98 +The algorithm for determining the order of two entries is provided by a TLinearOrder
1.99 +object, supplied by the client of RSqlMap during RSqlMap instance construction
1.100 +(RSqlMap constructor, aOrder argument).
1.101 +
1.102 +@see TSqlPair
1.103 +@see TSqlMapIterator
1.104 +
1.105 +@internalComponent
1.106 +*/
1.107 +template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR>
1.108 +NONSHARABLE_CLASS(RSqlMap)
1.109 + {
1.110 + friend class TSqlMapIterator<KEY, DATA, REFCNTR, DESTRUCTOR>;
1.111 +
1.112 +public:
1.113 + RSqlMap(const TLinearOrder< TSqlPair<KEY, DATA, REFCNTR> >& aOrder, const DESTRUCTOR& aDestructor);
1.114 + void Close();
1.115 + TInt Insert(const KEY& aKey, const DATA& aData);
1.116 + void Remove(const KEY& aKey);
1.117 + TSqlPair<KEY, DATA, REFCNTR>* Entry(const KEY& aKey);
1.118 +
1.119 +private:
1.120 + TLinearOrder< TSqlPair<KEY, DATA, REFCNTR> > iOrder;
1.121 + RArray< TSqlPair<KEY, DATA, REFCNTR> > iSet;
1.122 + DESTRUCTOR iDestructor;
1.123 +
1.124 + };
1.125 +
1.126 +#include "SqlMap.inl"
1.127 +
1.128 +#endif//__SQLMAP_H__