/*

* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Predictive Contact Search Algorithm 1 main class

*

*/

#ifndef C_PCS_ALGORITHM_1_UTILS

#define C_PCS_ALGORITHM_1_UTILS

// INCLUDE FILES

#include <e32hashtab.h>

// FORWARD DECLARATION

typedef RPointerArray<CPsData> CPSDATA_R_PTR_ARRAY;

// CLASS DECLARATION

class CPcsAlgorithm1Utils : public CBase

{

	public: 

		/**

		 * Merge function to merge the search results from different arrays

		 * into a single array in sorted order.

		 * It merges all the result sets that are there in iSearchResultsArr

         * into single result set. This is a wrapper funciton implemented that

         * works for all type of key board modes

		 */

		static void FormCompleteSearchResultsL(RPointerArray<CPSDATA_R_PTR_ARRAY>& aSearchResultsArr, 

										       RPointerArray<CPsData>& SearchResults);

		/**

		 * Compare by length.

		 */

		/**

		 * Compare strings exactly case sensitively.

		 */

		static TBool CompareExact(const TDesC& aFirst, const TDesC& aSecond);

		/**

		 * Compare strings with collate rules depending on locale.

		 */

		/**

		 * Compare for keys and strings:

		 * - Case sensitive compare for keys,

		 * - Case insensitive and language dependent compare for Contact Data and Query.

		 */

		static TBool MyCompareKeyAndString(const TDesC& aContactString,

		                                   const TDesC& aQueryAsString,

		                                   CPsQuery& aPsQuery);

		/**

         * Case Sensitive compare for keys

         */

		static TBool MyCompareK(const TDesC& aLeft, const TDesC& aRight, CPsQuery& aPsQuery);

		/**

        /**

         * TLinearOrder rule for comparison of data objects

         */

        static TInt CompareDataBySortOrderL(const CPsData& aObject1,

        /**

         * Trim off all white spaces and special chars

        static void MyTrim(TDes& aString);

        /**

         * Check if the input URI is of contact search in a group template form

        static TBool IsGroupUri(TDesC& aURI);

};

#endif // C_PCS_ALGORITHM_1_UTILS