Geografic-Information-System/temporal/t.support/t.support.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
############################################################################
#
# MODULE:	t.support
# AUTHOR(S):	Soeren Gebbert
#               
# PURPOSE:	Modify the metadata of a space time dataset
# COPYRIGHT:	(C) 2011 by the GRASS Development Team
#
#		This program is free software under the GNU General Public
#		License (version 2). Read the file COPYING that comes with GRASS
#		for details.
#
#############################################################################

#%module
#% description: Modifies the metadata of a space time dataset.
#% keywords: temporal
#% keywords: support
#%end

#%option G_OPT_STDS_INPUT
#%end

#%option
#% key: semantictype
#% type: string
#% description: Semantic type of the space time dataset
#% required: no
#% multiple: no
#% options: min,max,sum,mean
#% answer: mean
#%end

#%option G_OPT_STDS_TYPE
#%end

#%option
#% key: title
#% type: string
#% description: Title of the space time dataset
#% required: no
#% multiple: no
#%end

#%option
#% key: description
#% type: string
#% description: Description of the space time dataset
#% required: no
#% multiple: no
#%end

#%flag
#% key: m
#% description: Update the metadata information and spatial extent of registered maps from the grass spatial database. Check for removed maps and delete them from the temporal database and all effected space time datasets.
#%end

#%flag
#% key: u
#% description: Update metadata information, temporal and spatial extent from registered maps
#%end

import grass.temporal as tgis
import grass.script as grass

############################################################################

def main():

    # Get the options
    name = options["input"]
    type = options["type"]
    title = options["title"]
    description = options["description"]
    semantic = options["semantictype"]
    update = flags["u"]
    map_update = flags["m"]

    # Make sure the temporal database exists
    tgis.create_temporal_database()

    #Get the current mapset to create the id of the space time dataset
    mapset =  grass.gisenv()["MAPSET"]

    if name.find("@") >= 0:
        id = name
    else:
        id = name + "@" + mapset
        
    dbif = tgis.sql_database_interface_connection()
    dbif.connect()

    stds = tgis.dataset_factory(type, id)

    if stds.is_in_db(dbif=dbif) == False:
        dbif.close()
        grass.fatal(_("Space time %s dataset <%s> not found") % (stds.get_new_map_instance(None).get_type(), id))

    stds.select(dbif=dbif)
    
    update = False
    if title:
	stds.metadata.set_title(title=title)
	update = True
	# Update only non-null entries
    if description:
	stds.metadata.set_description(description=description)
	update = True
    if semantic:
	stds.base.set_semantic_type(semantic_type=semantic)
	update = True

    if update:
	stds.update(dbif=dbif)

    if map_update:
        #Update the registered maps from the grass spatial database
        statement = ""
        # This dict stores the datasets that must be updated
        dataset_dict = {}

        count = 0
        maps = stds.get_registered_maps_as_objects(dbif=dbif)
        
        # We collect the delete and update statements
        for map in maps:
	    
	    grass.percent(count, len(maps), 1)
	    count += 1
	    
	    map.select(dbif=dbif)
	    
	    # Check if the map is present in the grass spatial database
	    # Update if present, delete if not present
	    if map.map_exists():
		# Read new metadata from the spatial database
		map.load()
		statement += map.update(dbif=dbif, execute=False)
	    else:
		# Delete the map from the temporal database
		# We need to update all effected space time datasets
		rows = map.get_registered_datasets(dbif)
		if rows: 
		    for row in rows:
			dataset_dict[row["id"]] = row["id"]
		# Collect the delete statements
		statement += map.delete(dbif=dbif, update=False, execute=False)
	

        # Execute the collected SQL statements
        dbif.execute_transaction(statement)
        
	# Update the effected space time datasets
        for id in dataset_dict:
	    stds_new = stds.get_new_instance(id)
	    stds_new.select(dbif=dbif)
            stds_new.update_from_registered_maps(dbif=dbif)
        
    if map_update or update:
        stds.update_from_registered_maps(dbif=dbif)

    dbif.close()

if __name__ == "__main__":
    options, flags = grass.parser()
    main()