class CContactItemFieldSet : public CBase |
A contact item's field set. The field set owns an array of contact item fields (CContactItemFields). The field set is owned by a contact item, and can be retrieved using CContactItem::CardFields() . Use functions in class CContactItem to add and remove fields to/from the field set.
A field set can contain more than one field of the same type, but this is not advisable as it may cause problems when synchronising the contacts database.
Private Member Functions | |
---|---|
CContactItemFieldSet () | |
void | ConstructL () |
const CContactItemField * | FindById ( TInt ) |
HBufC * | LoadTextStreamLC ( RReadStream &) |
TInt | MatchTemplateField (const CContentType &, TUint , TBool &) |
void | NonZeroFieldText ( TFieldType , TDes &) |
void | RestoreAndAddTemplateL ( CStreamStore &, TStreamId , CStreamStore *, const CContactItemViewDef &, const CContactItem *, RReadStream &, CContactTables *, RArray < TInt > *) |
void | RestoreL ( CStreamStore &, TStreamId , CStreamStore *, const CContactItemViewDef &, const CContactItem *, RReadStream &, CContactTables *, RArray < TInt > *) |
void | SetFieldId ( CContactItemField &) |
IMPORT_C TStreamId | StoreL ( CStreamStore &, const CContactItem *, RWriteStream &, CStreamStore &, CContactTables *) |
Private Attributes | |
---|---|
CArrayPtr < CContactItemField > * | iFields |
IMPORT_C | ~CContactItemFieldSet | ( | ) |
The destructor frees all resources owned by the field set, prior to its destruction.
IMPORT_C CContactItemFieldSet & | AddL | ( | CContactItemField & | aField | ) |
Appends a field to the field set. The field set takes ownership of the field.
CContactItemField & aField | Reference to the field to add to the field set. The field's ID is updated. |
CArrayFix < TFieldHeader > * | ConstructFieldHeaderArrayLC | ( | RWriteStream & | aTextStream, |
CStreamStore & | aBlobStore | |||
) |
RWriteStream & aTextStream | |
CStreamStore & aBlobStore |
TBool | ContainsFieldTypeMapping | ( | const CContentType & | aBaseFieldContentType, |
const TFieldType & | aContactFieldType | |||
) | const |
const CContentType & aBaseFieldContentType | |
const TFieldType & aContactFieldType |
void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
Externalises a CContactItemFieldSet object to a write stream.
RWriteStream & aStream | Stream to which the object should be externalised. |
TInt | FieldText | ( | TFieldType | aFieldType, |
TDes & | aText, | |||
TInt | aStartPosition | |||
) | const |
TFieldType aFieldType | |
TDes & aText | |
TInt aStartPosition |
TInt | FieldTypeCount | ( | const CContactItemFieldSet & | aSystemTemplateFields, |
TInt | aStartIndex, | |||
const CContactItemField & | aField | |||
) | const |
const CContactItemFieldSet & aSystemTemplateFields | |
TInt aStartIndex | |
const CContactItemField & aField |
TInt | Find | ( | TFieldType | aFieldType | ) | const [inline] |
Finds the first field in the field set with the specified field type.
TFieldType aFieldType | The field type of interest. |
TInt | Find | ( | TFieldType | aFieldType, |
TUid | aMapping | |||
) | const [inline] |
Finds the first field in the field set containing both the content type mapping and the field type specified.
TFieldType aFieldType | The field type of interest. |
TUid aMapping | The content type mapping of interest. |
IMPORT_C TInt | FindNext | ( | TFieldType | aFieldType, |
TInt | aStartPos = KContactFieldSetSearchAll | |||
) | const |
Finds the next field in the field set with the specified field type.
TFieldType aFieldType | The field type of interest. |
TInt aStartPos = KContactFieldSetSearchAll | The index within the field set array at which to start the search. By default set to KContactFieldSetSearchAll, to find the first field. Must be a valid array index, or the function raises a panic. |
IMPORT_C TInt | FindNext | ( | TFieldType | aFieldType, |
TUid | aMapping, | |||
TInt | aStartPos = KContactFieldSetSearchAll | |||
) | const |
Finds the next field in the field set containing both the content type mapping and the field type specified.
TFieldType aFieldType | The field type of interest. |
TUid aMapping | The content type mapping of interest. |
TInt aStartPos = KContactFieldSetSearchAll | The index within the array at which to start the search. By default set to KContactFieldSetSearchAll, to find the first field. Must be a valid array index, or the function raises a panic. |
IMPORT_C void | InsertL | ( | TInt | aIndex, |
CContactItemField & | aField | |||
) |
Inserts a field into the field set.
TInt aIndex | The position in the field set at which to insert the field. If equal to or greater than the number of elements in the field set, the field is appended to the field set. |
CContactItemField & aField | Reference to the field to add to the field set. The field's ID is updated. |
void | InternalizeL | ( | RReadStream & | aStream | ) |
Internalises a CContactItemFieldSet object from a read stream.
RReadStream & aStream | Stream from which the object should be internalised. |
HBufC * | LoadTextStreamLC | ( | RReadStream & | aStream | ) | [private, static] |
RReadStream & aStream |
TInt | MatchTemplateField | ( | const CContentType & | aContentType, |
TUint | aUserFlags, | |||
TBool & | aExactMatch | |||
) | const [private] |
Find and return the index of the best matched template field. The method uses a matching algorithm which compares the content type of the template fields with that of the incoming contact item.
Matching Algorithm Steps: ========================
The algorithm is based on a scoring mechanism counting 'hits' and 'misses' in order to find the best possible field match within the fieldset of the template.
1. Loop through all the contact item fields of the template.
For each template field:
2. Perform a strict, or exact, match between the vCard mappings of the template field and the field to be matched. 3. If the vCard mappings match exactly, compare User Flags values and amend the overall score accordingly. 4. Loop through all the field types (TFieldType array) stored as part of the content type of the field to be matched.
For each field type of the field to be matched:
5. Loop through the field types of the iterated template field to find a field type match. Amend the 'hits' and 'misses' count accordingly. 6. Calculate the overall score weighing the 'hits' and 'misses' count. 7. Amend the overall score count in order to account for special cases (e.g. user defined fields) 8. Compare the overall score with the best score. If score > current best score, replace the 'bestScore' count and 'bestMatch' index.
9. Return the 'bestMatch' field index of the template field.
const CContentType & aContentType | The content type of the field to find a match for. |
TUint aUserFlags | The user flags of the field to find a match for. |
TBool & aExactMatch | Boolean to indicate an exact field match within the template. |
IMPORT_C void | Move | ( | TInt | aFrom, |
TInt | aTo | |||
) |
Changes a field's position within the field set.
Both indexes specified must be valid (i.e. between zero and Count() -1 inclusive), or the function raises a panic.
IMPORT_C CContactItemFieldSet * | NewLC | ( | ) | [static] |
Allocates and constructs a new field set.
void | NonZeroFieldText | ( | TFieldType | aFieldType, |
TDes & | aText | |||
) | const [private] |
Get the first non-empty text field
TFieldType aFieldType | |
TDes & aText |
IMPORT_C void | Remove | ( | TInt | aIndex | ) |
Removes a field from the field set.
TInt aIndex | The index of the field to delete. Must be a valid index within the field set or the function raises a panic. |
void | RestoreAndAddTemplateL | ( | CStreamStore & | aStore, |
TStreamId | aId, | |||
CStreamStore * | aBlobStore, | |||
const CContactItemViewDef & | aViewDef, | |||
const CContactItem * | aTemplate, | |||
RReadStream & | aReadStream, | |||
CContactTables * | aContactsTable, | |||
RArray < TInt > * | aEmailIdArray | |||
) | [private] |
CStreamStore & aStore | |
TStreamId aId | |
CStreamStore * aBlobStore | |
const CContactItemViewDef & aViewDef | |
const CContactItem * aTemplate | |
RReadStream & aReadStream | |
CContactTables * aContactsTable | |
RArray < TInt > * aEmailIdArray |
IMPORT_C void | RestoreL | ( | CStreamStore & | aStore, |
TStreamId | anId, | |||
CStreamStore * | aBlobStore, | |||
const CContactItemViewDef & | aViewDef, | |||
RReadStream & | aReadStream | |||
) |
Restores the field set using a view definition.
CStreamStore & aStore | Store from which to restore the field set. |
TStreamId anId | The root stream ID of aStore. |
CStreamStore * aBlobStore | If specified, the stream store from which data stored in non-text fields is read. |
const CContactItemViewDef & aViewDef | The view definition to use. |
RReadStream & aReadStream | Read stream from which data stored in text fields (with a storage type of KStorageTypeText) is read. |
IMPORT_C void | RestoreL | ( | CStreamStore & | aStore, |
TStreamId | anId, | |||
CStreamStore * | aBlobStore, | |||
const CContactItemViewDef & | aViewDef, | |||
const CContactItem * | aTemplate, | |||
HBufC * | aTextBuf | |||
) |
The overload that doesn't use dangerous CContactItemFieldSet::LoadTextStreamLC(aReadStream) method. LoadTextStreamLC relies on the stream to know its size, but now all types of streams support this functionality. In order to avoid calling LoadTextStreamLC, aTextBuf is already loaded in HBufC in the caller function. The caller function had access to the table and can use ColLength() API to get the lebgth of the field.
CStreamStore & aStore | |
TStreamId anId | |
CStreamStore * aBlobStore | |
const CContactItemViewDef & aViewDef | |
const CContactItem * aTemplate | |
HBufC * aTextBuf |
void | RestoreL | ( | CStreamStore & | aStore, |
TStreamId | anId, | |||
CStreamStore * | aBlobStore, | |||
const CContactItemViewDef & | aViewDef, | |||
const CContactItem * | aTemplate, | |||
RReadStream & | aReadStream, | |||
CContactTables * | aContactsTable, | |||
RArray < TInt > * | aEmailIdArray | |||
) | [private] |
CStreamStore & aStore | |
TStreamId anId | |
CStreamStore * aBlobStore | |
const CContactItemViewDef & aViewDef | |
const CContactItem * aTemplate | |
RReadStream & aReadStream | |
CContactTables * aContactsTable | |
RArray < TInt > * aEmailIdArray |
void | SetFieldId | ( | CContactItemField & | aField | ) | [private] |
CContactItemField & aField |
IMPORT_C TStreamId | StoreL | ( | CStreamStore & | aStore, |
RWriteStream & | aTextStream, | |||
CStreamStore & | aBlobStore | |||
) |
Stores the field set to a stream store.
CStreamStore & aStore | Stream store to which the field set is written. |
RWriteStream & aTextStream | Stream to which data stored in text fields (with a storage type of KStorageTypeText) is written. |
CStreamStore & aBlobStore | Stream store to which data stored in non-text fields is written. |
TStreamId | StoreL | ( | CStreamStore & | aStore, |
RWriteStream & | aTextStream, | |||
CStreamStore & | aBlobStore, | |||
CContactTables * | aTables | |||
) |
CStreamStore & aStore | |
RWriteStream & aTextStream | |
CStreamStore & aBlobStore | |
CContactTables * aTables |
IMPORT_C TStreamId | StoreL | ( | CStreamStore & | aStore, |
const CContactItem * | aTemplate, | |||
RWriteStream & | aStream, | |||
CStreamStore & | aBlobStore, | |||
CContactTables * | aTables | |||
) | [private] |
CStreamStore & aStore | |
const CContactItem * aTemplate | |
RWriteStream & aStream | |
CStreamStore & aBlobStore | |
CContactTables * aTables |
IMPORT_C void | UpdateFieldL | ( | const CContactItemField & | aField, |
TInt | aMatchCount | |||
) |
Updates a field in the field set. The field whose content type matches aField's content type is replaced by aField. The second parameter is used to identify which matching field is updated. Specify 1 to update the first matching field, 2 for the second and so on. If there is no field in the field set which matches aField's content type, then aField is appended to the field set.
const CContactItemField & aField | The new field information. |
TInt aMatchCount | Identifies which matching field in the field set should be updated. |
IMPORT_C void | UpdateFieldSyncL | ( | const CContactItemField & | aField, |
TInt | aMatchCount | |||
) |
Updates a field in the field set. Searches the set for a matching field. Deletes the matching set's field if any. Adds the aField to the set anyway. Uses the IsEqualForSyncUpdate() function to compare two CContentType objects, rather than the default equals operator. Takes care to hold the PREF, VoiceDial, and SpeedDial properties in the updated field.
const CContactItemField & aField | Specifies both the type of the field to update and the updated field's value. |
TInt aMatchCount | Gives the offset of the matching field to update in the order of the set (i.e. 1, means update the first matching field in the set; 2, means update the second matching field in the set). |
const CContactItemField & | operator[] | ( | TInt | aIndex | ) | const [inline] |
Gets the field located at a specified position in the field set.
TInt aIndex | The position of the field in the field set. This is relative to zero. It must be non-negative and less than the number of objects in the array, otherwise the operator raises a panic. |
CContactItemField & | operator[] | ( | TInt | aIndex | ) | [inline] |
Gets the field located at a specified position in the field set.
TInt aIndex | The position of the field in the field set. This is relative to zero. It must be non-negative and less than the number of objects in the array, otherwise the operator raises a panic. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.