/*

* Copyright (c) 2006-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:  Identifies a contact in cache pools

*

*/

#ifndef C_PCS_ALGORITHM_2

#define C_PCS_ALGORITHM_2

// INCLUDES

#include <e32cmn.h>

#include <s32mem.h>

#include <e32hashtab.h>

#include <e32property.h>

#include <centralrepository.h>

#include "PSAlgorithmInternalCRKeys.h"

#include "CPcsPlugin.h"

#include "CPsData.h"

#include "CPsClientData.h"

#include "CPcsCache.h"

#include "CPcsKeyMap.h"

#include "CPsQuery.h"

#include "CPsPattern.h"

#include "mdatastoreobserver.h"

#include "mstorelistobserver.h"

#include <FindUtil.h>

const TInt KSpace = 32;

// FORWARD DECLARATION

class CPsData;

class CPsClientData;

class CPsDataPluginInterface;

class CPsQuery;

class CPcsAlgorithm2Helper;

class CPcsAlgorithm2MultiSearchHelper;

class CPtiEngine;

class CRepository;

class CFindUtilChineseECE;

class CFindUtil;

// CLASS DECLARATION

class CPcsAlgorithm2 : public CPcsPlugin,

public MDataStoreObserver,

    {

public: 

    /**

     * Two phase construction

     */

    static CPcsAlgorithm2* NewL();

    /**

     * Destructor

     */

    virtual ~CPcsAlgorithm2();

public:

    // ------------------------ From base class CPcsPlugin ----------------

    /**

     * Search Function for cache

     */

    void PerformSearchL(const CPsSettings& aPcsSettings,

        CPsQuery& aCondition,

        RPointerArray<CPsClientData>& aData,

    /**

     * Search Function for input string

     */

    void SearchInputL(CPsQuery& aSearchQuery,

        TDesC& aSearchData,

        RPointerArray<TDesC>& aMatchSet,

    /**

    * Performs search on a input string, and return result also as a string 

    */

    void  SearchMatchStringL( CPsQuery& aSearchQuery,

    /**

     * Returns ETrue if this language is supported

     */

    TBool IsLanguageSupportedL(const TUint32 aLanguage);

    /**

     * Returns supported data fields for a cache

     */		                     

    void GetDataOrderL( TDesC& aURI, RArray<TInt>& aDataOrder );

    /**

     * Returns supported sort order for a cache

     */		                     

    void GetSortOrderL( TDesC& aURI, RArray<TInt>& aDataOrder );

    /**

     * Sets the sort order for a cache

     */

    void ChangeSortOrderL(TDesC& aURI, RArray<TInt>& aSortOrder);

    // --------------------------------------------------------------------

public:

    // --------------- From base class MDataStoreObserver -----------------

    /** 

     * Add a contact to the cache

     */

    /** 

     */

    /**

     *  Removes all the contacts from a particular datastore

     */

    /**

     * Updates the caching status for a particular datastore

     */

    void UpdateCachingStatus(TDesC& aDataStore, TInt aStatus);

    // --------------------------------------------------------------------

public:

    // ----------------- From base class MStoreListObserver ---------------

    /**

     * This method is called whenever any new store has been added

     */

    /**

     * This method is called whenever a data store is removed

     */

    // --------------------------------------------------------------------

public:	

    /**

     * Returns the array index of cache (in iPcsCache) for a datastore

     */

    /** 

     * Return the cache instance at a specific array index

     */

    inline CPcsCache* GetCache(TInt aIndex) 

        {

        return iPcsCache[aIndex];

        }

    /**

     * Returns the key map instance

     */

    inline CPcsKeyMap* GetKeyMap() 

        { 

        return iKeyMap; 

private:

    /**

     * Constructor

     */

    CPcsAlgorithm2();

    /**

     * 2nd phase construtor

     */

    void ConstructL();

private:

    /**

     * Define a P&S property with given key under the internal category 

     * UID of PCS. Leave if definition fails for any other reason than

     * key already existing.

     */

    void DefinePropertyL( TPcsInternalKeyCacheStatus aPsKey );

    /**

     */

    /**

     * Search function helper

     */

    /**                

     * Search function helper

     */

    /**

     * Returns the index corresponding a URI in iDataStoreUri

     */

    /**

     * Function to return all cached content

     */

    /**

     * Checks if search is on groups

     */

    /**

     * Utility function to replace groups uri with that of contacts uri

     */

    /**

     * Filters the search results array for groups

     */

    void FilterSearchResultsForGroupsL(RArray<TInt>& aGroupContactIds,

        RPointerArray<CPsData>& aSearchResults);

    /**

     * Get the list of contact ids that belong to a group.

        RArray<TInt>& aGroupContactIds );

    /**

     * Read sort order for a data store from the central repository

     * @param aURI - The data store URI for which sort order is required

     * @param aSortOrder - The persisted sort order from the cenrep

     */

        RArray<TInt>& aSortOrder );

    /** Write sort order for a data store to the central repository

     * @param aURI - The data store URI for which sort order is to be persisted

     * @param aSortOrder - The sort order to be persisted	

     */

    /**

     * Utility function that sets the caching error value

    /**

     */

    /**

     * Function to return data base URI for an internal identifier

    /**

     * Inform clients about update happened on the cache

     */

    void HandleCacheUpdated( TCachingStatus aStatus );

    /**

    * launch plugins by idle

    */

     void DoLaunchPluginsL();

    /**

    * launch plugins

    */

     static TInt DoLaunchPluginsL(TAny* aPtr);

private:

    /**

     * Instance of contacts cache

     * Own

     */

    /**

     * Keeps the count of caches

     */

    /**

     * Instance of key map

     * Own.

     */

    CPcsKeyMap* iKeyMap;

    /**

     * Data plugin interface. Owned

     */

    CPsDataPluginInterface *iPsDataPluginInterface;

    /**

     * Instance of algorithm helper. Owned

     */

    CPcsAlgorithm2Helper* iHelper;

    CPcsAlgorithm2MultiSearchHelper* iMultiSearchHelper;

    /**

     * Global that keeps the updated status of the caching

     */

    TCachingStatus iCacheStatus;

    /**

     * Global that stores any error that occurs while caching

     */

    TInt iCacheError;

    // Own: Find util used to match contacts and construct character grid

    CFindUtilChineseECE* iFindUtilECE;

    /**

    * plugin laucher, make the plugin instantiation async

    */

    CIdle* iPluginLauncher;

    };

#endif // C_PCS_ALGORITHM_2