[Erp5-report] r29841 - /erp5/trunk/products/ERP5/interfaces/similarity_provider.py

[nobody at svn.erp5.org]

Author: jp
Date: Tue Oct 20 12:31:41 2009
New Revision: 29841

URL: http://svn.erp5.org?rev=29841&view=rev
Log:
Initial upload

Added:
    erp5/trunk/products/ERP5/interfaces/similarity_provider.py

Added: erp5/trunk/products/ERP5/interfaces/similarity_provider.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/interfaces/similarity_provider.py?rev=29841&view=auto
==============================================================================
--- erp5/trunk/products/ERP5/interfaces/similarity_provider.py (added)
+++ erp5/trunk/products/ERP5/interfaces/similarity_provider.py [utf8] Tue Oct 20 12:31:41 2009
@@ -1,0 +1,54 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp at nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+from zope.interface import Interface
+
+class ISimilarityProvider(Interface):
+  """
+  Similar Provider interface specification
+
+  Documents which implement ISimilarityProvider can be implicitely or 
+  explicitely related to other similar documents. The ISimilarityProvider
+  interface provides methods to find implicit similarities as 
+  well as transitive closure of explicit similarities.
+  """
+
+  def getImplicitSimilarValueList():
+    """
+    Returns all documents which content is similar to the content
+    of the current document.
+    """
+
+  def getSimilarCloudValueList(depth=0):
+    """
+    Returns all documents which are similar to the current document by
+    calculating the transitive closure of similar relation.
+
+    depth -- depth the transitive closure
+    """