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

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

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

revision 391 by jonathan, Mon Feb 10 15:26:11 2003 UTC revision 710 by jonathan, Wed Apr 23 08:45:57 2003 UTC
# Line 1  Line 1 
1  # Copyright (c) 2001, 2002 by Intevation GmbH  # Copyright (c) 2001, 2002, 2003 by Intevation GmbH
2  # Authors:  # Authors:
3  # Jan-Oliver Wagner <[email protected]>  # Jan-Oliver Wagner <[email protected]>
4  # Bernhard Herzog <[email protected]>  # Bernhard Herzog <[email protected]>
5    # Jonathan Coles <[email protected]>
6  #  #
7  # This program is free software under the GPL (>=v2)  # This program is free software under the GPL (>=v2)
8  # Read the file COPYING coming with Thuban for details.  # Read the file COPYING coming with Thuban for details.
# Line 12  Functions to save a session to a file Line 13  Functions to save a session to a file
13    
14  __version__ = "$Revision$"  __version__ = "$Revision$"
15    
16    # fix for people using python2.1
17    from __future__ import nested_scopes
18    
19  import os  import os
20  import string  import string
21    
# Line 19  import Thuban.Lib.fileutil Line 23  import Thuban.Lib.fileutil
23    
24  from Thuban.Model.color import Color  from Thuban.Model.color import Color
25    
26    from Thuban.Model.classification import *
27    
28  #  #
29  # one level of indention  # one level of indention
30  #  #
# Line 46  def escape(data): Line 52  def escape(data):
52      data = string.replace(data, "'", "&apos;")      data = string.replace(data, "'", "&apos;")
53      return data      return data
54    
55  class Saver:  class XMLWriter:
56        """Abstract XMLWriter.
     """Class to serialize a session into an XML file.  
57    
58      Applications built on top of Thuban may derive from this class and      Should be overridden to provide specific object saving functionality.
     override or extend the methods to save additinal information. This  
     additional information should take the form of additional attributes  
     or elements whose names are prefixed with a namespace. To define a  
     namespace derived classes should extend the write_session method to  
     pass the namespaces to the default implementation.  
59      """      """
60    
61        def __init__(self):
62      def __init__(self, session):          self.filename = None
63          self.session = session          pass
64    
65      def write(self, file_or_filename):      def write(self, file_or_filename):
66          """Write the session to a file.          """Write the session to a file.
# Line 73  class Saver: Line 73  class Saver:
73          directory.          directory.
74    
75          If the argument is a file object (which is determined by the          If the argument is a file object (which is determined by the
76          presence of a write method) all filenames will be absolut          presence of a write method) all filenames will be absolute
77          filenames.          filenames.
78          """          """
79    
# Line 87  class Saver: Line 87  class Saver:
87              self.file = file_or_filename              self.file = file_or_filename
88              self.dir = ""              self.dir = ""
89          else:          else:
90              filename = file_or_filename              self.filename = file_or_filename
91              self.dir = os.path.dirname(filename)              self.dir = os.path.dirname(self.filename)
92              self.file = open(filename, 'w')              self.file = open(self.filename, 'w')
93          self.write_header()  
94          self.write_session(self.session)      def close(self):
95            assert self.indent_level == 0
96            if self.filename is not None:
97                self.file.close()
98    
99          if self.indent_level != 0:      def write_header(self, doctype, system):
100              raise ValueError("indent_level still positive!")          """Write the XML header"""
101            self.file.write('<?xml version="1.0" encoding="UTF-8"?>\n')
102            self.file.write('<!DOCTYPE %s SYSTEM "%s">\n' % (doctype, system))
103    
     def write_attribs(self, attrs):  
         for name, value in attrs.items():  
             if isinstance(value, Color):  
                 value = value.hex()  
             else:  
                 value = str(value)  
             self.file.write(' %s="%s"' % (escape(name), escape(value)))  
       
104      def open_element(self, element, attrs = {}):      def open_element(self, element, attrs = {}):
105    
106          #          #
# Line 120  class Saver: Line 117  class Saver:
117    
118          # Helper function to write an element open tag with attributes          # Helper function to write an element open tag with attributes
119          self.file.write("%s<%s" % (TAB*self.indent_level, element))          self.file.write("%s<%s" % (TAB*self.indent_level, element))
120          self.write_attribs(attrs)          self.__write_attribs(attrs)
121    
122          self.indent_level += 1          self.indent_level += 1
123    
124      def close_element(self, element):      def close_element(self, element):
125          self.indent_level -= 1          self.indent_level -= 1
126          if self.indent_level < 0:          assert self.indent_level >= 0
             raise ValueError("close_element called too many times!")  
127    
128          # see open_element() for an explanation          # see open_element() for an explanation
129          if self.element_open == 1:          if self.element_open == 1:
# Line 141  class Saver: Line 137  class Saver:
137          self.open_element(element, attrs)          self.open_element(element, attrs)
138          self.close_element(element)          self.close_element(element)
139    
140      def write_header(self):      def __write_attribs(self, attrs):
141          """Write the XML header"""          for name, value in attrs.items():
142          self.file.write('<?xml version="1.0" encoding="UTF-8"?>\n')              self.file.write(' %s="%s"' % (escape(name), escape(value)))
143          self.file.write('<!DOCTYPE session SYSTEM "thuban.dtd">\n')      
144    class SessionSaver(XMLWriter):
145    
146        """Class to serialize a session into an XML file.
147    
148        Applications built on top of Thuban may derive from this class and
149        override or extend the methods to save additional information. This
150        additional information should take the form of additional attributes
151        or elements whose names are prefixed with a namespace. To define a
152        namespace derived classes should extend the write_session method to
153        pass the namespaces to the default implementation.
154        """
155    
156    
157        def __init__(self, session):
158            XMLWriter.__init__(self)
159            self.session = session
160    
161        def write(self, file_or_filename):
162            XMLWriter.write(self, file_or_filename)
163    
164            self.write_header("session", "thuban.dtd")
165            self.write_session(self.session)
166            self.close()
167    
168      def write_session(self, session, attrs = None, namespaces = ()):      def write_session(self, session, attrs = None, namespaces = ()):
169          """Write the session and its contents          """Write the session and its contents
# Line 180  class Saver: Line 199  class Saver:
199          element, call write_layer for each layer contained in the map          element, call write_layer for each layer contained in the map
200          and finally call write_label_layer to write the label layer.          and finally call write_label_layer to write the label layer.
201          """          """
         write = self.file.write  
202          self.open_element('map title="%s"' % escape(map.title))          self.open_element('map title="%s"' % escape(map.title))
203          self.write_projection(map.projection)          self.write_projection(map.projection)
204          for layer in map.Layers():          for layer in map.Layers():
# Line 204  class Saver: Line 222  class Saver:
222          given, should be a mapping from attribute names to attribute          given, should be a mapping from attribute names to attribute
223          values. The values should not be XML-escaped yet.          values. The values should not be XML-escaped yet.
224          """          """
225          lc = layer.classification          lc = layer.GetClassification()
226    
227          if attrs is None:          if attrs is None:
228              attrs = {}              attrs = {}
229          attrs["title"] = layer.title  
230          attrs["filename"] = relative_filename(self.dir, layer.filename)          attrs["title"]        = layer.title
231          attrs["stroke_width"] = str(lc.GetDefaultStrokeWidth())          attrs["filename"]     = relative_filename(self.dir, layer.filename)
232          fill = lc.GetDefaultFill()          attrs["stroke"]       = lc.GetDefaultLineColor().hex()
233          if fill is None:          attrs["stroke_width"] = str(lc.GetDefaultLineWidth())
234              attrs["fill"] = "None"          attrs["fill"]         = lc.GetDefaultFill().hex()
         else:  
             attrs["fill"] = fill.hex()  
         stroke = lc.GetDefaultStroke()  
         if stroke is None:  
             attrs["stroke"] = "None"  
         else:  
             attrs["stroke"] = stroke.hex()  
235    
236          self.open_element("layer", attrs)          self.open_element("layer", attrs)
237          self.write_classification(layer)          self.write_classification(layer)
# Line 230  class Saver: Line 241  class Saver:
241          if attrs is None:          if attrs is None:
242              attrs = {}              attrs = {}
243    
244          lc = layer.classification          lc = layer.GetClassification()
245    
246          field = lc.field          field = lc.GetField()
247    
248          #          #
249          # there isn't a classification of anything          # there isn't a classification of anything
# Line 241  class Saver: Line 252  class Saver:
252          if field is None: return          if field is None: return
253    
254          attrs["field"] = field          attrs["field"] = field
255            attrs["field_type"] = str(lc.GetFieldType())
256          self.open_element("classification", attrs)          self.open_element("classification", attrs)
257    
258          def write_class_data(data):  
259              dict = {'stroke'      : data.GetStroke(),          types = [[lambda p: 'clnull label="%s"' % p.GetLabel(),
260                      'stroke_width': data.GetStrokeWidth(),                    lambda p: 'clnull'],
261                      'fill'        : data.GetFill()}                   [lambda p: 'clpoint label="%s" value="%s"' %
262              self.write_element("cldata", dict)                               (p.GetLabel(), str(p.GetValue())),
263                      lambda p: 'clpoint'],
264          self.open_element("clnull")                   [lambda p: 'clrange label="%s" min="%s" max="%s"' %
265          write_class_data(lc.GetDefaultData())                               (p.GetLabel(),
266          self.close_element("clnull")                                str(p.GetMin()), (str(p.GetMax()))),
267                                  lambda p: 'clrange']]
268          if lc.points != {}:  
269              for value, data in lc.points.items():          def write_class_group(group):
270                  self.open_element('clpoint value="%s"' % (escape(str(value))))              type = -1
271                  write_class_data(data)              if isinstance(group, ClassGroupDefault): type = 0
272                  self.close_element('clpoint')              elif isinstance(group, ClassGroupSingleton): type = 1
273                          elif isinstance(group, ClassGroupRange): type = 2
274          if lc.ranges != []:              elif isinstance(group, ClassGroupMap):   type = 3
275              for p in lc.ranges:              assert type >= 0
276                  self.open_element('clrange min="%s" max="%s"'  
277                      % (escape(str(p[0])), escape(str(p[1]))))              if type <= 2:
278                  write_class_data(p[2])                  data = group.GetProperties()
279                  self.close_element('clrange')                  dict = {'stroke'      : data.GetLineColor().hex(),
280                            'stroke_width': str(data.GetLineWidth()),
281                            'fill'        : data.GetFill().hex()}
282    
283                    self.open_element(types[type][0](group))
284                    self.write_element("cldata", dict)
285                    self.close_element(types[type][1](group))
286                else: pass # XXX: we need to handle maps
287    
288            for i in lc:
289                write_class_group(i)
290    
291          self.close_element("classification")          self.close_element("classification")
292    
# Line 290  def save_session(session, file, saver_cl Line 312  def save_session(session, file, saver_cl
312    
313      The optional argument saver_class is the class to use to serialize      The optional argument saver_class is the class to use to serialize
314      the session. By default or if it's None, the saver class will be      the session. By default or if it's None, the saver class will be
315      Saver.      SessionSaver.
316    
317      If writing the session is successful call the session's      If writing the session is successful call the session's
318      UnsetModified method      UnsetModified method
319      """      """
320      if saver_class is None:      if saver_class is None:
321          saver_class = Saver          saver_class = SessionSaver
322      saver = saver_class(session)      saver = saver_class(session)
323      saver.write(file)      saver.write(file)
324    
Legend:
Removed from v.391  
changed lines
  Added in v.710
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26