Split Predicate Matrix from Invoice Transaction Rule to a dedicated class.

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@5005 20353a03-c40f-0410-a6d1-a30d3c3de9de

product/ERP5/Document/InvoiceTransactionRule.py

@@ -29,11 +29,11 @@
 from AccessControl import ClassSecurityInfo
 from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
 from Products.ERP5.Document.Rule import Rule
-from Products.ERP5Type.XMLMatrix import XMLMatrix
+from Products.ERP5.Document.PredicateMatrix import PredicateMatrix
 
 from zLOG import LOG, BLATHER, INFO, PROBLEM
 
-class InvoiceTransactionRule(Rule, XMLMatrix):
+class InvoiceTransactionRule(Rule, PredicateMatrix):
     """
       Invoice Transaction Rule object generates accounting movements
       for each invoice movement based on category membership and
@@ -61,16 +61,6 @@ class InvoiceTransactionRule(Rule, XMLMatrix):
                       , PropertySheet.DublinCore
                       )
     
-    def _getMatchingCell(self, movement):
-      """
-        Browse all cells and test them until match found
-      """
-      for cell in self.getCellValueList(base_id = 'movement'):
-        if cell.test(movement):
-          LOG('Found Cell', BLATHER, cell.getRelativeUrl())
-          return cell
-      return None          
-    
     def test(self, movement):
       """
         Tests if the rule (still) applies
@@ -172,7 +162,7 @@ class InvoiceTransactionRule(Rule, XMLMatrix):
               if resource in (None, '') :
                 # XXX this happen in many order, so this log is probably useless
                 LOG("InvoiceTransactionRule", PROBLEM,
-                    "expanding %s: without resource"%applied_rule.getPath())
+                    "expanding %s: without resource" % applied_rule.getPath())
             my_simulation_movement._edit(
                   source = transaction_line.getSource()
                 , destination = transaction_line.getDestination()
@@ -243,43 +233,3 @@ class InvoiceTransactionRule(Rule, XMLMatrix):
         return 0
       return 1
     
-    # Matrix related
-    security.declareProtected( Permissions.ModifyPortalContent,
-                               'newCellContent' )
-    def newCellContent(self, id, **kw):
-      """Creates a new Cell.
-         This method can be overriden
-      """
-      self.invokeFactory(type_name='Accounting Rule Cell', id=id)
-      new_cell = self.get(id)
-      return new_cell
-
-    security.declareProtected(Permissions.ModifyPortalContent, 'updateMatrix')
-    def updateMatrix(self) :
-      """This methods updates the matrix so that cells are consistent
-      with the predicates.
-      """
-      base_id = 'movement'
-      kwd = {'base_id': base_id}
-      # This is a site dependent script
-      new_range = self.InvoiceTransactionRule_asCellRange()
-
-      self._setCellRange(*new_range, **kwd)
-      cell_range_key_list = self.getCellRangeKeyList(base_id = base_id)
-      if cell_range_key_list != [[None, None]] :
-        for k in cell_range_key_list :
-          c = self.newCell(*k, **kwd)
-          c.edit( mapped_value_property_list = ( 'title',),
-                  predicate_category_list = filter(
-                                    lambda k_item: k_item is not None, k),
-                  title = 'Transaction %s' % repr(map(lambda k_item : \
-                          self.restrictedTraverse(k_item).getTitle(), k)),
-                  force_update = 1
-                )
-      else :
-        # If empty matrix, delete all cells
-        cell_range_id_list = self.getCellRangeIdList(base_id = base_id)
-        for k in cell_range_id_list :
-          if self.get(k) is not None :
-            self.deleteContent(k)
-    

product/ERP5/Document/PredicateMatrix.py

+##############################################################################
+#
+# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#                    Jerome Perrin <jerome@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 AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
+from Products.ERP5.Document.Rule import Rule
+from Products.ERP5Type.XMLMatrix import XMLMatrix
+
+from zLOG import LOG, BLATHER, INFO, PROBLEM
+
+class PredicateMatrix(XMLMatrix):
+  """
+    PredicateMatrix implements a matrix of predicates, and
+    allows to get cell that match predicates.
+  """
+
+  # CMF Type Definition
+  meta_type = 'ERP5 Predicate Matrix'
+  portal_type = 'Predicate Matrix'
+  add_permission = Permissions.AddPortalContent
+  isPortalContent = 1
+  isRADContent = 1
+  predicate_matrix_base_id = "movement"
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  # Default Properties
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.XMLObject
+                    , PropertySheet.CategoryCore
+                    , PropertySheet.DublinCore
+                    )
+  
+  def _getSortedCellKeyList(self):
+    """
+      Return the list of cell keys, sorted according to int_index
+      property on Predicates.
+      TODO: cache.
+    """
+    total_priorities = {} # a dictionnary giving sum of int_index for a
+                          # coordinate.
+    cell_key_list = self.getCellKeyList(
+                      base_id = self.predicate_matrix_base_id )
+    for coord_list in cell_key_list :
+      priority = 0
+      for coord in coord_list :
+        predicate = self.unrestrictedTraverse(coord, None)
+        if predicate is not None:
+          priority += predicate.getIntIndex()
+      total_priorities[tuple(coord_list)] = priority
+    
+    cell_key_list.sort(lambda c1, c2:
+        cmp(total_priorities[tuple(c1)],
+            total_priorities[tuple(c2)]))
+    return cell_key_list
+
+  def _getMatchingCell(self, movement):
+    """
+      Browse all cells and test them until match found
+    """
+    for cell_key in self._getSortedCellKeyList() :
+      if self.hasCell(base_id=self.predicate_matrix_base_id, *cell_key) :
+        cell = self.getCell(base_id=self.predicate_matrix_base_id, *cell_key)
+        if cell.test(movement):
+          return cell
+    return None          
+  
+  security.declareProtected( Permissions.AccessContentsInformation,
+                             'getMatchingCell' )
+  getMatchingCell = _getMatchingCell
+  
+  security.declareProtected(Permissions.ModifyPortalContent, 'updateMatrix')
+  def updateMatrix(self) :
+    """
+      This methods updates the matrix so that cells are consistent
+    with the predicates.
+    """
+    base_id = self.predicate_matrix_base_id
+    kwd = {'base_id': base_id}
+    self._updateCellRange(base_id) # calls PT dependant script.
+    
+    cell_range_key_list = self.getCellRangeKeyList(base_id = base_id)
+    if cell_range_key_list != [[None, None]] :
+      for k in cell_range_key_list :
+        c = self.newCell(*k, **kwd)
+        c.edit( mapped_value_property_list = ( 'title',),
+                predicate_category_list = filter(
+                                  lambda k_item: k_item is not None, k),
+                title = " * ".join(map(lambda k_item : \
+                        self.restrictedTraverse(k_item).getTitle(), k)),
+                force_update = 1
+              )
+    else :
+      # If empty matrix, delete all cells
+      cell_range_id_list = self.getCellRangeIdList(base_id = base_id)
+      for k in cell_range_id_list :
+        if self.get(k) is not None :
+          self.deleteContent(k)
+