Author: kk
Date: Fri Jan 11 10:47:35 2008
New Revision: 7123
Log:
- Updated requirements.
Modified:
experimental/Search/design/requirements.txt
Modified: experimental/Search/design/requirements.txt
==============================================================================
--- experimental/Search/design/requirements.txt [iso-8859-1] (original)
+++ experimental/Search/design/requirements.txt [iso-8859-1] Fri Jan 11
10:47:35 2008
@@ -23,6 +23,9 @@
Towards all backends the same API should work to index and search for
documents.
+Document
+--------
+
The format of the documents that can be indexed, and search for, need to be
able to be defined by the component. Hereby we think about specifying the
different fields that form a document. Each of the fields should be mapped to
@@ -31,6 +34,25 @@
should be used for both indexing and searching for documents. The
specification could also re-map field names and data types to field names
and data types that the backends understand.
+
+Indexing
+--------
+
+Indexing should be done by sending the documents to an indexer. Indexing
should support
+both blocking, and non-blocking mode, depending on what the search engine
backend supports.
+The search component must support XML for backend communication.
+
+Searching
+---------
+
+Searching documents is primeraly term based. One or multiple terms are
provided, and the
+search result list contains only documents containing those term.
+
+Facets[1] should be supported, and the available facets should be the document
fields, and
+facets queries within the document fields.
+
+General
+-------
For querying the index, some mechanism for handling permissions should be
supported to limit the search results.
@@ -49,3 +71,6 @@
component, so it is important that the external API does not prevent some
functionalities of the backends to be exposed. The component will only deal
with UTF-8 strings, just like all the other components.
+
+
+[1] - http://www.searchtools.com/info/faceted-metadata.html
--
svn-components mailing list
[email protected]
http://lists.ez.no/mailman/listinfo/svn-components