From 3a4af151a3477e470464e3d739756e51f7a52781 Mon Sep 17 00:00:00 2001
From: Kazuhiko Shiozaki <kazuhiko@nexedi.com>
Date: Wed, 18 Nov 2009 13:18:09 +0000
Subject: [PATCH] initial implement of new category divergence tester.
git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@30726 20353a03-c40f-0410-a6d1-a30d3c3de9de
---
.../CategoryMembershipDivergenceTester.py | 123 ++++++++++++++++++
1 file changed, 123 insertions(+)
create mode 100644 product/ERP5/Document/CategoryMembershipDivergenceTester.py
diff --git a/product/ERP5/Document/CategoryMembershipDivergenceTester.py b/product/ERP5/Document/CategoryMembershipDivergenceTester.py
new file mode 100644
index 0000000000..3dc095c77e
--- /dev/null
+++ b/product/ERP5/Document/CategoryMembershipDivergenceTester.py
@@ -0,0 +1,123 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2008-2009 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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.
+#
+##############################################################################
+
+import zope.interface
+from AccessControl import ClassSecurityInfo
+
+from Products.ERP5.Document.Predicate import Predicate
+from Products.ERP5Type import Permissions, PropertySheet, interfaces
+from Products.ERP5.mixin.divergence_tester import DivergenceTesterMixin
+
+class CategoryMembershipDivergenceTester(Predicate, DivergenceTesterMixin):
+ """
+ The purpose of this divergence tester is to check the
+ consistency between delivery movement and simulation movement
+ for a specific category.
+ """
+ meta_type = 'ERP5 Category Membership Divergence Tester'
+ portal_type = 'Category Membership Divergence Tester'
+ add_permission = Permissions.AddPortalContent
+
+ # Declarative security
+ security = ClassSecurityInfo()
+ security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+ # Declarative properties
+ property_sheets = ( PropertySheet.Base
+ , PropertySheet.XMLObject
+ , PropertySheet.CategoryCore
+ , PropertySheet.DublinCore
+ , PropertySheet.DivergenceTester
+ , PropertySheet.SolverSelection
+ )
+
+ # Declarative interfaces
+ zope.interface.implements( interfaces.IDivergenceTester, )
+
+ def _compare(self, prevision_movement, decision_movement):
+ """
+ If prevision_movement and decision_movement don't match, it returns a
+ list : (prevision_value, decision_value, message, mapping)
+ """
+ tested_property = self.getTestedProperty()
+ decision_value = decision_movement.getPropertyList(tested_property)
+ if prevision_movement.isPropertyRecorded(tested_property):
+ prevision_value = prevision_movement.getRecordedProperty(tested_property)
+ if not isinstance(prevision_value, (list, tuple)):
+ prevision_value = [prevision_value]
+ else:
+ prevision_value = prevision_movement.getPropertyList(tested_property)
+
+ # XXX do we have configurable parameter for this divergence tester ?
+ # like ambiguity...
+ if sorted(decision_value) != sorted(prevision_value):
+ return (
+ prevision_value, decision_value,
+ 'The values of ${prperty_name} category are different between decision and prevision.',
+ dict(property_name=tested_property))
+ return None
+
+ def getUpdatablePropertyDict(self, prevision_movement, decision_movement):
+ """
+ Returns a list of properties to update on decision_movement
+ prevision_movement so that next call to compare returns True.
+
+ prevision_movement -- a simulation movement (prevision)
+
+ decision_movement -- a delivery movement (decision)
+ """
+ tested_property = self.getTestedProperty()
+ if prevision_movement.isPropertyRecorded(tested_property):
+ prevision_value = prevision_movement.getRecordedProperty(tested_property)
+ if not isinstance(prevision_value, (list, tuple)):
+ prevision_value = [prevision_value]
+ else:
+ prevision_value = prevision_movement.getPropertyList(tested_property)
+ return {tested_property:prevision_value}
+
+ def accept(self, simulation_movement):
+ """
+ Copies the properties handled by the divergence tester
+ from the related delivery movement to simulation_movement.
+
+ NOTE: the future existence of this method is still unknown
+ because it is likely to be implemented in TargetSolver
+ instead.
+ """
+ raise NotImplementedError
+
+ def adopt(self, simulation_movement):
+ """
+ Copies the properties handled by the divergence tester
+ from simulation_movement to the related delivery movement
+
+ NOTE: the future existence of this method is still unknown
+ because it is likely to be implemented in TargetSolver
+ instead.
+ """
+ raise NotImplementedError
--
2.30.9