Author: dr
Date: Wed Jan 9 16:31:17 2008
New Revision: 7114
Log:
- Added preliminairy Search component requirements.
Added:
experimental/Search/
experimental/Search/CREDITS
experimental/Search/DESCRIPTION
experimental/Search/design/
experimental/Search/design/requirements.txt (with props)
experimental/Search/docs/
experimental/Search/src/
experimental/Search/tests/
Added: experimental/Search/CREDITS
==============================================================================
--- experimental/Search/CREDITS (added)
+++ experimental/Search/CREDITS [iso-8859-1] Wed Jan 9 16:31:17 2008
@@ -1,0 +1,13 @@
+CREDITS
+=======
+
+eZ Components team
+------------------
+
+- Sebastian Bergmann
+- Jan Borsodi
+- Raymond Bosman
+- Kore Nordmann
+- Derick Rethans
+- Tobias Schlitt
+- Alexandru Stanoi
Added: experimental/Search/DESCRIPTION
==============================================================================
--- experimental/Search/DESCRIPTION (added)
+++ experimental/Search/DESCRIPTION [iso-8859-1] Wed Jan 9 16:31:17 2008
@@ -1,0 +1,2 @@
+The Search component provides an interface to index and query documents
+with different search engine backends.
Added: experimental/Search/design/requirements.txt
==============================================================================
--- experimental/Search/design/requirements.txt (added)
+++ experimental/Search/design/requirements.txt [iso-8859-1] Wed Jan 9
16:31:17 2008
@@ -1,0 +1,51 @@
+eZ Component: Search, Requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:Author: Derick Rethans
+:Revision: $Revision$
+:Date: $Date$
+
+Introduction
+============
+
+Description
+-----------
+
+The Search component provides an interface to index and query documents
+with different search engine backends. Searching is becoming an integral part
of web
+sites, this is becoming an important feature.
+
+
+Requirements
+============
+
+The components should implement an API that supports multiple backends.
+Towards all backends the same API should work to index and search for
+documents.
+
+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
+a data type that the different backends understand. The document
+specification should allow for easy definition, and the same specification
+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.
+
+For querying the index, some mechanism for handling permissions should be
+supported to limit the search results.
+
+The query API should allow for easy searches, similar to an SQL query.
+Therefore a similar interface as Database's SQL abstraction would be a
+preferred querying language. This querying interface should allow for
+abstractions of differences in search backend querying dialects. Searches
+should also allow for limitation of meta data, such as publication date/time.
+
+
+Special considerations
+======================
+
+It is important that as many backends could be supported through this
+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.
Propchange: experimental/Search/design/requirements.txt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: experimental/Search/design/requirements.txt
------------------------------------------------------------------------------
--- svn:keywords (added)
+++ svn:keywords Wed Jan 9 16:31:17 2008
@@ -1,0 +1,3 @@
+Author
+Revision
+Date
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
