abstract_datasets.py 40 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072
  1. """!@package grass.script.tgis_abstract_datasets
  2. @brief GRASS Python scripting module (temporal GIS functions)
  3. Temporal GIS related functions to be used in temporal GIS Python library package.
  4. Usage:
  5. @code
  6. import grass.temporal as tgis
  7. ...
  8. @endcode
  9. (C) 2008-2011 by the GRASS Development Team
  10. This program is free software under the GNU General Public
  11. License (>=v2). Read the file COPYING that comes with GRASS
  12. for details.
  13. @author Soeren Gebbert
  14. """
  15. import uuid
  16. import copy
  17. from temporal_extent import *
  18. from spatial_extent import *
  19. from metadata import *
  20. class abstract_dataset(object):
  21. """This is the base class for all datasets (raster, vector, raster3d, strds, stvds, str3ds)"""
  22. def reset(self, ident):
  23. """Reset the internal structure and set the identifier"""
  24. raise IOError("This method must be implemented in the subclasses")
  25. def get_type(self):
  26. """Return the type of this class"""
  27. raise IOError("This method must be implemented in the subclasses")
  28. def get_new_instance(self, ident):
  29. """Return a new instance with the type of this class"""
  30. raise IOError("This method must be implemented in the subclasses")
  31. def get_id(self):
  32. return self.base.get_id()
  33. def get_absolute_time(self):
  34. """Returns a tuple of the start, the end valid time and the timezone of the map
  35. @return A tuple of (start_time, end_time, timezone)
  36. """
  37. start = self.absolute_time.get_start_time()
  38. end = self.absolute_time.get_end_time()
  39. tz = self.absolute_time.get_timezone()
  40. return (start, end, tz)
  41. def get_relative_time(self):
  42. """Returns the relative time interval (start_time, end_time) or None if not present"""
  43. start = self.relative_time.get_start_time()
  44. end = self.relative_time.get_end_time()
  45. return (start, end)
  46. def get_temporal_type(self):
  47. """Return the temporal type of this dataset"""
  48. return self.base.get_ttype()
  49. def get_spatial_extent(self):
  50. """Return a tuple of spatial extent (north, south, east, west, top, bottom) """
  51. north = self.spatial_extent.get_north()
  52. south = self.spatial_extent.get_south()
  53. east = self.spatial_extent.get_east()
  54. west = self.spatial_extent.get_west()
  55. top = self.spatial_extent.get_top()
  56. bottom = self.spatial_extent.get_bottom()
  57. return (north, south, east, west, top, bottom)
  58. def select(self, dbif=None):
  59. """Select temporal dataset entry from database and fill up the internal structure"""
  60. self.base.select(dbif)
  61. if self.is_time_absolute():
  62. self.absolute_time.select(dbif)
  63. if self.is_time_relative():
  64. self.relative_time.select(dbif)
  65. self.spatial_extent.select(dbif)
  66. self.metadata.select(dbif)
  67. def is_in_db(self, dbif=None):
  68. """Check if the temporal dataset entry is in the database"""
  69. return self.base.is_in_db(dbif)
  70. def delete(self):
  71. """Delete temporal dataset entry from database if it exists"""
  72. raise IOError("This method must be implemented in the subclasses")
  73. def insert(self, dbif=None):
  74. """Insert temporal dataset entry into database from the internal structure"""
  75. self.base.insert(dbif)
  76. if self.is_time_absolute():
  77. self.absolute_time.insert(dbif)
  78. if self.is_time_relative():
  79. self.relative_time.insert(dbif)
  80. self.spatial_extent.insert(dbif)
  81. self.metadata.insert(dbif)
  82. def update(self, dbif=None):
  83. """Update temporal dataset entry of database from the internal structure
  84. excluding None variables
  85. """
  86. self.base.update(dbif)
  87. if self.is_time_absolute():
  88. self.absolute_time.update(dbif)
  89. if self.is_time_relative():
  90. self.relative_time.update(dbif)
  91. self.spatial_extent.update(dbif)
  92. self.metadata.update(dbif)
  93. def update_all(self, dbif=None):
  94. """Update temporal dataset entry of database from the internal structure
  95. and include None varuables.
  96. """
  97. self.base.update_all(dbif)
  98. if self.is_time_absolute():
  99. self.absolute_time.update_all(dbif)
  100. if self.is_time_relative():
  101. self.relative_time.update_all(dbif)
  102. self.spatial_extent.update_all(dbif)
  103. self.metadata.update_all(dbif)
  104. def print_self(self):
  105. """Print the content of the internal structure to stdout"""
  106. self.base.print_self()
  107. if self.is_time_absolute():
  108. self.absolute_time.print_self()
  109. if self.is_time_relative():
  110. self.relative_time.print_self()
  111. self.spatial_extent.print_self()
  112. self.metadata.print_self()
  113. def print_info(self):
  114. """Print information about this class in human readable style"""
  115. if self.get_type() == "raster":
  116. # 1 2 3 4 5 6 7
  117. # 0123456789012345678901234567890123456789012345678901234567890123456789012345678
  118. print ""
  119. print " +-------------------- Raster Dataset ----------------------------------------+"
  120. if self.get_type() == "raster3d":
  121. # 1 2 3 4 5 6 7
  122. # 0123456789012345678901234567890123456789012345678901234567890123456789012345678
  123. print ""
  124. print " +-------------------- Raster3d Dataset --------------------------------------+"
  125. if self.get_type() == "vector":
  126. # 1 2 3 4 5 6 7
  127. # 0123456789012345678901234567890123456789012345678901234567890123456789012345678
  128. print ""
  129. print " +-------------------- Vector Dataset ----------------------------------------+"
  130. if self.get_type() == "strds":
  131. # 1 2 3 4 5 6 7
  132. # 0123456789012345678901234567890123456789012345678901234567890123456789012345678
  133. print ""
  134. print " +-------------------- Space Time Raster Dataset -----------------------------+"
  135. if self.get_type() == "str3ds":
  136. # 1 2 3 4 5 6 7
  137. # 0123456789012345678901234567890123456789012345678901234567890123456789012345678
  138. print ""
  139. print " +-------------------- Space Time Raster3d Dataset ---------------------------+"
  140. if self.get_type() == "stvds":
  141. # 1 2 3 4 5 6 7
  142. # 0123456789012345678901234567890123456789012345678901234567890123456789012345678
  143. print ""
  144. print " +-------------------- Space Time Vector Dataset -----------------------------+"
  145. print " | |"
  146. self.base.print_info()
  147. if self.is_time_absolute():
  148. self.absolute_time.print_info()
  149. if self.is_time_relative():
  150. self.relative_time.print_info()
  151. self.spatial_extent.print_info()
  152. self.metadata.print_info()
  153. print " +----------------------------------------------------------------------------+"
  154. def print_shell_info(self):
  155. """Print information about this class in shell style"""
  156. self.base.print_shell_info()
  157. if self.is_time_absolute():
  158. self.absolute_time.print_shell_info()
  159. if self.is_time_relative():
  160. self.relative_time.print_shell_info()
  161. self.spatial_extent.print_shell_info()
  162. self.metadata.print_shell_info()
  163. def set_time_to_absolute(self):
  164. self.base.set_ttype("absolute")
  165. def set_time_to_relative(self):
  166. self.base.set_ttype("relative")
  167. def is_time_absolute(self):
  168. if self.base.D.has_key("temporal_type"):
  169. return self.base.get_ttype() == "absolute"
  170. else:
  171. return None
  172. def is_time_relative(self):
  173. if self.base.D.has_key("temporal_type"):
  174. return self.base.get_ttype() == "relative"
  175. else:
  176. return None
  177. def temporal_relation(self, map):
  178. """Return the temporal relation of this and the provided temporal map"""
  179. if self.is_time_absolute() and map.is_time_absolute():
  180. return self.absolute_time.temporal_relation(map.absolute_time)
  181. if self.is_time_relative() and map.is_time_relative():
  182. return self.relative_time.temporal_relation(map.relative_time)
  183. return None
  184. ###############################################################################
  185. class abstract_map_dataset(abstract_dataset):
  186. """This is the base class for all maps (raster, vector, raster3d)
  187. providing additional function to set the valid time and the spatial extent.
  188. """
  189. def get_new_stds_instance(self, ident):
  190. """Return a new space time dataset instance in which maps are stored with the type of this class"""
  191. raise IOError("This method must be implemented in the subclasses")
  192. def get_stds_register(self):
  193. """Return the space time dataset register table name in which stds are listed in which this map is registered"""
  194. raise IOError("This method must be implemented in the subclasses")
  195. def set_stds_register(self, name):
  196. """Set the space time dataset register table name in which stds are listed in which this map is registered"""
  197. raise IOError("This method must be implemented in the subclasses")
  198. def set_absolute_time(self, start_time, end_time=None, timezone=None):
  199. """Set the absolute time interval with start time and end time
  200. @start_time a datetime object specifying the start time of the map
  201. @end_time a datetime object specifying the end time of the map
  202. @timezone Thee timezone of the map
  203. """
  204. if start_time != None and not isinstance(start_time, datetime) :
  205. core.fatal(_("Start time must be of type datetime"))
  206. if end_time != None and not isinstance(end_time, datetime) :
  207. core.fatal(_("End time must be of type datetime"))
  208. if start_time != None and end_time != None:
  209. if start_time >= end_time:
  210. core.error(_("End time must be later than start time"))
  211. return False
  212. self.base.set_ttype("absolute")
  213. self.absolute_time.set_start_time(start_time)
  214. self.absolute_time.set_end_time(end_time)
  215. self.absolute_time.set_timezone(timezone)
  216. return True
  217. def update_absolute_time(self, start_time, end_time=None, timezone=None, dbif = None):
  218. """Update the absolute time
  219. @start_time a datetime object specifying the start time of the map
  220. @end_time a datetime object specifying the end time of the map
  221. @timezone Thee timezone of the map
  222. """
  223. connect = False
  224. if dbif == None:
  225. dbif = sql_database_interface()
  226. dbif.connect()
  227. connect = True
  228. self.set_absolute_time(start_time, end_time, timezone)
  229. self.absolute_time.update_all(dbif)
  230. self.base.update(dbif)
  231. if connect == True:
  232. dbif.close()
  233. def set_relative_time(self, start_time, end_time=None):
  234. """Set the relative time interval
  235. @start_time A double value in days
  236. @end_time A double value in days
  237. """
  238. if start_time != None and end_time != None:
  239. if abs(float(start_time)) >= abs(float(end_time)):
  240. core.error(_("End time must be greater than start time"))
  241. return False
  242. self.base.set_ttype("relative")
  243. self.relative_time.set_start_time(float(start_time))
  244. if end_time != None:
  245. self.relative_time.set_end_time(float(end_time))
  246. else:
  247. self.relative_time.set_end_time(None)
  248. return True
  249. def update_relative_time(self, start_time, end_time=None, dbif = None):
  250. """Set the relative time interval
  251. @interval A double value in days
  252. """
  253. connect = False
  254. if dbif == None:
  255. dbif = sql_database_interface()
  256. dbif.connect()
  257. connect = True
  258. self.set_relative_time(start_time, end_time)
  259. self.relative_time.update_all(dbif)
  260. self.base.update(dbif)
  261. if connect == True:
  262. dbif.close()
  263. def set_spatial_extent(self, north, south, east, west, top=0, bottom=0):
  264. """Set the spatial extent of the map"""
  265. self.spatial_extent.set_spatial_extent(north, south, east, west, top, bottom)
  266. def delete(self, dbif=None):
  267. """Delete a map entry from database if it exists
  268. Remove dependent entries:
  269. * Remove the map entry in each space time dataset in which this map is registered
  270. * Remove the space time dataset register table
  271. """
  272. connect = False
  273. if dbif == None:
  274. dbif = sql_database_interface()
  275. dbif.connect()
  276. connect = True
  277. if self.is_in_db(dbif):
  278. # First we unregister from all dependent space time datasets
  279. self.unregister(dbif)
  280. # Remove the strds register table
  281. if self.get_stds_register():
  282. sql = "DROP TABLE " + self.get_stds_register()
  283. #print sql
  284. try:
  285. dbif.cursor.execute(sql)
  286. except:
  287. core.error(_("Unable to remove space time dataset register table <%s>") % (self.get_stds_register()))
  288. core.verbose(_("Delete %s dataset <%s> from temporal database") % (self.get_type(), self.get_id()))
  289. # Delete yourself from the database, trigger functions will take care of dependencies
  290. self.base.delete(dbif)
  291. self.reset(None)
  292. if connect == True:
  293. dbif.close()
  294. def unregister(self, dbif=None):
  295. """ Remove the map entry in each space time dataset in which this map is registered
  296. """
  297. core.verbose(_("Unregister %s dataset <%s> from space time datasets") % (self.get_type(), self.get_id()))
  298. connect = False
  299. if dbif == None:
  300. dbif = sql_database_interface()
  301. dbif.connect()
  302. connect = True
  303. # Get all datasets in which this map is registered
  304. rows = self.get_registered_datasets(dbif)
  305. # For each stds in which the map is registered
  306. if rows:
  307. for row in rows:
  308. # Create a space time dataset object to remove the map
  309. # from its register
  310. stds = self.get_new_stds_instance(row["id"])
  311. stds.select(dbif)
  312. stds.unregister_map(self, dbif)
  313. # Take care to update the space time dataset after
  314. # the map has been unregistred
  315. stds.update_from_registered_maps(dbif)
  316. if connect == True:
  317. dbif.close()
  318. def get_registered_datasets(self, dbif=None):
  319. """Return all space time dataset ids in which this map is registered as
  320. sqlite3 rows with column "id" or None if this map is not registered in any
  321. space time dataset.
  322. """
  323. connect = False
  324. if dbif == None:
  325. dbif = sql_database_interface()
  326. dbif.connect()
  327. connect = True
  328. rows = None
  329. try:
  330. if self.get_stds_register() != None:
  331. # Select all stds tables in which this map is registered
  332. sql = "SELECT id FROM " + self.get_stds_register()
  333. dbif.cursor.execute(sql)
  334. rows = dbif.cursor.fetchall()
  335. except:
  336. core.error(_("Unable to select space time dataset register table <%s>") % (self.get_stds_register()))
  337. if connect == True:
  338. dbif.close()
  339. return rows
  340. ###############################################################################
  341. class abstract_space_time_dataset(abstract_dataset):
  342. """Abstract space time dataset class
  343. This class represents a space time dataset. Convenient functions
  344. to select, update, insert or delete objects of this type int the SQL
  345. temporal database exists as well as functions to register or unregister
  346. raster maps.
  347. Parts of the temporal logic are implemented in the SQL temporal database,
  348. like the computation of the temporal and spatial extent as well as the
  349. collecting of metadata.
  350. """
  351. def __init__(self, ident):
  352. self.reset(ident)
  353. def get_new_instance(self, ident):
  354. """Return a new instance with the type of this class"""
  355. raise IOError("This method must be implemented in the subclasses")
  356. def get_new_map_instance(self, ident):
  357. """Return a new instance of a map dataset which is associated with the type of this class"""
  358. raise IOError("This method must be implemented in the subclasses")
  359. def get_map_register(self):
  360. """Return the name of the map register table"""
  361. raise IOError("This method must be implemented in the subclasses")
  362. def set_map_register(self, name):
  363. """Set the name of the map register table"""
  364. raise IOError("This method must be implemented in the subclasses")
  365. def set_initial_values(self, granularity, temporal_type, semantic_type, \
  366. title=None, description=None):
  367. if temporal_type == "absolute":
  368. self.set_time_to_absolute()
  369. self.absolute_time.set_granularity(granularity)
  370. elif temporal_type == "relative":
  371. self.set_time_to_relative()
  372. self.relative_time.set_granularity(granularity)
  373. else:
  374. core.fatal(_("Unknown temporal type \"%s\"") % (temporal_type))
  375. self.base.set_semantic_type(semantic_type)
  376. self.metadata.set_title(title)
  377. self.metadata.set_description(description)
  378. def get_initial_values(self):
  379. """Return the initial values: granularity, temporal_type, semantic_type, title, description"""
  380. temporal_type = self.get_temporal_type()
  381. if temporal_type == "absolute":
  382. granularity = self.absolute_time.get_granularity()
  383. elif temporal_type == "relative":
  384. granularity = self.relative_time.get_granularity()
  385. semantic_type = self.base.get_semantic_type()
  386. title = self.metadata.get_title()
  387. description = self.metadata.get_description()
  388. return granularity, temporal_type, semantic_type, title, description
  389. def get_temporal_relation_matrix(self, dbif=None):
  390. """Return the temporal relation matrix of all registered maps as list
  391. """
  392. connect = False
  393. if dbif == None:
  394. dbif = sql_database_interface()
  395. dbif.connect()
  396. connect = True
  397. matrix = []
  398. maps = self.get_registered_maps_as_objects(dbif=dbif, where=None, order="start_time")
  399. # Create the temporal relation matrix
  400. # Add the map names first
  401. row = []
  402. for map in maps:
  403. row.append(map.get_id())
  404. matrix.append(row)
  405. for mapA in maps:
  406. row = []
  407. for mapB in maps:
  408. row.append(mapA.temporal_relation(mapB))
  409. matrix.append(row)
  410. if connect == True:
  411. dbif.close()
  412. return matrix
  413. def get_registered_maps_as_objects(self, dbif=None, where = None, order = None):
  414. """Return all registered maps as ordered object list
  415. Each row includes all columns specified in the datatype specific view
  416. In case nothing found None is returned
  417. """
  418. connect = False
  419. if dbif == None:
  420. dbif = sql_database_interface()
  421. dbif.connect()
  422. connect = True
  423. obj_list = []
  424. rows = self.get_registered_maps(dbif, where, order)
  425. if rows:
  426. for row in rows:
  427. map = self.get_new_map_instance(row["id"])
  428. map.select(dbif)
  429. obj_list.append(copy.copy(map))
  430. if connect == True:
  431. dbif.close()
  432. return obj_list
  433. def get_registered_maps(self, dbif=None, where = None, order = None):
  434. """Return sqlite rows of all registered maps.
  435. Each row includes all columns specified in the datatype specific view
  436. In case nothing found None is returned
  437. """
  438. connect = False
  439. if dbif == None:
  440. dbif = sql_database_interface()
  441. dbif.connect()
  442. connect = True
  443. rows = None
  444. if self.get_map_register():
  445. # Use the correct temporal table
  446. if self.get_temporal_type() == "absolute":
  447. map_view = self.get_new_map_instance(None).get_type() + "_view_abs_time"
  448. else:
  449. map_view = self.get_new_map_instance(None).get_type() + "_view_rel_time"
  450. sql = "SELECT * FROM %s WHERE %s.id IN (SELECT id FROM %s)" % (map_view, map_view, self.get_map_register())
  451. if where:
  452. sql += " AND %s" % (where)
  453. if order:
  454. sql += " ORDER BY %s" % (order)
  455. try:
  456. dbif.cursor.execute(sql)
  457. rows = dbif.cursor.fetchall()
  458. except:
  459. if connect == True:
  460. dbif.close()
  461. core.error(_("Unable to get map ids from register table <%s>") % (self.get_map_register()))
  462. raise
  463. if connect == True:
  464. dbif.close()
  465. return rows
  466. def delete(self, dbif=None):
  467. """Delete a space time dataset from the database"""
  468. # First we need to check if maps are registered in this dataset and
  469. # unregister them
  470. core.verbose(_("Delete space time %s dataset <%s> from temporal database") % (self.get_new_map_instance(ident=None).get_type(), self.get_id()))
  471. connect = False
  472. if dbif == None:
  473. dbif = sql_database_interface()
  474. dbif.connect()
  475. connect = True
  476. if self.get_map_register():
  477. rows = self.get_registered_maps(dbif)
  478. # Unregister each registered map in the table
  479. if rows:
  480. for row in rows:
  481. # Unregister map
  482. map = self.get_new_map_instance(row["id"])
  483. self.unregister_map(map, dbif)
  484. try:
  485. # Drop remove the map register table
  486. sql = "DROP TABLE " + self.get_map_register()
  487. dbif.cursor.execute(sql)
  488. except:
  489. if connect == True:
  490. dbif.close()
  491. core.error(_("Unable to drop table <%s>") % (self.get_map_register()))
  492. raise
  493. # Remove the primary key, the foreign keys will be removed by trigger
  494. self.base.delete(dbif)
  495. self.reset(None)
  496. if connect == True:
  497. dbif.close()
  498. def register_map(self, map, dbif=None):
  499. """Register a map in the space time dataset.
  500. This method takes care of the registration of a map
  501. in a space time dataset.
  502. In case the map is already registered this function will break with a warning
  503. and return False
  504. """
  505. connect = False
  506. if dbif == None:
  507. dbif = sql_database_interface()
  508. dbif.connect()
  509. connect = True
  510. if map.is_in_db(dbif) == False:
  511. dbif.close()
  512. core.fatal(_("Only maps with absolute or relative valid time can be registered"))
  513. core.verbose(_("Register %s map <%s> in space time %s dataset <%s>") % (map.get_type(), map.get_id(), map.get_type(), self.get_id()))
  514. # First select all data from the database
  515. map.select(dbif)
  516. map_id = map.base.get_id()
  517. map_name = map.base.get_name()
  518. map_mapset = map.base.get_mapset()
  519. map_register_table = map.get_stds_register()
  520. #print "Map register table", map_register_table
  521. # Get basic info
  522. stds_name = self.base.get_name()
  523. stds_mapset = self.base.get_mapset()
  524. stds_register_table = self.get_map_register()
  525. #print "STDS register table", stds_register_table
  526. if stds_mapset != map_mapset:
  527. dbif.close()
  528. core.fatal(_("Only maps from the same mapset can be registered"))
  529. # Check if map is already registred
  530. if stds_register_table:
  531. if dbmi.paramstyle == "qmark":
  532. sql = "SELECT id FROM " + stds_register_table + " WHERE id = (?)"
  533. else:
  534. sql = "SELECT id FROM " + stds_register_table + " WHERE id = (%s)"
  535. dbif.cursor.execute(sql, (map_id,))
  536. row = dbif.cursor.fetchone()
  537. # In case of no entry make a new one
  538. if row and row[0] == map_id:
  539. if connect == True:
  540. dbif.close()
  541. core.warning(_("Map <%s> is already registered.") % (map_id))
  542. return False
  543. # Create tables
  544. sql_path = get_sql_template_path()
  545. # We need to create the stmap raster register table bevor we can register the map
  546. if map_register_table == None:
  547. # Create a unique id
  548. uuid_rand = "map_" + str(uuid.uuid4()).replace("-", "")
  549. map_register_table = uuid_rand + "_" + self.get_type() + "_register"
  550. # Read the SQL template
  551. sql = open(os.path.join(sql_path, "map_stds_register_table_template.sql"), 'r').read()
  552. # Create the raster, raster3d and vector tables
  553. sql = sql.replace("GRASS_MAP", map.get_type())
  554. sql = sql.replace("MAP_NAME", map_name + "_" + map_mapset )
  555. sql = sql.replace("TABLE_NAME", uuid_rand )
  556. sql = sql.replace("MAP_ID", map_id)
  557. sql = sql.replace("STDS", self.get_type())
  558. try:
  559. if dbmi.__name__ == "sqlite3":
  560. dbif.cursor.executescript(sql)
  561. else:
  562. dbif.cursor.execute(sql)
  563. except:
  564. try:
  565. # Drop stds register table
  566. sql = "DROP TABLE " + map_register_table
  567. dbif.cursor.execute(sql)
  568. except:
  569. if connect == True:
  570. dbif.close()
  571. core.error(_("Unable to drop table <%s>" % (map_register_table)))
  572. raise
  573. try:
  574. if dbmi.__name__ == "sqlite3":
  575. dbif.cursor.executescript(sql_script)
  576. else:
  577. dbif.cursor.execute(sql_script)
  578. except:
  579. if connect == True:
  580. dbif.close()
  581. core.error(_("Unable to create the space time %s dataset register table for <%s>") % (map.get_type(), map.get_id()))
  582. raise
  583. # Set the stds register table name and put it into the DB
  584. map.set_stds_register(map_register_table)
  585. map.metadata.update(dbif)
  586. core.verbose(_("Created register table <%s> for %s map <%s>") % (map_register_table, map.get_type(), map.get_id()))
  587. # We need to create the table and register it
  588. if stds_register_table == None:
  589. # Create table name
  590. stds_register_table = stds_name + "_" + stds_mapset + "_" + map.get_type() + "_register"
  591. # Read the SQL template
  592. sql = open(os.path.join(sql_path, "stds_map_register_table_template.sql"), 'r').read()
  593. # Create the raster, raster3d and vector tables
  594. sql = sql.replace("GRASS_MAP", map.get_type())
  595. sql = sql.replace("SPACETIME_NAME", stds_name + "_" + stds_mapset )
  596. sql = sql.replace("SPACETIME_ID", self.base.get_id())
  597. sql = sql.replace("STDS", self.get_type())
  598. sql_script = ""
  599. sql_script += "BEGIN TRANSACTION;\n"
  600. sql_script += sql
  601. sql_script += "\n"
  602. sql_script += "END TRANSACTION;"
  603. try:
  604. if dbmi.__name__ == "sqlite3":
  605. dbif.cursor.executescript(sql_script)
  606. else:
  607. dbif.cursor.execute(sql_script)
  608. except:
  609. try:
  610. # Drop map register table
  611. sql = "DROP TABLE " + stds_register_table
  612. print sql
  613. dbif.cursor.execute(sql)
  614. except:
  615. if connect == True:
  616. dbif.close()
  617. core.error(_("Unable to drop table <%s>" % (stds_register_table)))
  618. raise
  619. try:
  620. if dbmi.__name__ == "sqlite3":
  621. dbif.cursor.executescript(sql_script)
  622. else:
  623. dbif.cursor.execute(sql_script)
  624. except:
  625. if connect == True:
  626. dbif.close()
  627. core.error(_("Unable to create the space time %s dataset register table for <%s>") % (map.get_type(), map.get_id()))
  628. raise
  629. # Trigger have been disabled due to peformance issues while registration
  630. ## We need raster specific trigger
  631. #sql = open(os.path.join(sql_path, "stds_" + map.get_type() + "_register_trigger_template.sql"), 'r').read()
  632. #sql = sql.replace("GRASS_MAP", map.get_type())
  633. #sql = sql.replace("SPACETIME_NAME", stds_name + "_" + stds_mapset )
  634. #sql = sql.replace("SPACETIME_ID", self.base.get_id())
  635. #sql = sql.replace("STDS", self.get_type())
  636. #sql_script = ""
  637. #sql_script += "BEGIN TRANSACTION;\n"
  638. #sql_script += sql
  639. #sql_script += "\n"
  640. #sql_script += "END TRANSACTION;"
  641. #dbif.cursor.executescript(sql_script)
  642. # Set the map register table name and put it into the DB
  643. self.set_map_register(stds_register_table)
  644. self.metadata.update(dbif)
  645. core.verbose(_("Created register table <%s> for space time %s dataset <%s>") % (stds_register_table, map.get_type(), self.get_id()))
  646. # Register the stds in the map stds register table
  647. # Check if the entry is already there
  648. if dbmi.paramstyle == "qmark":
  649. sql = "SELECT id FROM " + map_register_table + " WHERE id = ?"
  650. else:
  651. sql = "SELECT id FROM " + map_register_table + " WHERE id = %s"
  652. dbif.cursor.execute(sql, (self.base.get_id(),))
  653. row = dbif.cursor.fetchone()
  654. # In case of no entry make a new one
  655. if row == None:
  656. if dbmi.paramstyle == "qmark":
  657. sql = "INSERT INTO " + map_register_table + " (id) " + "VALUES (?)"
  658. else:
  659. sql = "INSERT INTO " + map_register_table + " (id) " + "VALUES (%s)"
  660. #print sql
  661. dbif.cursor.execute(sql, (self.base.get_id(),))
  662. # Now put the raster name in the stds map register table
  663. if dbmi.paramstyle == "qmark":
  664. sql = "INSERT INTO " + stds_register_table + " (id) " + "VALUES (?)"
  665. else:
  666. sql = "INSERT INTO " + stds_register_table + " (id) " + "VALUES (%s)"
  667. #print sql
  668. dbif.cursor.execute(sql, (map_id,))
  669. if connect == True:
  670. dbif.close()
  671. return True
  672. def unregister_map(self, map, dbif = None):
  673. """Unregister a map from the space time dataset.
  674. This method takes care of the unregistration of a map
  675. from a space time dataset.
  676. """
  677. connect = False
  678. if dbif == None:
  679. dbif = sql_database_interface()
  680. dbif.connect()
  681. connect = True
  682. if map.is_in_db(dbif) == False:
  683. dbif.close()
  684. core.fatal(_("Unable to find map <%s> in temporal database") % (map.get_id()))
  685. core.verbose(_("Unregister %s map <%s>") % (map.get_type(), map.get_id()))
  686. # First select all data from the database
  687. map.select(dbif)
  688. map_id = map.base.get_id()
  689. map_register_table = map.get_stds_register()
  690. stds_register_table = self.get_map_register()
  691. # Check if the map is registered in the space time raster dataset
  692. if dbmi.paramstyle == "qmark":
  693. sql = "SELECT id FROM " + map_register_table + " WHERE id = ?"
  694. else:
  695. sql = "SELECT id FROM " + map_register_table + " WHERE id = %s"
  696. dbif.cursor.execute(sql, (self.base.get_id(),))
  697. row = dbif.cursor.fetchone()
  698. # Break if the map is not registered
  699. if row == None:
  700. core.warning(_("Map <%s> is not registered in space time dataset") %(map_id, self.base.get_id()))
  701. if connect == True:
  702. dbif.close()
  703. return False
  704. # Remove the space time raster dataset from the raster dataset register
  705. if map_register_table != None:
  706. if dbmi.paramstyle == "qmark":
  707. sql = "DELETE FROM " + map_register_table + " WHERE id = ?"
  708. else:
  709. sql = "DELETE FROM " + map_register_table + " WHERE id = %s"
  710. dbif.cursor.execute(sql, (self.base.get_id(),))
  711. # Remove the raster map from the space time raster dataset register
  712. if stds_register_table != None:
  713. if dbmi.paramstyle == "qmark":
  714. sql = "DELETE FROM " + stds_register_table + " WHERE id = ?"
  715. else:
  716. sql = "DELETE FROM " + stds_register_table + " WHERE id = %s"
  717. dbif.cursor.execute(sql, (map_id,))
  718. if connect == True:
  719. dbif.close()
  720. def update_from_registered_maps(self, dbif = None):
  721. """This methods updates the spatial and temporal extent as well as
  722. type specific metadata. It should always been called after maps are registered
  723. or unregistered/deleted from the space time dataset.
  724. The update of the temporal extent checks if the end time is set correctly.
  725. In case the registered maps have no valid end time (None) the maximum start time
  726. will be used. If the end time is smaller than the maximum start time, it will
  727. be replaced by the maximum start time.
  728. An other solution to automate this is to use the diactivated trigger
  729. in the SQL files. But this will result in a huge performance issue
  730. in case many maps are registred (>1000).
  731. """
  732. core.verbose(_("Update metadata, spatial and temporal extent from all registered maps of <%s>") % (self.get_id()))
  733. # Nothing to do if the register is not present
  734. if not self.get_map_register():
  735. return
  736. connect = False
  737. if dbif == None:
  738. dbif = sql_database_interface()
  739. dbif.connect()
  740. connect = True
  741. map_time = None
  742. use_start_time = False
  743. # Get basic info
  744. stds_name = self.base.get_name()
  745. stds_mapset = self.base.get_mapset()
  746. sql_path = get_sql_template_path()
  747. #We create a transaction
  748. sql_script = ""
  749. sql_script += "BEGIN TRANSACTION;\n"
  750. # Update the spatial and temporal extent from registered maps
  751. # Read the SQL template
  752. sql = open(os.path.join(sql_path, "update_stds_spatial_temporal_extent_template.sql"), 'r').read()
  753. sql = sql.replace("GRASS_MAP", self.get_new_map_instance(None).get_type())
  754. sql = sql.replace("SPACETIME_NAME", stds_name + "_" + stds_mapset )
  755. sql = sql.replace("SPACETIME_ID", self.base.get_id())
  756. sql = sql.replace("STDS", self.get_type())
  757. sql_script += sql
  758. sql_script += "\n"
  759. # Update type specific metadata
  760. sql = open(os.path.join(sql_path, "update_" + self.get_type() + "_metadata_template.sql"), 'r').read()
  761. sql = sql.replace("GRASS_MAP", self.get_new_map_instance(None).get_type())
  762. sql = sql.replace("SPACETIME_NAME", stds_name + "_" + stds_mapset )
  763. sql = sql.replace("SPACETIME_ID", self.base.get_id())
  764. sql = sql.replace("STDS", self.get_type())
  765. sql_script += sql
  766. sql_script += "\n"
  767. sql_script += "END TRANSACTION;"
  768. if dbmi.__name__ == "sqlite3":
  769. dbif.cursor.executescript(sql_script)
  770. else:
  771. dbif.cursor.execute(sql_script)
  772. # Read and validate the selected end time
  773. self.select()
  774. if self.is_time_absolute():
  775. start_time, end_time, tz = self.get_absolute_time()
  776. else:
  777. start_time, end_time = self.get_relative_time()
  778. # In case no end time is set, use the maximum start time of all registered maps as end time
  779. if end_time == None:
  780. use_start_time = True
  781. else:
  782. # Check if the end time is smaller than the maximum start time
  783. if self.is_time_absolute():
  784. sql = """SELECT max(start_time) FROM GRASS_MAP_absolute_time WHERE GRASS_MAP_absolute_time.id IN
  785. (SELECT id FROM SPACETIME_NAME_GRASS_MAP_register);"""
  786. sql = sql.replace("GRASS_MAP", self.get_new_map_instance(None).get_type())
  787. sql = sql.replace("SPACETIME_NAME", stds_name + "_" + stds_mapset )
  788. else:
  789. sql = """SELECT max(start_time) FROM GRASS_MAP_relative_time WHERE GRASS_MAP_relative_time.id IN
  790. (SELECT id FROM SPACETIME_NAME_GRASS_MAP_register);"""
  791. sql = sql.replace("GRASS_MAP", self.get_new_map_instance(None).get_type())
  792. sql = sql.replace("SPACETIME_NAME", stds_name + "_" + stds_mapset )
  793. dbif.cursor.execute(sql)
  794. row = dbif.cursor.fetchone()
  795. if row != None:
  796. # This seems to be a bug in sqlite3 Python driver
  797. if dbmi.__name__ == "sqlite3":
  798. tstring = row[0]
  799. # Convert the unicode string into the datetime format
  800. if tstring.find(":") > 0:
  801. time_format = "%Y-%m-%d %H:%M:%S"
  802. else:
  803. time_format = "%Y-%m-%d"
  804. max_start_time = datetime.strptime(tstring, time_format)
  805. else:
  806. max_start_time = row[0]
  807. if end_time < max_start_time:
  808. map_time = "mixed"
  809. use_start_time = True
  810. else:
  811. map_time = "interval"
  812. # Set the maximum start time as end time
  813. if use_start_time:
  814. if self.is_time_absolute():
  815. sql = """UPDATE STDS_absolute_time SET end_time =
  816. (SELECT max(start_time) FROM GRASS_MAP_absolute_time WHERE GRASS_MAP_absolute_time.id IN
  817. (SELECT id FROM SPACETIME_NAME_GRASS_MAP_register)
  818. ) WHERE id = 'SPACETIME_ID';"""
  819. sql = sql.replace("GRASS_MAP", self.get_new_map_instance(None).get_type())
  820. sql = sql.replace("SPACETIME_NAME", stds_name + "_" + stds_mapset )
  821. sql = sql.replace("SPACETIME_ID", self.base.get_id())
  822. sql = sql.replace("STDS", self.get_type())
  823. elif self.is_time_relative():
  824. sql = """UPDATE STDS_relative_time SET end_time =
  825. (SELECT max(start_time) FROM GRASS_MAP_relative_time WHERE GRASS_MAP_relative_time.id IN
  826. (SELECT id FROM SPACETIME_NAME_GRASS_MAP_register)
  827. ) WHERE id = 'SPACETIME_ID';"""
  828. sql = sql.replace("GRASS_MAP", self.get_new_map_instance(None).get_type())
  829. sql = sql.replace("SPACETIME_NAME", stds_name + "_" + stds_mapset )
  830. sql = sql.replace("SPACETIME_ID", self.base.get_id())
  831. sql = sql.replace("STDS", self.get_type())
  832. if dbmi.__name__ == "sqlite3":
  833. dbif.cursor.executescript(sql)
  834. else:
  835. dbif.cursor.execute(sql)
  836. if end_time == None:
  837. map_time = "point"
  838. # Set the map time type
  839. if self.is_time_absolute():
  840. self.absolute_time.select(dbif)
  841. self.metadata.select(dbif)
  842. if self.metadata.get_number_of_maps() > 0:
  843. self.absolute_time.set_map_time(map_time)
  844. else:
  845. self.absolute_time.set_map_time(None)
  846. self.absolute_time.update_all(dbif)
  847. else:
  848. self.relative_time.select(dbif)
  849. self.metadata.select(dbif)
  850. if self.metadata.get_number_of_maps() > 0:
  851. self.relative_time.set_map_time(map_time)
  852. else:
  853. self.relative_time.set_map_time(None)
  854. self.relative_time.update_all(dbif)
  855. if connect == True:
  856. dbif.close()