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, \ |
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 |
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.""" |
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.""" |
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.""" |
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.""" |
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.""" |
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. |
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] |
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 |
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 |
|
|
436 |
assert(isinstance(fill, Color)) |
assert(isinstance(fill, Color)) |
437 |
self.fill = fill |
self.fill = fill |
438 |
|
|
439 |
|
def __eq__(self, other): |
440 |
|
"""Return true if 'props' has the same attributes as this class""" |
441 |
|
|
442 |
|
return isinstance(other, ClassGroupProperties) \ |
443 |
|
and self.stroke == other.GetLineColor() \ |
444 |
|
and self.strokeWidth == other.GetLineWidth() \ |
445 |
|
and self.fill == other.GetFill() |
446 |
|
|
447 |
|
def __ne__(self, other): |
448 |
|
return not self.__eq__(other) |
449 |
|
|
450 |
|
def __copy__(self): |
451 |
|
return ClassGroupProperties(self) |
452 |
|
|
453 |
class ClassGroup: |
class ClassGroup: |
454 |
"""A base class for all Groups within a Classification""" |
"""A base class for all Groups within a Classification""" |
476 |
assert(isinstance(label, StringType)) |
assert(isinstance(label, StringType)) |
477 |
self.label = label |
self.label = label |
478 |
|
|
479 |
|
def GetDisplayText(self): |
480 |
|
assert(False, "GetDisplay must be overridden by subclass!") |
481 |
|
return "" |
482 |
|
|
483 |
def Matches(self, value): |
def Matches(self, value): |
484 |
"""Determines if this Group is associated with the given value. |
"""Determines if this Group is associated with the given value. |
485 |
|
|
486 |
Returns True or False. This needs to be implemented by all subclasses. |
Returns False. This needs to be overridden by all subclasses. |
487 |
""" |
""" |
488 |
pass |
assert(False, "GetMatches must be overridden by subclass!") |
489 |
|
return False |
490 |
|
|
491 |
def GetProperties(self): |
def GetProperties(self): |
492 |
"""Return the properties associated with the given value. |
"""Return the properties associated with the given value. |
493 |
|
|
494 |
This needs to be implemented by all subclasses. |
Returns None. This needs to be overridden by all subclasses. |
495 |
""" |
""" |
496 |
pass |
assert(False, "GetProperties must be overridden by subclass!") |
497 |
|
return None |
498 |
|
|
499 |
|
|
500 |
class ClassGroupSingleton(ClassGroup): |
class ClassGroupSingleton(ClassGroup): |
519 |
self.SetProperties(prop) |
self.SetProperties(prop) |
520 |
|
|
521 |
def __copy__(self): |
def __copy__(self): |
522 |
return ClassGroupSingleton(self.value, self.prop, self.label) |
return ClassGroupSingleton(self.GetValue(), |
523 |
|
self.GetProperties(), |
524 |
|
self.GetLabel()) |
525 |
|
|
526 |
|
def __deepcopy__(self, memo): |
527 |
|
return ClassGroupSingleton(copy.copy(self.GetValue()), |
528 |
|
copy.copy(self.GetProperties()), |
529 |
|
copy.copy(self.GetLabel())) |
530 |
|
|
531 |
def GetValue(self): |
def GetValue(self): |
532 |
"""Return the associated value.""" |
"""Return the associated value.""" |
559 |
assert(isinstance(prop, ClassGroupProperties)) |
assert(isinstance(prop, ClassGroupProperties)) |
560 |
self.prop = prop |
self.prop = prop |
561 |
|
|
562 |
|
def GetDisplayText(self): |
563 |
|
label = self.GetLabel() |
564 |
|
|
565 |
class ClassGroupDefault(ClassGroupSingleton): |
if label != "": return label |
566 |
|
|
567 |
|
return str(self.GetValue()) |
568 |
|
|
569 |
|
def __eq__(self, other): |
570 |
|
return isinstance(other, ClassGroupSingleton) \ |
571 |
|
and self.GetProperties() == other.GetProperties() \ |
572 |
|
and self.GetValue() == other.GetValue() |
573 |
|
|
574 |
|
def __ne__(self, other): |
575 |
|
return not self.__eq__(other) |
576 |
|
|
577 |
|
class ClassGroupDefault(ClassGroup): |
578 |
"""The default Group. When values do not match any other |
"""The default Group. When values do not match any other |
579 |
Group within a Classification, the properties from this |
Group within a Classification, the properties from this |
580 |
class are used.""" |
class are used.""" |
588 |
label -- a label for this group. |
label -- a label for this group. |
589 |
""" |
""" |
590 |
|
|
591 |
ClassGroupSingleton.__init__(self, 0, prop, label) |
ClassGroup.__init__(self, label) |
592 |
|
self.SetProperties(prop) |
593 |
|
|
594 |
def __copy__(self): |
def __copy__(self): |
595 |
return ClassGroupDefault(self.prop, self.label) |
return ClassGroupDefault(self.GetProperties(), self.GetLabel()) |
596 |
|
|
597 |
|
def __deepcopy__(self, memo): |
598 |
|
return ClassGroupDefault(copy.copy(self.GetProperties()), |
599 |
|
copy.copy(self.GetLabel())) |
600 |
|
|
601 |
|
def Matches(self, value): |
602 |
|
return True |
603 |
|
|
604 |
def GetProperties(self): |
def GetProperties(self): |
605 |
"""Return the Properties associated with this Group.""" |
"""Return the Properties associated with this Group.""" |
606 |
return self.prop |
return self.prop |
607 |
|
|
608 |
|
def SetProperties(self, prop): |
609 |
|
"""Set the properties associated with this Group. |
610 |
|
|
611 |
|
prop -- a ClassGroupProperties object. if prop is None, |
612 |
|
a default set of properties is created. |
613 |
|
""" |
614 |
|
|
615 |
|
if prop is None: prop = ClassGroupProperties() |
616 |
|
assert(isinstance(prop, ClassGroupProperties)) |
617 |
|
self.prop = prop |
618 |
|
|
619 |
|
def GetDisplayText(self): |
620 |
|
label = self.GetLabel() |
621 |
|
|
622 |
|
if label != "": return label |
623 |
|
|
624 |
|
return "DEFAULT" |
625 |
|
|
626 |
|
def __eq__(self, other): |
627 |
|
return isinstance(other, ClassGroupDefault) \ |
628 |
|
and self.GetProperties() == other.GetProperties() |
629 |
|
|
630 |
|
def __ne__(self, other): |
631 |
|
return not self.__eq__(other) |
632 |
|
|
633 |
class ClassGroupRange(ClassGroup): |
class ClassGroupRange(ClassGroup): |
634 |
"""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 |
635 |
set of properties.""" |
set of properties.""" |
658 |
self.SetProperties(prop) |
self.SetProperties(prop) |
659 |
|
|
660 |
def __copy__(self): |
def __copy__(self): |
661 |
return ClassGroupRange(self.min, self.max, self.prop, self.label) |
return ClassGroupRange(self.GetMin(), |
662 |
|
self.GetMax(), |
663 |
|
self.GetProperties(), |
664 |
|
self.GetLabel()) |
665 |
|
|
666 |
|
def __deepcopy__(self, memo): |
667 |
|
return ClassGroupRange(copy.copy(self.GetMin()), |
668 |
|
copy.copy(self.GetMax()), |
669 |
|
copy.copy(self.GetProperties()), |
670 |
|
copy.copy(self.GetLabel())) |
671 |
|
|
672 |
def GetMin(self): |
def GetMin(self): |
673 |
"""Return the range's minimum value.""" |
"""Return the range's minimum value.""" |
735 |
assert(isinstance(prop, ClassGroupProperties)) |
assert(isinstance(prop, ClassGroupProperties)) |
736 |
self.prop = prop |
self.prop = prop |
737 |
|
|
738 |
|
def GetDisplayText(self): |
739 |
|
label = self.GetLabel() |
740 |
|
|
741 |
|
if label != "": return label |
742 |
|
|
743 |
|
return _("%s - %s") % (self.GetMin(), self.GetMax()) |
744 |
|
|
745 |
|
def __eq__(self, other): |
746 |
|
return isinstance(other, ClassGroupRange) \ |
747 |
|
and self.GetProperties() == other.GetProperties() \ |
748 |
|
and self.GetRange() == other.GetRange() |
749 |
|
|
750 |
|
def __ne__(self, other): |
751 |
|
return not self.__eq__(other) |
752 |
|
|
753 |
class ClassGroupMap(ClassGroup): |
class ClassGroupMap(ClassGroup): |
754 |
"""Currently, this class is not used.""" |
"""Currently, this class is not used.""" |
755 |
|
|
773 |
def GetPropertiesFromValue(self, value): |
def GetPropertiesFromValue(self, value): |
774 |
pass |
pass |
775 |
|
|
776 |
|
def GetDisplayText(self): |
777 |
|
return "Map: " + self.map_type |
778 |
|
|
779 |
# |
# |
780 |
# built-in mappings |
# built-in mappings |
781 |
# |
# |