searchengine/cpix/cpix/inc/public/appclass-hierarchy.txt
changeset 0 671dee74050a
child 1 6f2c1c46032b
equal deleted inserted replaced
-1:000000000000 0:671dee74050a
       
     1 
       
     2 
       
     3   root
       
     4     | [ _docuid      ]		{EStoreYes | EIndexUnTokenized}
       
     5     | [ _appclass    ]		{EStoreYes | EIndexTokenized}	
       
     6     | [ _appclass_ut ]		{EStoreNo  | EIndexUnTokenized}
       
     7     | [ _aggregate   ]      {EStoreNo  | EIndexUnTokenized} 	
       
     8     | [ _excerpt     ]		{EStoreYes | EIndexNo}
       
     9     | [ _mimetype (opt) ]	{EStoreYes | EIndexNo}
       
    10     |
       
    11     +-- msg
       
    12     | [ To     		]	{EStoreYes | EIndexTokenized}
       
    13     | [ From   		]	{EStoreYes | EIndexTokenized}
       
    14     | [ Body   		]	{EStoreYes | EIndexTokenized}
       
    15     | [ Folder 		]	{EStoreYes | EIndexNo}
       
    16     | [ Subject 	] 	{EStoreYes | EIndexTokenized}
       
    17     |
       
    18     |
       
    19     +-- file
       
    20     | [ BaseName  	]	{EStoreYes | EIndexTokenized}
       
    21     | [ Extension 	]	{EStoreYes | EIndexTokenized}
       
    22     | [ FullName  	]	{EStoreYes | EIndexTokenized} 
       
    23     | [ Contents 	]	{EStoreYes | EIndexTokenized}
       
    24     |     
       
    25     |           
       
    26     |      
       
    27     +-- media
       
    28     |     | 
       
    29     |     |
       
    30     |     +-- audio
       
    31     |     | [ Name           ]	{EStoreYes | EIndexTokenized}
       
    32     |     | [ MediaId        ]	{EStoreYes | EIndexUnTokenized}
       
    33     |     | [ Title          ]  {EStoreYes | EIndexTokenized}
       
    34     |     | [ ItemType       ]  {EStoreYes | EIndexUnTokenized}
       
    35     |     | [ Extension      ]  {EStoreYes | EIndexTokenized}
       
    36     |     | [ Album          ]  {EStoreYes | EIndexTokenized}
       
    37     |	    | [ AlbumArtist    ]	{EStoreYes | EIndexTokenized}
       
    38     |     | [ OriginalArtist ]	{EStoreYes | EIndexTokenized}
       
    39     |     | [ Composer       ]	{EStoreYes | EIndexTokenized}
       
    40     |     | [ Artist         ]	{EStoreYes | EIndexTokenized}
       
    41     |     | 
       
    42     |     |
       
    43     |     +-- image
       
    44     |     | [ Name           ]	{EStoreYes | EIndexTokenized}
       
    45     |     | [ MediaId        ]	{EStoreYes | EIndexUnTokenized}
       
    46     |     | [ Title          ]  {EStoreYes | EIndexTokenized}
       
    47     |     | [ ItemType       ]  {EStoreYes | EIndexUnTokenized}
       
    48     |     | [ Extension      ]  {EStoreYes | EIndexTokenized}    
       
    49     |     | [ Comment        ]  {EStoreYes | EIndexTokenized}
       
    50     |     | [ DateTimeOrignal]	{EStoreYes | EIndexUnTokenized}
       
    51     |     |
       
    52     |     |    
       
    53     |     +-- video
       
    54     |	      [ Name           ]	{EStoreYes | EIndexTokenized}
       
    55     |       [ MediaId        ]	{EStoreYes | EIndexUnTokenized}
       
    56     |       [ Title          ]  {EStoreYes | EIndexTokenized}
       
    57     |       [ ItemType       ]  {EStoreYes | EIndexUnTokenized}
       
    58     |       [ Extension      ]  {EStoreYes | EIndexTokenized}
       
    59     |	      [ Artist         ]  {EStoreYes | EIndexTokenized}
       
    60     |       [ Author         ]	{EStoreYes | EIndexTokenized}
       
    61     |       [ Copyright      ]  {EStoreYes | EIndexTokenized}
       
    62     |       [ Description    ]	{EStoreYes | EIndexTokenized}
       
    63     |	      [ Comment        ]	{EStoreYes | EIndexTokenized}  
       
    64     |
       
    65     |
       
    66     +-- contact
       
    67     | [ GivenName   		]	{EStoreYes | EIndexTokenized}
       
    68     | [ FamilyName  		]	{EStoreYes | EIndexTokenized}	
       
    69     | [ CompanyName 		]	{EStoreYes | EIndexTokenized}
       
    70     | [ PhoneNumber 		]	{EStoreYes | EIndexTokenized}
       
    71     | [ Address     		]	{EStoreYes | EIndexTokenized}
       
    72     | [ Note        		]	{EStoreYes | EIndexTokenized}
       
    73     | [ JobTitle    		]	{EStoreYes | EIndexTokenized}
       
    74     | [ SecondName  		]	{EStoreYes | EIndexTokenized}
       
    75     | [ Suffix      		]	{EStoreYes | EIndexTokenized}
       
    76     | [ EMail       		]	{EStoreYes | EIndexTokenized}
       
    77     | [ URL         		]	{EStoreYes | EIndexTokenized}
       
    78     | [ PostOffice  		]	{EStoreYes | EIndexTokenized}
       
    79     | [ ExtendedAddress  	]	{EStoreYes | EIndexTokenized}
       
    80     | [ Locality  		]	{EStoreYes | EIndexTokenized}
       
    81     | [ Region  		]	{EStoreYes | EIndexTokenized}
       
    82     | [ PostCode  		]	{EStoreYes | EIndexTokenized}
       
    83     | [ Country  		]	{EStoreYes | EIndexTokenized}
       
    84     | [ SIPID  			]	{EStoreYes | EIndexTokenized}
       
    85     | [ Spouse  		]	{EStoreYes | EIndexTokenized}
       
    86     | [ Children  		]	{EStoreYes | EIndexTokenized}
       
    87     | [ Class  			]	{EStoreYes | EIndexTokenized}	
       
    88     | [ Prefix  		]	{EStoreYes | EIndexTokenized}
       
    89     | [ AdditionalName  	]	{EStoreYes | EIndexTokenized}
       
    90     | [ Fax  			]	{EStoreYes | EIndexTokenized}
       
    91     | [ GivenNamePronunciation 	]	{EStoreYes | EIndexTokenized}
       
    92     | [ FamilyNamePronunciation ]	{EStoreYes | EIndexTokenized}
       
    93     | [ CompanyNamePronunciation]	{EStoreYes | EIndexTokenized}
       
    94     |
       
    95     |
       
    96     +-- calendar
       
    97     | [ Summary     	]   	{EStoreYes | EIndexTokenized}
       
    98     | [ Description 	]	{EStoreYes | EIndexTokenized}
       
    99     | [ Location    	]	{EStoreYes | EIndexTokenized}
       
   100     | [ StartTime   	] (YYYYMMDDHHSS) (TimeZone UTC)	{EStoreYes | EIndexUnTokenized}
       
   101     | [ EndTime     	] (YYYYMMDDHHSS) (TimeZone UTC)	{EStoreYes | EIndexUnTokenized}
       
   102     | 
       
   103     |    
       
   104     +-- bookmark
       
   105     | [ Name       ] 		{EStoreYes | EIndexTokenized}
       
   106     | [ Url 	   ] 		{EStoreYes | EIndexTokenized} 
       
   107     |
       
   108     +-- applications
       
   109     | [ Name       ]       	{EStoreYes | EIndexTokenized}
       
   110     | [ Uid        ]       	{EStoreYes | EIndexTokenized}
       
   111     | [ Path       ]       	{EStoreYes | EIndexTokenized}
       
   112     |
       
   113     +-- notes
       
   114     | [ Date       ]  (YYYYMMDDHHSS)  {EStoreYes | EIndexUnTokenized}
       
   115     | [ Memo       ]       	{EStoreYes | EIndexTokenized}
       
   116 
       
   117 
       
   118 For instance, a document for an email message should have the
       
   119 appclass value defined as "root msg email" (with spaces in between the
       
   120 words). SMS message would have it as "root msg phone sms".
       
   121 
       
   122 If SMS, MMS and email messages originated from the same messenger
       
   123 application and are indexed to the same indexed database, then the
       
   124 appclass value given to the IdxDb retrieval call would be the common
       
   125 denominator, which is "root msg", as well as the baseAppClass value
       
   126 for creating the index would be the same, "root msg".
       
   127 
       
   128 The field names are also put under the corresponding app classes. Some
       
   129 field names are for system use, so they are defined on the root class,
       
   130 prefixed with underscore to avoid name clashes. Application specific
       
   131 harvesters should use names without underscore prefixes.
       
   132 
       
   133 The exact hierarchy will undergo some obvious evolution, its structure
       
   134 and the field names are up to the harvesters. However, the
       
   135 preinstalled application suites should define a neatly structured
       
   136 hieararchy facilitating flexible and sensible search narrowing and
       
   137 widening.
       
   138 
       
   139 NOTE: Later cpix library versions provide the feuture of searching any
       
   140 field, one just have to use cpix_DEFAULT_FIELd field name (when
       
   141 creating the cpix_QueryParser instance).
       
   142