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

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

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

revision 56 by bh, Thu Sep 13 13:54:37 2001 UTC revision 723 by bh, Thu Apr 24 15:31:53 2003 UTC
# Line 1  Line 1 
1  # Copyright (c) 2001 by Intevation GmbH  # Copyright (c) 2001, 2002, 2003 by Intevation GmbH
2  # Authors:  # Authors:
3  # Bernhard Herzog <[email protected]>  # Bernhard Herzog <[email protected]>
4    # Jan-Oliver Wagner <[email protected]>
5  #  #
6  # This program is free software under the GPL (>=v2)  # This program is free software under the GPL (>=v2)
7  # Read the file COPYING coming with Thuban for details.  # Read the file COPYING coming with Thuban for details.
8    
9  __version__ = "$Revision$"  __version__ = "$Revision$"
10    
11  from Thuban.Lib.connector import Publisher  from messages import MAPS_CHANGED, EXTENSIONS_CHANGED, FILENAME_CHANGED, \
12         MAP_LAYERS_CHANGED, MAP_PROJECTION_CHANGED, \
13         LAYER_CHANGED, LAYER_PROJECTION_CHANGED, LAYER_VISIBILITY_CHANGED,\
14         EXTENSION_CHANGED, EXTENSION_OBJECTS_CHANGED, CHANGED
15    
16  from messages import MAPS_CHANGED, LAYERS_CHANGED, MAP_PROJECTION_CHANGED, \  from Thuban import _
      LAYER_LEGEND_CHANGED, FILENAME_CHANGED  
17    
18  from base import TitledObject, Modifiable  from base import TitledObject, Modifiable
   
19  from map import Map  from map import Map
20    from data import ShapefileStore
21    
22    
23  class Session(TitledObject, Modifiable):  class Session(TitledObject, Modifiable):
24    
25      """A complete session.      """A complete session.
26    
27      A Session consists of arbitrary numbers of maps and tables      A Session consists of arbitrary numbers of maps, tables and extensions
28    
29      Session objects send the following events:      Session objects send the following events:
30    
# Line 31  class Session(TitledObject, Modifiable): Line 34  class Session(TitledObject, Modifiable):
34    
35          MAPS_CHANGED -- Maps were added, removed.          MAPS_CHANGED -- Maps were added, removed.
36    
37          LAYERS_CHANGED -- Same as the map's event of the same name.          EXTENSIONS_CHANGED -- Extensions were added, removed.
38    
39            MAP_LAYERS_CHANGED -- Same as the map's event of the same name.
40                            It's simply resent from the session to make                            It's simply resent from the session to make
41                            subscriptions easier.                            subscriptions easier.
42    
43            CHANGED -- Generic changed event. Parameters: the session. The
44                       event is always issued when any other changed event
45                       is issused. This is useful for code that needs to be
46                       notified whenever something in the session has
47                       changed but it's too cumbersome or error-prone to
48                       subscribe to all the individual events.
49      """      """
50    
51        # message channels that have to be forwarded from maps contained in
52        # the session.
53        forwarded_channels = (
54            # generic channels
55            CHANGED,
56    
57            # map specific channels
58            MAP_PROJECTION_CHANGED,
59            MAP_LAYERS_CHANGED,
60    
61            # layer channels forwarded by the map
62            LAYER_PROJECTION_CHANGED,
63            LAYER_CHANGED,
64            LAYER_VISIBILITY_CHANGED,
65    
66            # channels forwarded by an extension
67            EXTENSION_CHANGED,
68            EXTENSION_OBJECTS_CHANGED)
69    
70      def __init__(self, title):      def __init__(self, title):
71          TitledObject.__init__(self, title)          TitledObject.__init__(self, title)
72          Modifiable.__init__(self)          Modifiable.__init__(self)
73          self.filename = None          self.filename = None
74          self.maps = []          self.maps = []
75          self.tables = []          self.tables = []
76            self.extensions = []
77    
78        def changed(self, channel = None, *args):
79            """Like the inherited version but issue a CHANGED message as well.
80    
81            The CHANGED message is only issued if channel given is a
82            different channel than CHANGED.
83            """
84            Modifiable.changed(self, channel, *args)
85            if channel != CHANGED:
86                self.issue(CHANGED, self)
87    
88      def SetFilename(self, filename):      def SetFilename(self, filename):
89          self.filename = filename          self.filename = filename
# Line 55  class Session(TitledObject, Modifiable): Line 97  class Session(TitledObject, Modifiable):
97    
98      def AddMap(self, map):      def AddMap(self, map):
99          self.maps.append(map)          self.maps.append(map)
100          for channel in (LAYERS_CHANGED, MAP_PROJECTION_CHANGED,          for channel in self.forwarded_channels:
                         LAYER_LEGEND_CHANGED):  
101              map.Subscribe(channel, self.forward, channel)              map.Subscribe(channel, self.forward, channel)
102          self.changed(MAPS_CHANGED)          self.changed(MAPS_CHANGED)
103    
104        def RemoveMap(self, map):
105            for channel in self.forwarded_channels:
106                map.Unsubscribe(channel, self.forward, channel)
107            self.maps.remove(map)
108            self.changed(MAPS_CHANGED)
109            map.Destroy()
110    
111        def Extensions(self):
112            return self.extensions
113    
114        def HasExtensions(self):
115            return len(self.extensions) > 0
116    
117        def AddExtension(self, extension):
118            self.extensions.append(extension)
119            for channel in self.forwarded_channels:
120                extension.Subscribe(channel, self.forward, channel)
121            self.changed(EXTENSIONS_CHANGED)
122    
123        def OpenShapefile(self, filename):
124            """Return a shapefile store object for the data in the given file"""
125            return ShapefileStore(self, filename)
126    
127      def Destroy(self):      def Destroy(self):
128          for map in self.maps:          for map in self.maps:
129              map.Destroy()              map.Destroy()
130          self.maps = []          self.maps = []
131          self.tables = []          self.tables = []
132          Publisher.Destroy(self)          Modifiable.Destroy(self)
133    
134      def forward(self, *args):      def forward(self, *args):
135          """Reissue events"""          """Reissue events.
136    
137            If the channel the event is forwarded to is a changed-channel
138            that is not the CHANGED channel issue CHANGED as well. An
139            channel is considered to be a changed-channel if it's name ends
140            with 'CHANGED'.
141            """
142          if len(args) > 1:          if len(args) > 1:
143              args = (args[-1],) + args[:-1]              args = (args[-1],) + args[:-1]
144          apply(self.issue, args)          apply(self.issue, args)
145            channel = args[0]
146            # It's a bit of a kludge to rely on the channel name for this.
147            if channel.endswith("CHANGED") and channel != CHANGED:
148                self.issue(CHANGED, self)
149    
150      def WasModified(self):      def WasModified(self):
151          """Return true if the session or one of the maps was modified"""          """Return true if the session or one of the maps was modified"""
# Line 89  class Session(TitledObject, Modifiable): Line 163  class Session(TitledObject, Modifiable):
163          for map in self.maps:          for map in self.maps:
164              map.UnsetModified()              map.UnsetModified()
165    
166        def TreeInfo(self):
167            items = []
168            if self.filename is None:
169                items.append(_("Filename:"))
170            else:
171                items.append(_("Filename: %s") % self.filename)
172    
173            if self.WasModified():
174                items.append(_("Modified"))
175            else:
176                items.append(_("Unmodified"))
177    
178            items.extend(self.maps)
179            items.extend(self.extensions)
180    
181            return (_("Session: %s") % self.title, items)
182    
183    
184  def create_empty_session():  def create_empty_session():
185      """Return an empty session useful as a starting point"""      """Return an empty session useful as a starting point"""
186      session = Session('unnamed session')      import os
187      session.SetFilename('unnamed.session')      session = Session(_('unnamed session'))
188      session.AddMap(Map('unnamed map'))      session.SetFilename(None)
189        session.AddMap(Map(_('unnamed map')))
190      session.UnsetModified()      session.UnsetModified()
191      return session      return session
Legend:
Removed from v.56  
changed lines
  Added in v.723
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26