Constructs the recognizer with a UID and a priority.

Typically, a derived class constructor calls this constructor through a constructor initialization list.

The UID is the way that a recognizer is detected by the framework.

CApaDataRecognizerType::TRecognizerPriority

Implements the attempt to recognize data.

Recognizers should provide an implementation of this function in a derived class. Note that, when the implementation recognizes data, it must put the result of the operation in the iDataType and iConfidence data members.

Note that if more data is required than is provided in aBuffer, then CApaDataRecognizerType::FilePassedByHandleL should be called and the data read from the returned RFile (if not NULL). If this returns NULL, it may be possible to retrieve the data by calling RFile::Open() on aName, but only if aName is a legal file-name. It may be something else, such as a URL.

The default implementation does not recognize data.

RecognizeL() FilePassedByHandleL()

Returns the RFile (if any) of file to be recognized.

This function returns the file passed by handle from the client-side (i.e. from calls to the RFile-parameter overloads of RApaLsSession's RecognizeData, RecognizeSpecificData, AppForDocument and StartDocument). The function returns NULL if the file to be recognized was not passed by handle.

It may only be called from implementations of DoRecognizeL - indeed the purpose of this function is logically to provide an extra parameter to the virtual DoRecognizeL function. All references/pointers to the RFile object returned must be discarded when the implementation of DoRecognizeL returns.

The RFile returned (if any) may be used by implementations of DoRecognizeL to retrieve more data than is provided in DoRecognizeL's aBuffer parameter.

The current-position of the returned RFile is the start of the file.

DoRecognizeL()

Tests whether the recognizer is locked.

Lock() Unlock()

Gets the number of data (MIME) types supported by this recognizer.

iCountDataTypes

Attempts to recognize data.

This function is called by the Application Architecture server as a result of client calls to the server through an instance of RApaLsSession.

The function calls DoRecognizeL() which implements recognition behaviour.

PreferredBufSize() RApaLsSession RApaLsSession::SetMaxDataBufSize()

Gets one of the data (MIME) types that the recognizer can recognize.

Gets the UID that identifies the recognizer.

Removes a lock from the recognizer.

All calls to Lock() should be matched by a corresponding call to this function. The recognizer is not unlocked until all calls to Lock() have been matched by corresponding calls to this function.

Lock() Locked()

Refreshes the list of data (MIME) types supported by this recognizer.

A set of values describing the probability that the recognizer assigns to its belief that the most recently sampled data is of the type ascribed to it.

A set of values used to indicate the probability that the recognizer will successfully identify data. The Application Architecture framework uses this set to determine the order in which recognizers are invoked.

CApaDataRecognizerType() Priority()

The recognizer's confidence rating of the most recently recognized data.

Users of the derived class use Confidence() to get this value.

The number of data (MIME) types supported by this recognizer. Typically, this is set during construction of an instance of the derived class.

Users of the derived class use MimeTypesCount() to get this value.

The data (MIME) type of the most recently recognized data.

Users of the derived class use MimeType() to get this value.