sl@0: // Copyright (c) 2004-2010 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // RSqlMap template class declaration.
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __SQLMAP_H__
sl@0: #define __SQLMAP_H__
sl@0: 
sl@0: #include "SqlAssert.h"
sl@0: 
sl@0: //Forward declaration
sl@0: template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR> class RSqlMap;
sl@0: 
sl@0: /**
sl@0: (KEY, DATA, REFCNTR) template pair class used by RSqlMap template class.
sl@0: 
sl@0: The class has 3 template arguments:
sl@0:  - KEY        - the key part of the pair object;
sl@0:  - DATA       - the data part of the pair object;
sl@0:  - REFCNTR    - the reference counting part of the pair object;
sl@0:                 REFCNTR class has to provide "TInt Increment()" and "TInt Decrement()" methods.
sl@0: 
sl@0: @see TSqlMapIterator
sl@0: @see RSqlMap
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: template <class KEY, class DATA, class REFCNTR> 
sl@0: NONSHARABLE_STRUCT(TSqlPair)
sl@0: 	{
sl@0: 	TSqlPair(const KEY& aKey, const DATA& aData);
sl@0: 	TSqlPair(const KEY& aKey);
sl@0: 	TSqlPair();
sl@0: 	
sl@0: 	KEY		iKey;
sl@0: 	DATA	iData;
sl@0: 	REFCNTR	iRefCounter;
sl@0: 	
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: TSqlMapIterator class. It describes an object which can be used as a 
sl@0: forward, read-only iterator for RSqlMap containers.
sl@0: 
sl@0: The class has 4 template arguments:
sl@0:  - KEY        - the key part of the pair object;
sl@0:  - DATA       - the data part of the pair object;
sl@0:  - REFCNTR    - the reference counting part of the pair object;
sl@0:                 REFCNTR class has to provide "TInt Increment()" and "TInt Decrement()" methods.
sl@0:  - DESTRUCTOR - the KEY and DATA objects destroying part of the pair object;
sl@0: 				DESTRUCTOR class has to provide "void Destroy(KEY& aKey, DATA& aData)" method.
sl@0: 
sl@0: @see TSqlPair
sl@0: @see RSqlMap
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR> 
sl@0: NONSHARABLE_CLASS(TSqlMapIterator)
sl@0: 	{
sl@0: public:
sl@0: 	TSqlMapIterator(const RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>& aMap);
sl@0: 	TBool Next(TSqlPair<KEY, DATA, REFCNTR>& aPair) const;
sl@0: 	
sl@0: private:
sl@0: 	const RSqlMap<KEY, DATA, REFCNTR, DESTRUCTOR>&	iMap;
sl@0: 	mutable TInt									iIndex;
sl@0: 	
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: RSqlMap template class describes an object that controls an ordered sequence of reference counted entries.
sl@0: Each entry has a key of type KEY and an associated with it data of type DATA.
sl@0: 
sl@0: The class has 4 template arguments:
sl@0:  - KEY        - the key part of the pair object;
sl@0:  - DATA       - the data part of the pair object;
sl@0:  - REFCNTR    - the reference counting part of the pair object;
sl@0:                 REFCNTR class has to provide "TInt Increment()" and "TInt Decrement()" methods.
sl@0:  - DESTRUCTOR - the KEY and DATA objects destroying part of the pair object;
sl@0: 				DESTRUCTOR class has to provide "void Destroy(KEY& aKey, DATA& aData)" method.
sl@0: 
sl@0: The algorithm for determining the order of two entries is provided by a TLinearOrder
sl@0: object, supplied by the client of RSqlMap during RSqlMap instance construction
sl@0: (RSqlMap constructor, aOrder argument).
sl@0: 
sl@0: @see TSqlPair
sl@0: @see TSqlMapIterator
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: template <class KEY, class DATA, class REFCNTR, class DESTRUCTOR> 
sl@0: NONSHARABLE_CLASS(RSqlMap)
sl@0: 	{
sl@0: 	friend class TSqlMapIterator<KEY, DATA, REFCNTR, DESTRUCTOR>;
sl@0: 	
sl@0: public:
sl@0: 	RSqlMap(const TLinearOrder< TSqlPair<KEY, DATA, REFCNTR> >& aOrder, const DESTRUCTOR& aDestructor);
sl@0: 	void Close();
sl@0: 	TInt Insert(const KEY& aKey, const DATA& aData);
sl@0: 	void Remove(const KEY& aKey);
sl@0: 	TSqlPair<KEY, DATA, REFCNTR>* Entry(const KEY& aKey);
sl@0: 
sl@0: private:
sl@0: 	TLinearOrder< TSqlPair<KEY, DATA, REFCNTR> >	iOrder;
sl@0: 	RArray< TSqlPair<KEY, DATA, REFCNTR> >			iSet;
sl@0: 	DESTRUCTOR 										iDestructor;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #include "SqlMap.inl"
sl@0: 
sl@0: #endif//__SQLMAP_H__