FloatDivergenceTester.py 7.86 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2008-2009 Nexedi SA and Contributors. All Rights Reserved.
#                    Rafael Monnerat <rafael@nexedi.com>
#                    Jean-Paul Smets <jp@nexedi.com>
#
# 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
36
from Products.ERP5.mixin.divergence_tester import DivergenceTesterMixin
37

38
class FloatDivergenceTester(Predicate, DivergenceTesterMixin):
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
  """
  The purpose of this divergence tester is to check the
  consistency between delivery movement and simulation movement
  for some specific properties.
  """
  meta_type = 'ERP5 Float Divergence Tester'
  portal_type = 'Float 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
                     )
60

61 62 63
  # Declarative interfaces
  zope.interface.implements( interfaces.IDivergenceTester, )

64 65
  def _compare(self, prevision_movement, decision_movement):
    """
66
    If prevision_movement and decision_movement don't match, it returns a
67 68 69 70
    list : (prevision_value, decision_value, message, mapping)
    """
    tested_property = self.getTestedProperty()
    decision_value = decision_movement.getProperty(tested_property)
71 72
    if self.getProperty('delivery_ratio_enabled'):
      decision_value *= prevision_movement.getDeliveryRatio()
73 74 75 76 77 78
    if prevision_movement.isPropertyRecorded(tested_property):
      prevision_value = prevision_movement.getRecordedProperty(tested_property)
    else:
      prevision_value = prevision_movement.getProperty(tested_property)

    delta = decision_value - prevision_value
79 80 81 82 83 84
    # XXX we should use appropriate property sheets and getter methods
    # for these properties.
    absolute_tolerance_min = self.getProperty('quantity_range_min') or \
                             self.getProperty('quantity')
    if absolute_tolerance_min is not None and \
       delta < absolute_tolerance_min:
85 86
      return (
        prevision_value, decision_value,
87 88 89 90 91 92 93
        'The difference of ${prperty_name} between decision and prevision is less than ${value}.',
        dict(property_name=tested_property,
             value=absolute_tolerance_min))
    absolute_tolerance_max = self.getProperty('quantity_range_max') or \
                             self.getProperty('quantity')
    if absolute_tolerance_max is not None and \
       delta > absolute_tolerance_max:
94 95
      return (
        prevision_value, decision_value,
96 97 98 99 100 101 102
        'The difference of ${prperty_name} between decision and prevision is larger than ${value}.',
        dict(property_name=tested_property,
             value=absolute_tolerance_max))

    tolerance_base = self.getProperty('tolerance_base')
    if tolerance_base == 'currency_precision':
      try:
103
        base = prevision_movement.getSectionValue().getPriceCurrencyValue().getBaseUnitQuantity()
104 105 106
      except AttributeError:
        base = None
    elif tolerance_base == 'quantity':
107
      base = prevision_value
108 109 110 111 112 113 114 115
    else:
      base = None
    if base is not None:
      relative_tolerance_min = self.getProperty('tolerance_range_min') or \
                               self.getProperty('tolerance')
      if relative_tolerance_min is not None and \
             delta < relative_tolerance_min * base:
        if tolerance_base == 'price_currency':
116 117
          return (
            prevision_value, decision_value,
118 119 120 121
            'The difference of ${prperty_name} between decision and prevision is less than ${value} times of the currency precision.',
            dict(property_name=tested_property,
                 value=relative_tolerance_min))
        else:
122 123
          return (
            prevision_value, decision_value,
124 125 126 127 128 129 130 131
            'The difference of ${prperty_name} between decision and prevision is less than ${value} times of the prevision value.',
            dict(property_name=tested_property,
                 value=relative_tolerance_min))
      relative_tolerance_max = self.getProperty('tolerance_range_max') or \
                               self.getProperty('tolerance')
      if relative_tolerance_max is not None and \
             delta < relative_tolerance_max * base:
        if tolerance_base == 'price_currency':
132 133
          return (
            prevision_value, decision_value,
134 135 136 137
            'The difference of ${prperty_name} between decision and prevision is less than ${value} times of the currency precision.',
            dict(property_name=tested_property,
                 value=relative_tolerance_max))
        else:
138 139
          return (
            prevision_value, decision_value,
140 141 142
            'The difference of ${prperty_name} between decision and prevision is less than ${value} times of the prevision value.',
            dict(property_name=tested_property,
                 value=relative_tolerance_max))
143
    return None
144 145 146 147 148
    # XXX the followings are not treated yet:
    # * decimal_alignment_enabled
    # * decimal_rounding_option
    # * decimal_exponent

149
  def getUpdatablePropertyDict(self, prevision_movement, decision_movement):
150
    """
151 152
    Returns a list of properties to update on decision_movement
    prevision_movement so that next call to compare returns True.
153 154 155 156 157

    prevision_movement -- a simulation movement (prevision)

    decision_movement -- a delivery movement (decision)
    """
158 159 160 161 162 163
    tested_property = self.getTestedProperty()
    if prevision_movement.isPropertyRecorded(tested_property):
      prevision_value = prevision_movement.getRecordedProperty(tested_property)
    else:
      prevision_value = prevision_movement.getProperty(tested_property)
    return {tested_property:prevision_value}
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

  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