[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces/index/text - __init__.py:1.2 interfaces.py:1.2

[Jim Fulton]

Update of /cvs-repository/Zope3/src/zope/app/interfaces/index/text
In directory cvs.zope.org:/tmp/cvs-serv15352/src/zope/app/interfaces/index/text

Added Files:
	__init__.py interfaces.py 
Log Message:
Grand renaming:

- Renamed most files (especially python modules) to lower case.

- Moved views and interfaces into separate hierarchies within each
  project, where each top-level directory under the zope package
  is a separate project.

- Moved everything to src from lib/python.

  lib/python will eventually go away. I need access to the cvs
  repository to make this happen, however.

There are probably some bits that are broken. All tests pass
and zope runs, but I haven't tried everything. There are a number
of cleanups I'll work on tomorrow.



=== Zope3/src/zope/app/interfaces/index/text/__init__.py 1.1 => 1.2 ===
--- /dev/null	Wed Dec 25 09:14:01 2002
+++ Zope3/src/zope/app/interfaces/index/text/__init__.py	Wed Dec 25 09:13:00 2002
@@ -0,0 +1,2 @@
+#
+# This file is necessary to make this directory a package.


=== Zope3/src/zope/app/interfaces/index/text/interfaces.py 1.1 => 1.2 ===
--- /dev/null	Wed Dec 25 09:14:01 2002
+++ Zope3/src/zope/app/interfaces/index/text/interfaces.py	Wed Dec 25 09:13:00 2002
@@ -0,0 +1,88 @@
+##############################################################################
+#
+# Copyright (c) 2002 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Interfaces related to text indexing and searching.
+
+$Id$
+"""
+
+from zope.interface import Interface
+
+class ISearchableText(Interface):
+
+    """Interface that text-indexable objects should implement."""
+
+    def getSearchableText():
+        """Return a sequence of unicode strings to be indexed.
+
+        Each unicode string in the returned sequence will be run
+        through the splitter pipeline; the combined stream of words
+        coming out of the pipeline will be indexed.
+
+        returning None indicates the object should not be indexed
+        """
+
+from zope.textindex.textindexinterfaces import IStatistics
+
+class IUITextIndex(IStatistics):
+
+    """Interface for creating a TextIndex from the ZMI."""
+
+    def subscribe():
+        """Subscribe to the prevailing object hub service."""
+
+    def unsubscribe():
+        """Unsubscribe from the object hub service."""
+
+    def isSubscribed():
+        """Return whether we are currently subscribed."""
+
+class IQueryView(Interface):
+
+    """Interface providing a query method that can be invoked from ZPT.
+
+    XXX How to express that this is a browser interface?"""
+
+    def query():
+        """Perform a batched query, based on request fields.
+
+        These request fields are used as input:
+
+        start -- batch start (0-based); defaults to 0
+        count -- batch size; defaults to 10
+        queryText -- query expression; must be given
+
+        Return a dict with fields:
+
+        results -- a list containing the requested batch
+        nresults -- number of items in results
+        first -- 1-based ordinal this batch's first item
+        last -- 1-based ordinal of if this batch's last item
+        next -- 0-based ordinal of next batch; not set if no next batch
+        prev -- 0-based ordinal of previous batch; not set if no prev batch
+        count -- requested batch size
+        total -- total number of matches (all batches together)
+
+        Each item in the results set has the following string fields:
+
+        location -- location of the object (usable as URL within the site)
+        title -- Dublin Core title of the object; not present if no title
+        score -- score, as a float in the range [0.0 ... 1.0]
+        scoreLabel -- score, formatted as a percentage and rounded to 0.1%
+        """
+
+    def nextBatch():
+        """Return the start for the next batch."""
+
+    def prevBatch():
+        """Return the start for the previous batch."""