searchengine/cpix/cpix/inc/public/appclass-hierarchy.txt
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Thu, 27 May 2010 13:59:44 +0300
changeset 3 ae3f1779f6da
parent 2 6c1a2771f4b7
child 8 6547bf8ca13a
child 9 d575fd691cf9
permissions -rw-r--r--
Revision: 201019 Kit: 2010121
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
     1
Summary:
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
     2
This document summarizes the various content types and their fields that indexed by the CPiX engine.
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     3
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
     4
Note: 
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
     5
1. By default, all EIndexTokenized fields are aggregated, unless explicitly chosen to ENoAggregate.
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
     6
2. By default, the contents of all EIndexTokenized fields that are aggregated are meant to be added to the Excerpt field. 
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
     7
3. Any fields starting with an underscore (_) are designated as system fields and by default are neither aggregated nor added to excerpt field.
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
     8
4. The order of fields in the excerpt field is the order in which they appear below. The order has been chosen based on the 'Details/Edit' view of the corresponding application.
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     9
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    10
Legend for excerpt field:
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    11
ExcerptYes: the field has been chosen to be part of the excerpt field.
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    12
ExcerptNo : the field has been explicity opted out of the excerpt field (even though it is EIndexTokenized).
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    13
ExcerptNA : the field is not EIndexTokenized, and hence will not be applicable to be added to the excerpt field.
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    14
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    15
Indexed content types:
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    16
----------------------
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    17
  root
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    18
    | [ _docuid      ]        {EStoreYes | EIndexUnTokenized}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    19
    | [ _appclass    ]        {EStoreYes | EIndexTokenized}    
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    20
    | [ _appclass_ut ]        {EStoreNo  | EIndexUnTokenized}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    21
    | [ _aggregate   ]        {EStoreNo  | EIndexUnTokenized}     
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    22
    | [ _excerpt     ]        {EStoreYes | EIndexNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    23
    | [ _mimetype (opt) ]     {EStoreYes | EIndexNo}
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    24
    |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    25
    +-- msg
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    26
    | [ To         ]    {EStoreYes | EIndexTokenized} {ExcerptYes, if present}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    27
    | [ From       ]    {EStoreYes | EIndexTokenized} {ExcerptYes, if present}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    28
    | [ Body       ]    {EStoreYes | EIndexTokenized} {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    29
    | [ Folder     ]    {EStoreYes | EIndexNo}        {ExcerptNA}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    30
    | [ Subject    ]    {EStoreYes | EIndexTokenized} {ExcperptNo}
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    31
    |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    32
    |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    33
    +-- file
1
6f2c1c46032b Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 0
diff changeset
    34
    |     |
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    35
    |         |
2
6c1a2771f4b7 Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 1
diff changeset
    36
    |     +-- content
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    37
    |            | [ Contents  ]     {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    38
    |            | [ Name      ]     {EStoreYes | EIndexTokenized}   {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    39
    |            | [ BaseName  ]     {EStoreNo  | EIndexTokenized}   {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    40
    |            | [ Extension ]     {EStoreNo  | EIndexTokenized}      {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    41
    |            |
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    42
    |            +-- folder
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    43
    |              [ Name      ]     {EStoreYes | EIndexTokenized}      {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    44
    |              [ Extension ]     {EStoreYes | EIndexUnTokenized}    {ExcerptNA}
1
6f2c1c46032b Revision: 201015
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 0
diff changeset
    45
    |
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    46
    |      
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    47
    +-- media
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    48
    |     | 
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    49
    |     |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    50
    |     +-- audio
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    51
    |     | [ Name           ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    52
    |     | [ MediaId        ]    {EStoreYes | EIndexUnTokenized} {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    53
    |     | [ Title          ]    {EStoreYes | EIndexTokenized}   {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    54
    |     | [ ItemType       ]    {EStoreYes | EIndexUnTokenized} {ExcerptNo} 
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    55
    |     | [ Extension      ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    56
    |     | [ Album          ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    57
    |     | [ AlbumArtist    ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    58
    |     | [ OriginalArtist ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    59
    |     | [ Composer       ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    60
    |     | [ Artist         ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    61
    |     | 
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    62
    |     |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    63
    |     +-- image
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    64
    |     | [ Name           ]    {EStoreYes | EIndexTokenized}   {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    65
    |     | [ MediaId        ]    {EStoreYes | EIndexUnTokenized} {ExcerptNA}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    66
    |     | [ Title          ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    67
    |     | [ ItemType       ]    {EStoreYes | EIndexUnTokenized} {ExcerptNA}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    68
    |     | [ Extension      ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    69
    |     | [ Comment        ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    70
    |     | [ DateTimeOrignal]    {EStoreYes | EIndexUnTokenized} {ExcerptNA}
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    71
    |     |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    72
    |     |    
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    73
    |     +-- video
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    74
    |       [ Name           ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    75
    |       [ MediaId        ]    {EStoreYes | EIndexUnTokenized} {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    76
    |       [ Title          ]    {EStoreYes | EIndexTokenized}   {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    77
    |       [ ItemType       ]    {EStoreYes | EIndexUnTokenized} {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    78
    |       [ Extension      ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    79
    |       [ Artist         ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    80
    |       [ Author         ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    81
    |       [ Copyright      ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    82
    |       [ Description    ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    83
    |       [ Comment        ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    84
    |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    85
    |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    86
    +-- contact
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    87
	/* The order of fields in excerpt is as below. The order in this case
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    88
	 * is the order of fields shown when you 'Edit' the contact.
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    89
	 */
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    90
    | [ GivenName           ]    {EStoreYes | EIndexTokenized}   {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    91
    | [ FamilyName          ]    {EStoreYes | EIndexTokenized}   {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    92
    | [ PhoneNumber         ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    93
	| [ EMail               ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    94
	| [ SIPID               ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    95
	| [ CompanyName         ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    96
    | [ JobTitle            ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    97
    | [ Note                ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    98
	/* The following fields are not displayed when 'Edit'-ing the contact.
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
    99
	 * The order here is arbitrary.
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   100
	 */
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   101
    | [ Address             ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   102
    | [ SecondName          ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   103
    | [ Suffix              ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   104
    | [ URL                 ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   105
    | [ PostOffice          ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   106
    | [ ExtendedAddress     ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   107
    | [ Locality            ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   108
    | [ Region              ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   109
    | [ PostCode            ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   110
    | [ Country             ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   111
    | [ Spouse              ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   112
    | [ Children            ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   113
    | [ Class               ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   114
    | [ Prefix              ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   115
    | [ AdditionalName      ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   116
    | [ Fax                 ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   117
    | [ GivenNamePronunciation      ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   118
    | [ FamilyNamePronunciation     ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   119
    | [ CompanyNamePronunciation    ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   120
    |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   121
    |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   122
    +-- calendar
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   123
    | [ Summary         ]    {EStoreYes | EIndexTokenized}   {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   124
    | [ Description     ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   125
    | [ Location        ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   126
    | [ StartTime       ] (YYYYMMDDHHSS) (TimeZone UTC)    {EStoreYes | EIndexUnTokenized}   {ExcerptNA}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   127
    | [ EndTime         ] (YYYYMMDDHHSS) (TimeZone UTC)    {EStoreYes | EIndexUnTokenized}   {ExcerptNA}
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   128
    | 
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   129
    |    
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   130
    +-- bookmark
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   131
    | [ Name       ]    {EStoreYes | EIndexTokenized}   {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   132
    | [ Url        ]    {EStoreYes | EIndexTokenized}   {ExcerptYes}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   133
    |
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   134
    |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   135
    +-- applications
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   136
    | [ Name       ]    {EStoreYes | EIndexTokenized}                     {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   137
    | [ Uid        ]    {EStoreYes | EIndexTokenized | ENoAggregate}      {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   138
    | [ Path       ]    {EStoreYes | EIndexTokenized}                     {ExcerptNo}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   139
    |
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   140
    |
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   141
    +-- notes
3
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   142
    | [ Date       ]  (YYYYMMDDHHSS)    {EStoreYes | EIndexUnTokenized}   {ExcerptNA}
ae3f1779f6da Revision: 201019
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 2
diff changeset
   143
    | [ Memo       ]                    {EStoreYes | EIndexTokenized}     {ExcerptNo}
0
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   144
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   145
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   146
For instance, a document for an email message should have the
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   147
appclass value defined as "root msg email" (with spaces in between the
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   148
words). SMS message would have it as "root msg phone sms".
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   149
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   150
If SMS, MMS and email messages originated from the same messenger
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   151
application and are indexed to the same indexed database, then the
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   152
appclass value given to the IdxDb retrieval call would be the common
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   153
denominator, which is "root msg", as well as the baseAppClass value
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   154
for creating the index would be the same, "root msg".
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   155
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   156
The field names are also put under the corresponding app classes. Some
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   157
field names are for system use, so they are defined on the root class,
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   158
prefixed with underscore to avoid name clashes. Application specific
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   159
harvesters should use names without underscore prefixes.
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   160
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   161
The exact hierarchy will undergo some obvious evolution, its structure
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   162
and the field names are up to the harvesters. However, the
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   163
preinstalled application suites should define a neatly structured
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   164
hieararchy facilitating flexible and sensible search narrowing and
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   165
widening.
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   166
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   167
NOTE: Later cpix library versions provide the feuture of searching any
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   168
field, one just have to use cpix_DEFAULT_FIELd field name (when
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   169
creating the cpix_QueryParser instance).
671dee74050a Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   170