Changes between Version 9 and Version 10 of adeiSEARCH

Author:

csa (IP: 217.112.40.22)

Timestamp:

09/11/09 19:50:47 (15 years ago)

Comment:

--

adeiSEARCH

@@ -17 +17 @@
-
-'''II''': The global options are going next to the search type and specified in the square brackets. This options then passed to the search modules with the search string and handled by the module code. The following options are supported:
-for most modules 
-
-
+
+if not overridden by match modifiers, see below 
+, if not overridden by match modifiers, see below
-
-'''III''': Then the search string is follows. If the ''Exact match'' flag is not specified, it consists of the phrases. The phrase is
-
-This is an example of a search string consisting of 4 components: two words, one phrase, and a regular expression:
-
+
+
+
-
-Before each phrase, a match modifier could be specified. The following match modifiers are supported
-
-== Default Implementation ==
-following procedure is executed for each modul
+search modules are implemented using [wiki:adeiClassSEARCHEngine SEARCHEngines]. Each SEARCHEngine could provide one or more search module. The !SEARCHEngines are placed in ''classes/search'' folder in ADEI source tree. They should implement a ''Search'' function which accepts four parameters (module, search string, search filter, global options) and returns the [wiki:adeiClassSEARCHResults SEARCHResults] object with results or ''false'' if nothing found. However, standard modules can reuse default ''Search'' function implemented in base class ''classes/searchengine.php''. The following procedure is exeuted in this cas
- * ''Search'' function of ''Search Engine'' is executed with four parameters: module, search string, search filter, global options.
-
-
+
+
+
+
+
+
+
+
-
-The ''CheckString'' is working in following way:
- * The search string is splited in phrases and for each phrase ''CheckPhrase'' function is called.
-
+
+
+
+
+
+
+
-
-
-
-
+
+
+
+
+
-
+If such filter is found, the ''INTERVALSearchFilter'' object (from ''classes/search/intervalfilter.php'') is constructed. This object will get the filter value (''June 2005'') as a single parameter to its constructor. And it should implement a single function: ''FilterResult'' which should return ''true'' if the current record should be filtered out or ''false'' otherwise. The ''FilterResult'' receives two parameters:
+ * associative array with information on current record
+ * a number between 0 and 1 with the rating of match
+Both these parameters can be altered by ''FilterResult'' function.
-
+'''Example'''. Lets consider standard ''item'' search used in conjunction with ''interval'' filter. The search will provide multiple records describing found item (i.e. the associative array with information will contain standard properties: ''db_server'', ''db_name'', ''db_group'', and ''db_mask''). The ''interval'' filter is intended to limit the display interval. Therefore, when the ''FilterResult'' function is called, it will add the ''window'' property to the associative array limiting display window to ''June 2005''.
+
+If multiple filters are specified they executed sequentially until any filter will not reject the current record.
+ 
+== New Search Engine == 
+ * The search engine should provide a list of supported modules in the ''modules'' member of class. It is associative array where the key is module id and the value is module title.
+ * It should define either special ''Search'' function or provide at least the ''GetList'' function to be used in conjunction with the approach described above.
+
+''GetList'' function should return array containing the records. Each record is represented by associative array with following members:
+ * ''title'' - the title used to describe record in the search results
+ * ''description'' - the longer description of the record, HTML content is allowed
+ * ''props'' - the associative array with standard ADEI properties describing the record
+ * ''certain'' - this option indicates what the search module is completely certain what it is this record what he user is actually looking for
+ * Arbitrary properties used by the search engine for record matching
+
+Example:
+{{{
+ array(
+   array(
+     'title' => 'January 2005',
+     'props' => array(
+         'window' => "1104537600-1107216000"
+     ),
+     'description' => false,
+     'certain' => true
+  )
+)
+}}}
+
+Besides ''GetList'' function it is highly desirable to provide ''CheckPhrase'' function which will check the record info against the search phrase and return the match rating, from ''0'' (not matched) to ''1'' (fully matched). The ''CheckPhrase'' function accepts the following parameters
+ * The associative array with information described above
+ * The phrase to match
+ * Type of match: ''SEARCH::WORD_MATCH'', ''SEARCH::FUZZY_MATCH'', ''SEARCH::REGEX_MATCH'', ''false'' (default)
+ * The search module
+ * The global options
-
-== INTERVALSearch Engine ==
-'''Provided Modules''':
-
+Tries to parse the time interval from textual representation given in search string. The only property ''window'' is returned with interval of UNIX timestmaps.
-
-'''Supported Filters''':
-
+ - allows to find intersection of two intervals
-
-== ITEMSearch Engine ==
- * ''control_group'' - Searches control groups by name
-
+'''Supported Filters''':
+ * ''interval''' - adds window property to the items specification
+
-== PROXYSearch Engine ==
-'''Provided Modules''':
-
+ 
-
-'''Supported Filters''':