Collapse all Symbian^3 Application Developer Library

CPosLmMultiDbSearch Class Reference

class CPosLmMultiDbSearch : public CBase

CPosLmMultiDbSearch is used to perform searches for landmarks or landmark categories in multiple databases.

The client can specify which databases to search.

Some criterion classes are used for searching for landmarks (e.g. CPosLmCategoryCriteria is used for searching for landmarks which contain a certain category) and some are used to search for landmark categories (e.g. CPosLmCatNameCriteria is used to search for landmark categories by specifying a category name).

Searches can be run in incremental mode. StartLandmarkSearchL and StartCategorySearchL both return a CPosLmOperation object which is used to execute the search. If it is sufficient to run the search synchronously, the client only has to call CPosLmOperation::ExecuteL . If it is run incrementally the client can supervise the progress of the operation. The CPosLmOperation::NextStep function in the search operations cannot be executed synchronously using User::WaitForRequest . Doing so may cause the operation to hang. CPosLmOperation::NextStep must be run using an active object. The client can cancel the search by deleting the CPosLmOperation object.

By default, these functions start a new search, but the client can specify that only previous matches should be searched. This can be used to refine the search when there are many matches.

It is not allowed to search by category item ID in CPosLmCategoryCriteria since an item ID is only valid in one landmark database.

It is only allowed to specify a named category, a global category, or no category. It is not allowed to search with CPosLmIdListCriteria since an item ID is only valid in one landmark database. In both cases the search functions leave with error code KErrArgument .

During the search execution, a read-lock is acquired for each database. Only one search can be performed at a time by the single instance of the class. If a search is already running, the search function leaves with error code KErrInUse .

After search completion, the client can make a second search and specify that only the matches from the previous search shall be considered.

The client can also set a limit on how many search matches should be returned (see SetMaxNumOfMatches ).

The client retrieves the matches from the search by requesting an iterator (see MatchIteratorL ) or by using display data (see SetDisplayData ).

If CPosLmMultiDbSearch is used, the client must call the global function ReleaseLandmarkResources before terminating in order to release all used landmark resources, otherwise the client may receive an ALLOC panic.

NetworkServices capability is required for remote databases.

eposlmmultidbsearch.lib

Since: S60 3.0

Version

Revision:

1.17

, Date:

2005/07/07 13:40:10

Inherits from

CPosLmMultiDbSearch
- CBase

Nested Classes and Structures

CPosLmMultiDbSearch::TSearchError

Public Member Functions
	~CPosLmMultiDbSearch ()
void	AddSearchError ( TUint , TInt )
CPosLandmarkDatabase *	DatabaseL ( TUint )
IMPORT_C TPtrC	DatabaseUriPtr ( TUint )
IMPORT_C CDesCArray *	DatabasesToSearchL ()
IMPORT_C void	GetSearchError ( TUint , TSearchError &)
void	HandleSearchOperationCompleted ()
IMPORT_C CPosLmItemIterator *	MatchIteratorL ( TUint )
IMPORT_C TInt	MaxNumOfMatches ()
IMPORT_C CPosLmMultiDbSearch *	NewL (const CDesCArray &)
IMPORT_C TUint	NumOfDatabasesToSearch ()
IMPORT_C TUint	NumOfMatches ( TUint )
IMPORT_C TUint	NumOfSearchErrors ()
void	SearchExecutedL ( TUint , const CPosLmMultiDbSortPref &)
void	SearchStarted ( TUint )
CPosLandmarkSearch *	SearcherL ( TUint )
IMPORT_C void	SetDatabasesToSearchL (const CDesCArray &)
IMPORT_C void	SetDisplayData ( CPosLmDisplayData &)
IMPORT_C void	SetMaxNumOfMatches ( TInt )
IMPORT_C CPosLmOperation *	StartCategorySearchL (const CPosLmSearchCriteria &, CPosLmCategoryManager::TCategorySortPref , TBool )
IMPORT_C CPosLmOperation *	StartLandmarkSearchL (const CPosLmSearchCriteria &, TBool )
IMPORT_C CPosLmOperation *	StartLandmarkSearchL (const CPosLmSearchCriteria &, const TPosLmSortPref &, TBool )
TBool	ToBeSearched ( TUint )
IMPORT_C TUint	TotalNumOfMatches ()
IMPORT_C void	UnsetDisplayData ()

Private Member Functions
	CPosLmMultiDbSearch ()
void	CloseDbsNotToSearch (const CDesCArray &)
void	ConstructL (const CDesCArray &)
CPosLmOperation *	StartSearchL (const CPosLmSearchCriteria &, CPosLmMultiDbSortPref *, TBool )

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CPosLmDisplayData *	iClientDisplayData
TInt	iMaxNumOfMatches
CPosLmMultiDbSearchOperation *	iMultiSearchOperation
TInt	iNewMaxNumOfMatches
TUint	iNoOfSearchErrors
RArray < TSearchError >	iSearchErrors
RPointerArray < CPosLmMultiDbSearchItem >	iSearchItems

Constructor & Destructor Documentation

CPosLmMultiDbSearch()

CPosLmMultiDbSearch

(

)

[private]

C++ default constructor.

~CPosLmMultiDbSearch()

IMPORT_C

~CPosLmMultiDbSearch

(

)

[virtual]

Destructor.

Member Functions Documentation

AddSearchError(TUint, TInt)

void	AddSearchError	(	TUint	aDatabaseIndex,
			TInt	aErrorCode
		)

Parameters

TUint aDatabaseIndex
TInt aErrorCode

CloseDbsNotToSearch(const CDesCArray &)

void

CloseDbsNotToSearch

(

const CDesCArray &

aDatabaseList

)

[private]

Parameters

const CDesCArray & aDatabaseList

ConstructL(const CDesCArray &)

void

ConstructL

(

const CDesCArray &

aDatabaseList

)

[private]

By default Symbian 2nd phase constructor is private.

Parameters

const CDesCArray & aDatabaseList

DatabaseL(TUint)

CPosLandmarkDatabase *

DatabaseL

(

TUint

aDatabaseIndex

)

Parameters

TUint aDatabaseIndex

DatabaseUriPtr(TUint)

IMPORT_C TPtrC

DatabaseUriPtr

(

TUint

aDatabaseIndex

)

const

Returns the URI of a database involved in the search.

The client specifies an index of the database URI to retrieve. The index must be strictly less than NumOfDatabasesToSearch , otherwise this function will panic with code EPosInvalidIndex .

Since: S60 3.0

Parameters

TUint aDatabaseIndex

The index of the database URI to retrieve.

DatabasesToSearchL()

IMPORT_C CDesCArray *

DatabasesToSearchL

(

)

Returns the list of databases to search. Ownership is transferred to the caller.

GetSearchError(TUint, TSearchError &)

IMPORT_C void	GetSearchError	(	TUint	aErrorIndex,
			TSearchError &	aSearchError
		)	const

Returns errors encountered in the search.

The client specifies an index of the error to retrieve. The index must be strictly less than NumOfSearchErrors , otherwise this function panics with code EPosInvalidIndex . Whenever a new search is started this function must be called again to retrieve error codes, if any.

Since: S60 3.0

Parameters

TUint aErrorIndex	The index of the error to retrieve.
TSearchError & aSearchError	On return, contains the search error.

HandleSearchOperationCompleted()

void

HandleSearchOperationCompleted

(

)

MatchIteratorL(TUint)

IMPORT_C CPosLmItemIterator *

MatchIteratorL

(

TUint

aDatabaseIndex

)

Creates an iterator object to iterate the matching landmarks or categories from one of the databases involved in the search.

The database to get search matches for is specified by index. The index must be strictly less than NumOfDatabasesToSearch , otherwise this function will panic with code EPosInvalidIndex . The URI of the database can be retrieved by calling DatabaseUriPtr .

This function can also be called during a search in order to read the matches encountered so far. Note that the iterator will not iterate any new matches. If new matches are found, a new iterator needs to be created to retrieve them. The previous matches will also be included.

If the client has started a search, but no matches have been found yet in the database, an empty iterator is returned.

If a sort preference was specified when the search was started, the landmarks or categories will be sorted when the search is complete but the items are not necessarily sorted if this function is called during a search.

The client takes ownership of the returned iterator object.

Note: The iterator iterates matches in CPosLmMultiDbSearch . It cannot be used after the search object has been deleted.

Since: S60 3.0

Parameters

TUint aDatabaseIndex

The index of the database to get search matches for.

MaxNumOfMatches()

IMPORT_C TInt

MaxNumOfMatches

(

)

const

Retrieves the maximum number of search matches limit for each database.

By default the maximum number of matches is unlimited.

NewL(const CDesCArray &)

IMPORT_C CPosLmMultiDbSearch *

NewL

(

const CDesCArray &

aDatabaseList

)

[static]

Two-phased constructor.

Leaves with KErrArgument if the database list is empty.

Parameters

const CDesCArray & aDatabaseList

An array containing the URIs of the landmark databases to be used in the search.

NumOfDatabasesToSearch()

IMPORT_C TUint

NumOfDatabasesToSearch

(

)

const

Returns the number of databases involved in the search.

Since: S60 3.0

NumOfMatches(TUint)

IMPORT_C TUint

NumOfMatches

(

TUint

aDatabaseIndex

)

const

Returns the number of matches so far in the search for a database specified by index.

The index must be strictly less than NumOfDatabasesToSearch , otherwise this function will panic with code EPosInvalidIndex . The URI of the database can be retrieved by calling DatabaseUriPtr .

This function can also be called during a search operation.

Parameters

TUint aDatabaseIndex

The index of the database to get number of search matches for.

NumOfSearchErrors()

IMPORT_C TUint

NumOfSearchErrors

(

)

const

Returns the number of errors encountered during the search. This is the same as number of databases in which the search has failed.

Since: S60 3.0

SearchExecutedL(TUint, const CPosLmMultiDbSortPref &)

void	SearchExecutedL	(	TUint	aDatabaseIndex,
			const CPosLmMultiDbSortPref &	aSortPref
		)

Parameters

TUint aDatabaseIndex
const CPosLmMultiDbSortPref & aSortPref

SearchStarted(TUint)

void

SearchStarted

(

TUint

aDatabaseIndex

)

Parameters

TUint aDatabaseIndex

SearcherL(TUint)

CPosLandmarkSearch *

SearcherL

(

TUint

aDatabaseIndex

)

Parameters

TUint aDatabaseIndex

SetDatabasesToSearchL(const CDesCArray &)

IMPORT_C void

SetDatabasesToSearchL

(

const CDesCArray &

aDatabaseList

)

Specifies the list of databases that should be used in the search.

If this function is called and then StartLandmarkSearchL or StartCategorySearchL is called with the flag aSearchOnlyPreviousMatches set, new databases that were not a part of the previous search will generate no matches.

If the client specifies database(s) that do not exist, GetSearchError will report error code KErrNotFound for those databases after the search is started.

This function will leave with KErrInUse if called during a search.

If this function is called after a search has completed, database indexes in the results may become invalid.

If a database is removed from a previously set list, the search result of that database is unavailable after this function is called. Search errors are reset after this function is called.

Leaves with KErrArgument if the database list is empty.

Since: S60 3.0

Parameters

const CDesCArray & aDatabaseList

An array containing the URIs of the landmark databases to be used in the search.

SetDisplayData(CPosLmDisplayData &)

IMPORT_C void

SetDisplayData

(

CPosLmDisplayData &

aData

)

Display data can be used as an alternative way to get result from a database search. Landmarks or categories are added to the display data collection during a search depending on the search type.

This function may replace the combination of using MatchIteratorL and reading landmark or category data. Result data is read already during the search and no duplicate access to database is needed.

The display data object will be reset each time a new search is started. No items during the search are removed from the collection. New found matches can be added every time next search step is completed, see CPosLmDisplayData::NewItemIndex .

If the client sets display data during an ongoing search, this function panics with code EPosSearchOperationInUse .

The client owns the display data object. If the client deletes it during a search, this may lead to unexpected errors. The client must call UnsetDisplayData before it deletes the display data object.

Search results from all databases are collected in the same displayable data collection. The CPosLmDisplayItem::DatabaseIndex may be used to know which database every displayable item belongs to. The database index matches databases specified in this object, see DatabaseUriPtr .

Parameters

CPosLmDisplayData & aData

The displayable data.

SetMaxNumOfMatches(TInt)

IMPORT_C void

SetMaxNumOfMatches

(

TInt

aMaxNumOfMatches = KPosLmMaxNumOfMatchesUnlimited

)

Sets the maximum number of search matches limit for each database.

This function is used to limit the number of matches retrieved from each database in the search operation. If the limit is set, the search operation will stop when this limit is reached. By default the maximum number of matches is unlimited.

If a new value for maximum number of matches is set when a search is ongoing, it will not affect the current search. The new maximum will be utilized in the next search.

Since: S60 3.0

Parameters

TInt aMaxNumOfMatches = KPosLmMaxNumOfMatchesUnlimited

The maximum number of search matches for each landmark database involved in the search.

StartCategorySearchL(const CPosLmSearchCriteria &, CPosLmCategoryManager::TCategorySortPref, TBool)

IMPORT_C CPosLmOperation *	StartCategorySearchL	(	const CPosLmSearchCriteria &	aCriteria,
			CPosLmCategoryManager::TCategorySortPref	aSortPref,
			TBool	aSearchOnlyPreviousMatches = EFalse
		)

Starts a search for landmark categories.

If there are no previous matches and the client specifies that previous matches should be used, this function leaves with error code KErrArgument ...

The criterion, which defines if a landmark category is a match, is passed as input to this function.

If a search is already running, this function leaves with error code KErrInUse .

If the search criterion is not valid for landmark category searching, this function leaves with error code KErrArgument .

If the search criterion is not supported, this function leaves with error code KErrNotSupported .

The client takes ownership of the returned operation object.

This function requires ReadUserData capability.

Parameters

const CPosLmSearchCriteria & aCriteria	The search criteria.
CPosLmCategoryManager::TCategorySortPref aSortPref	Sort preference for the search results.
TBool aSearchOnlyPreviousMatches = EFalse	This flag may be used to perform a search within the results of previous search.

StartLandmarkSearchL(const CPosLmSearchCriteria &, TBool)

IMPORT_C CPosLmOperation *	StartLandmarkSearchL	(	const CPosLmSearchCriteria &	aCriteria,
			TBool	aSearchOnlyPreviousMatches = EFalse
		)

Starts a landmark search.

If there are no previous matches and the client specifies that previous matches should be used, this function leaves with error code KErrArgument .

If a search is already running, this function leaves with error code KErrInUse .

If the search criterion is not valid for landmark searching, this function leaves with error code KErrArgument .

If the search criterion is not supported, this function leaves with error code KErrNotSupported .

If CPosLmIdListCriteria is used or CPosLmCategoryCriteria with item ID set, this function leaves with error code KErrArgument .

The client takes ownership of the returned operation object.

This function requires ReadUserData capability.

Since: S60 3.0

Parameters

const CPosLmSearchCriteria & aCriteria	The search criterion.
TBool aSearchOnlyPreviousMatches = EFalse	This flag may be used to perform a search within the results of previous search.

StartLandmarkSearchL(const CPosLmSearchCriteria &, const TPosLmSortPref &, TBool)

IMPORT_C CPosLmOperation *	StartLandmarkSearchL	(	const CPosLmSearchCriteria &	aCriteria,
			const TPosLmSortPref &	aSortPref,
			TBool	aSearchOnlyPreviousMatches = EFalse
		)

Starts a landmark search.

This overload of the StartLandmarkSearchL function lets the client define the sort order for the search matches.

Only sorting by landmark name is supported. If the client tries to sort by another attribute, this function leaves with error code KErrNotSupported .

If there are no previous matches and the client specifies that previous matches should be used, this function leaves with error code KErrArgument .

If a search is already running, this function will leave with error code KErrInUse .

If the search criterion is not valid for landmark searching, this function leaves with error code KErrArgument .

If the search criterion is not supported, this function will leave with error code KErrNotSupported .

If CPosLmIdListCriteria is used or CPosLmCategoryCriteria with item ID set, this function leaves with error code KErrArgument .

The client takes ownership of the returned operation object.

This function requires ReadUserData capability.

Since: S60 3.0

Parameters

const CPosLmSearchCriteria & aCriteria	The search criterion.
const TPosLmSortPref & aSortPref	A sort preference object.
TBool aSearchOnlyPreviousMatches = EFalse	This flag may be used to perform a search within the results of previous search.