/[thuban]/branches/WIP-pyshapelib-bramz/Thuban/Model/classification.py
ViewVC logotype

Diff of /branches/WIP-pyshapelib-bramz/Thuban/Model/classification.py

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 462 by jonathan, Wed Mar 5 18:17:17 2003 UTC revision 602 by jonathan, Fri Apr 4 12:12:18 2003 UTC
# Line 23  on the mapping algorithm. Line 23  on the mapping algorithm.
23  # fix for people using python2.1  # fix for people using python2.1
24  from __future__ import nested_scopes  from __future__ import nested_scopes
25    
26    import copy
27    
28  from types import *  from types import *
29    
30  from messages import LAYER_PROJECTION_CHANGED, LAYER_LEGEND_CHANGED, \  from messages import LAYER_PROJECTION_CHANGED, LAYER_LEGEND_CHANGED, \
# Line 33  from Thuban.Model.color import Color Line 35  from Thuban.Model.color import Color
35    
36  import Thuban.Model.layer  import Thuban.Model.layer
37    
   
38  # constants  # constants
39  RANGE_MIN  = 0  RANGE_MIN  = 0
40  RANGE_MAX  = 1  RANGE_MAX  = 1
# Line 58  class Classification: Line 59  class Classification:
59          self.field = None          self.field = None
60          self.fieldType = None          self.fieldType = None
61          self.groups = []          self.groups = []
         self.__sendMessages = False  
62    
63          self.__ToggleMessages(False)          self.__setLayerLock = False
64    
65          self.SetDefaultGroup(ClassGroupDefault())          self.SetDefaultGroup(ClassGroupDefault())
66    
67          self.SetLayer(layer)          self.SetLayer(layer)
68          self.SetField(field)          self.SetField(field)
69    
         self.__ToggleMessages(True)  
   
70      def __iter__(self):      def __iter__(self):
71          return ClassIterator(self.groups)          return ClassIterator(self.groups)
72    
73      def __ToggleMessages(self, on):      def __SendNotification(self):
74          self.__sendMessages = on          """Notify the layer that this class has changed."""
75            if self.layer is not None:
76      def __SendMessage(self, message):              self.layer.ClassChanged()
         """Send the message 'message' to the parent layer."""  
         if self.__sendMessages and self.layer is not None:  
             self.layer.changed(message, self.layer)  
77            
78      def SetField(self, field = None):      def SetField(self, field):
79          """Set the name of the data table field to use.          """Set the name of the data table field to use.
80                    
81               If there is no layer then the field type is set to None,
82               otherwise the layer is queried to find the type of the
83               field data
84    
85             field -- if None then all values map to the default data             field -- if None then all values map to the default data
86          """          """
87    
88          if field == "":          if field == "":
89              field = None              field = None
90    
         self.field = field  
91    
92          if self.layer is not None:          if field is None:
93              fieldType = self.layer.GetFieldType(field)              if self.layer is not None:
94                    self.fieldType = None
95          else:          else:
96              fieldType = None              if self.layer is not None:
97                    fieldType = self.layer.GetFieldType(field)
98                    if fieldType is None:
99                        raise ValueError("'%s' was not found in the layer's table."
100                                         % self.field)
101    
102                    #
103                    # unfortunately we cannot call SetFieldType() because it
104                    # requires the layer to be None
105                    #
106                    self.fieldType = fieldType
107                    #self.SetFieldType(fieldType)
108    
109          self.SetFieldType(fieldType)          self.field = field
   
         # XXX: if fieldType comes back None then field isn't in the table!  
110    
111          self.__SendMessage(LAYER_LEGEND_CHANGED)          self.__SendNotification()
112    
113      def GetField(self):      def GetField(self):
114          """Return the name of the field."""          """Return the name of the field."""
# Line 109  class Classification: Line 119  class Classification:
119          return self.fieldType          return self.fieldType
120    
121      def SetFieldType(self, type):      def SetFieldType(self, type):
122          self.fieldType = type          """Set the type of the field used by this classification.
123    
124            A ValueError is raised if the owning layer is not None and
125            'type' is different from the current field type.
126            """
127    
128            if type != self.fieldType:
129                if self.layer is not None:
130                    raise ValueError()
131                else:
132                    self.fieldType = type
133                    self.__SendNotification()
134    
135      def SetLayer(self, layer):      def SetLayer(self, layer):
136          """Set the owning Layer of this classification."""          """Set the owning Layer of this classification.
137    
138               A ValueError exception will be thrown either the field or
139               field type mismatch the information in the layer's table.
140            """
141    
142            # prevent infinite recursion when calling SetClassification()
143            if self.__setLayerLock: return
144    
145            self.__setLayerLock = True
146    
147          if __debug__:          if layer is None:
148              if layer is not None:              if self.layer is not None:
149                  assert(isinstance(layer, Thuban.Model.layer.Layer))                  l = self.layer
150                    self.layer = None
151                    l.SetClassification(None)
152            else:
153                assert isinstance(layer, Thuban.Model.layer.Layer)
154    
155                old_layer = self.layer
156    
157          self.layer = layer              self.layer = layer
158          self.SetField(self.GetField()) # XXX: this sync's the fieldType  
159                try:
160                    self.SetField(self.GetField()) # this sync's the fieldType
161                except ValueError:
162                    self.layer = old_layer
163                    self.__setLayerLock = False
164                    raise ValueError
165                else:
166                    self.layer.SetClassification(self)
167    
168          self.__SendMessage(LAYER_LEGEND_CHANGED)          self.__setLayerLock = False
169    
170      def GetLayer(self):      def GetLayer(self):
171          """Return the parent layer."""          """Return the parent layer."""
# Line 133  class Classification: Line 177  class Classification:
177             group -- group that the value maps to.             group -- group that the value maps to.
178          """          """
179    
180          assert(isinstance(group, ClassGroupDefault))          assert isinstance(group, ClassGroupDefault)
181          self.AddGroup(group)          self.AddGroup(group)
182    
183      def GetDefaultGroup(self):      def GetDefaultGroup(self):
# Line 151  class Classification: Line 195  class Classification:
195    
196          fill -- a Color object.          fill -- a Color object.
197          """          """
198          assert(isinstance(fill, Color))          assert isinstance(fill, Color)
199          self.GetDefaultGroup().GetProperties().SetFill(fill)          self.GetDefaultGroup().GetProperties().SetFill(fill)
200          self.__SendMessage(LAYER_LEGEND_CHANGED)          self.__SendNotification()
201                    
202      def GetDefaultFill(self):      def GetDefaultFill(self):
203          """Return the default fill color."""          """Return the default fill color."""
# Line 164  class Classification: Line 208  class Classification:
208    
209          color -- a Color object.          color -- a Color object.
210          """          """
211          assert(isinstance(color, Color))          assert isinstance(color, Color)
212          self.GetDefaultGroup().GetProperties().SetLineColor(color)          self.GetDefaultGroup().GetProperties().SetLineColor(color)
213          self.__SendMessage(LAYER_LEGEND_CHANGED)          self.__SendNotification()
214                    
215      def GetDefaultLineColor(self):      def GetDefaultLineColor(self):
216          """Return the default line color."""          """Return the default line color."""
# Line 177  class Classification: Line 221  class Classification:
221    
222          lineWidth -- an integer > 0.          lineWidth -- an integer > 0.
223          """          """
224          assert(isinstance(lineWidth, IntType))          assert isinstance(lineWidth, IntType)
225          self.GetDefaultGroup().GetProperties().SetLineWidth(lineWidth)          self.GetDefaultGroup().GetProperties().SetLineWidth(lineWidth)
226          self.__SendMessage(LAYER_LEGEND_CHANGED)          self.__SendNotification()
227                    
228      def GetDefaultLineWidth(self):      def GetDefaultLineWidth(self):
229          """Return the default line width."""          """Return the default line width."""
# Line 191  class Classification: Line 235  class Classification:
235          item -- this must be a valid ClassGroup object          item -- this must be a valid ClassGroup object
236          """          """
237    
238          assert(isinstance(item, ClassGroup))          assert isinstance(item, ClassGroup)
239    
240          if len(self.groups) > 0 and isinstance(item, ClassGroupDefault):          if len(self.groups) > 0 and isinstance(item, ClassGroupDefault):
241              self.groups[0] = item              self.groups[0] = item
             #self.SetDefaultGroup(item)  
242          else:          else:
243              self.groups.append(item)              self.groups.append(item)
244    
245          self.__SendMessage(LAYER_LEGEND_CHANGED)          self.__SendNotification()
246    
247      def GetGroup(self, value):      def GetGroup(self, value):
248          """Return the associated group, or the default group.          """Return the associated group, or the default group.
# Line 208  class Classification: Line 251  class Classification:
251             Classification.             Classification.
252    
253             value -- the value to classify. If there is no mapping,             value -- the value to classify. If there is no mapping,
254                      or value is None, return the default properties                      the field is None or value is None,
255                        return the default properties
256          """          """
257    
258          if self.field is not None and value is not None:          if self.GetField() is not None and value is not None:
259    
260              for i in range(1, len(self.groups)):              for i in range(1, len(self.groups)):
261                  group = self.groups[i]                  group = self.groups[i]
# Line 328  class ClassGroupProperties: Line 372  class ClassGroupProperties:
372    
373          props -- a ClassGroupProperties object. The class is copied if          props -- a ClassGroupProperties object. The class is copied if
374                   prop is not None. Otherwise, a default set of properties                   prop is not None. Otherwise, a default set of properties
375                   is created.                   is created such that: line color = Color.Black, line width = 1,
376                     and fill color = Color.None
377          """          """
378    
379          self.stroke = None          self.stroke = None
# Line 338  class ClassGroupProperties: Line 383  class ClassGroupProperties:
383          if props is not None:          if props is not None:
384              self.SetProperties(props)              self.SetProperties(props)
385          else:          else:
386              self.SetLineColor(Color.None)              self.SetLineColor(Color.Black)
387              self.SetLineWidth(1)              self.SetLineWidth(1)
388              self.SetFill(Color.None)              self.SetFill(Color.None)
389    
390      def SetProperties(self, props):      def SetProperties(self, props):
391          """Set this class's properties to those in class props."""          """Set this class's properties to those in class props."""
392    
393          assert(isinstance(props, ClassGroupProperties))          assert isinstance(props, ClassGroupProperties)
394          self.SetLineColor(props.GetLineColor())          self.SetLineColor(props.GetLineColor())
395          self.SetLineWidth(props.GetLineWidth())          self.SetLineWidth(props.GetLineWidth())
396          self.SetFill(props.GetFill())          self.SetFill(props.GetFill())
# Line 360  class ClassGroupProperties: Line 405  class ClassGroupProperties:
405          color -- the color of the line. This must be a Color object.          color -- the color of the line. This must be a Color object.
406          """          """
407    
408          assert(isinstance(color, Color))          assert isinstance(color, Color)
409          self.stroke = color          #self.stroke = Color(color.red, color.green, color.blue)
410            self.stroke = copy.copy(color)
411    
412      def GetLineWidth(self):      def GetLineWidth(self):
413          """Return the line width."""          """Return the line width."""
# Line 372  class ClassGroupProperties: Line 418  class ClassGroupProperties:
418    
419          lineWidth -- the new line width. This must be > 0.          lineWidth -- the new line width. This must be > 0.
420          """          """
421          assert(isinstance(lineWidth, IntType))          assert isinstance(lineWidth, IntType)
422          if (lineWidth < 1):          if (lineWidth < 1):
423              raise ValueError(_("lineWidth < 1"))              raise ValueError(_("lineWidth < 1"))
424    
# Line 388  class ClassGroupProperties: Line 434  class ClassGroupProperties:
434          fill -- the color of the fill. This must be a Color object.          fill -- the color of the fill. This must be a Color object.
435          """          """
436    
437          assert(isinstance(fill, Color))          assert isinstance(fill, Color)
438          self.fill = fill          self.fill = copy.copy(fill)
439            #self.fill = Color(fill.red, fill.green, fill.blue)
440    
441        def __eq__(self, other):
442            """Return true if 'props' has the same attributes as this class"""
443    
444            return isinstance(other, ClassGroupProperties)   \
445                and self.stroke      == other.GetLineColor() \
446                and self.strokeWidth == other.GetLineWidth() \
447                and self.fill        == other.GetFill()
448    
449        def __ne__(self, other):
450            return not self.__eq__(other)
451    
452        def __copy__(self):
453            return ClassGroupProperties(self)
454    
455        def __deepcopy__(self):
456            return ClassGroupProperties(self)
457    
458  class ClassGroup:  class ClassGroup:
459      """A base class for all Groups within a Classification"""      """A base class for all Groups within a Classification"""
# Line 415  class ClassGroup: Line 478  class ClassGroup:
478          label -- a string representing the Group's label. This must          label -- a string representing the Group's label. This must
479                   not be None.                   not be None.
480          """          """
481          assert(isinstance(label, StringType))          assert isinstance(label, StringType)
482          self.label = label          self.label = label
483    
484        def GetDisplayText(self):
485            assert False, "GetDisplay must be overridden by subclass!"
486            return ""
487    
488      def Matches(self, value):      def Matches(self, value):
489          """Determines if this Group is associated with the given value.          """Determines if this Group is associated with the given value.
490    
491          Returns True or False. This needs to be implemented by all subclasses.          Returns False. This needs to be overridden by all subclasses.
492          """          """
493          pass          assert False, "GetMatches must be overridden by subclass!"
494            return False
495    
496      def GetProperties(self):      def GetProperties(self):
497          """Return the properties associated with the given value.          """Return the properties associated with the given value.
498    
499          This needs to be implemented by all subclasses.          Returns None. This needs to be overridden by all subclasses.
500          """          """
501          pass          assert False, "GetProperties must be overridden by subclass!"
502            return None
503    
504            
505  class ClassGroupSingleton(ClassGroup):  class ClassGroupSingleton(ClassGroup):
# Line 455  class ClassGroupSingleton(ClassGroup): Line 524  class ClassGroupSingleton(ClassGroup):
524          self.SetProperties(prop)          self.SetProperties(prop)
525    
526      def __copy__(self):      def __copy__(self):
527          return ClassGroupSingleton(self.value, self.prop, self.label)          return ClassGroupSingleton(self.GetValue(),
528                                       self.GetProperties(),
529                                       self.GetLabel())
530    
531        def __deepcopy__(self, memo):
532            return ClassGroupSingleton(copy.copy(self.GetValue()),
533                                       copy.copy(self.GetProperties()),
534                                       copy.copy(self.GetLabel()))
535    
536      def GetValue(self):      def GetValue(self):
537          """Return the associated value."""          """Return the associated value."""
# Line 485  class ClassGroupSingleton(ClassGroup): Line 561  class ClassGroupSingleton(ClassGroup):
561          """          """
562    
563          if prop is None: prop = ClassGroupProperties()          if prop is None: prop = ClassGroupProperties()
564          assert(isinstance(prop, ClassGroupProperties))          assert isinstance(prop, ClassGroupProperties)
565          self.prop = prop          self.prop = prop
566    
567        def GetDisplayText(self):
568            label = self.GetLabel()
569    
570  class ClassGroupDefault(ClassGroupSingleton):          if label != "": return label
571    
572            return str(self.GetValue())
573    
574        def __eq__(self, other):
575            return isinstance(other, ClassGroupSingleton) \
576                and self.GetProperties() == other.GetProperties() \
577                and self.GetValue() == other.GetValue()
578    
579        def __ne__(self, other):
580            return not self.__eq__(other)
581    
582    class ClassGroupDefault(ClassGroup):
583      """The default Group. When values do not match any other      """The default Group. When values do not match any other
584         Group within a Classification, the properties from this         Group within a Classification, the properties from this
585         class are used."""         class are used."""
# Line 503  class ClassGroupDefault(ClassGroupSingle Line 593  class ClassGroupDefault(ClassGroupSingle
593          label -- a label for this group.          label -- a label for this group.
594          """          """
595    
596          ClassGroupSingleton.__init__(self, 0, prop, label)          ClassGroup.__init__(self, label)
597            self.SetProperties(prop)
598    
599      def __copy__(self):      def __copy__(self):
600          return ClassGroupDefault(self.prop, self.label)          return ClassGroupDefault(self.GetProperties(), self.GetLabel())
601    
602        def __deepcopy__(self, memo):
603            return ClassGroupDefault(copy.copy(self.GetProperties()),
604                                     copy.copy(self.GetLabel()))
605    
606        def Matches(self, value):
607            return True
608    
609      def GetProperties(self):      def GetProperties(self):
610          """Return the Properties associated with this Group."""          """Return the Properties associated with this Group."""
611          return self.prop          return self.prop
612    
613        def SetProperties(self, prop):
614            """Set the properties associated with this Group.
615    
616            prop -- a ClassGroupProperties object. if prop is None,
617                    a default set of properties is created.
618            """
619    
620            if prop is None: prop = ClassGroupProperties()
621            assert isinstance(prop, ClassGroupProperties)
622            self.prop = prop
623    
624        def GetDisplayText(self):
625            label = self.GetLabel()
626    
627            if label != "": return label
628    
629            return "DEFAULT"
630    
631        def __eq__(self, other):
632            return isinstance(other, ClassGroupDefault) \
633                and self.GetProperties() == other.GetProperties()
634    
635        def __ne__(self, other):
636            return not self.__eq__(other)
637    
638  class ClassGroupRange(ClassGroup):  class ClassGroupRange(ClassGroup):
639      """A Group that represents a range of values that map to the same      """A Group that represents a range of values that map to the same
640         set of properties."""         set of properties."""
# Line 540  class ClassGroupRange(ClassGroup): Line 663  class ClassGroupRange(ClassGroup):
663          self.SetProperties(prop)          self.SetProperties(prop)
664    
665      def __copy__(self):      def __copy__(self):
666          return ClassGroupRange(self.min, self.max, self.prop, self.label)          return ClassGroupRange(self.GetMin(),
667                                   self.GetMax(),
668                                   self.GetProperties(),
669                                   self.GetLabel())
670    
671        def __deepcopy__(self, memo):
672            return ClassGroupRange(copy.copy(self.GetMin()),
673                                   copy.copy(self.GetMax()),
674                                   copy.copy(self.GetProperties()),
675                                   copy.copy(self.GetLabel()))
676    
677      def GetMin(self):      def GetMin(self):
678          """Return the range's minimum value."""          """Return the range's minimum value."""
# Line 605  class ClassGroupRange(ClassGroup): Line 737  class ClassGroupRange(ClassGroup):
737                  a default set of properties is created.                  a default set of properties is created.
738          """          """
739          if prop is None: prop = ClassGroupProperties()          if prop is None: prop = ClassGroupProperties()
740          assert(isinstance(prop, ClassGroupProperties))          assert isinstance(prop, ClassGroupProperties)
741          self.prop = prop          self.prop = prop
742    
743        def GetDisplayText(self):
744            label = self.GetLabel()
745    
746            if label != "": return label
747    
748            return _("%s - %s") % (self.GetMin(), self.GetMax())
749    
750        def __eq__(self, other):
751            return isinstance(other, ClassGroupRange) \
752                and self.GetProperties() == other.GetProperties() \
753                and self.GetRange() == other.GetRange()
754    
755        def __ne__(self, other):
756            return not self.__eq__(other)
757    
758  class ClassGroupMap(ClassGroup):  class ClassGroupMap(ClassGroup):
759      """Currently, this class is not used."""      """Currently, this class is not used."""
760    
# Line 631  class ClassGroupMap(ClassGroup): Line 778  class ClassGroupMap(ClassGroup):
778      def GetPropertiesFromValue(self, value):      def GetPropertiesFromValue(self, value):
779          pass          pass
780    
781        def GetDisplayText(self):
782            return "Map: " + self.map_type
783    
784      #      #
785      # built-in mappings      # built-in mappings
786      #      #
Legend:
Removed from v.462  
changed lines
  Added in v.602
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26