source: cows_wps/trunk/cows_wps/lib/ui/proc_config_convertor.py @ 5940

"""
proc_config_convertor.py
========================

Converts what is in the process configuration file into a set of
form elements.

"""

import logging

from cows_wps.utils.create_process_config import createProcessConfig


log = logging.getLogger(__name__)

class ProcConfigConvertor(object):
    """
    Class to convert process configuration into form element dict.
    """

    def convertConfig(self, proc_id):
        proc_config = createProcessConfig(proc_id)["Capabilities"]
        can_cache = proc_config["wps_interface"]["caching_enabled"]
        globals = self.convertGlobals(proc_config["globals"])
        globals.append( ("Is process cachable?", str(can_cache)) )
        inputs = self.convertInputs(proc_config["DataInputs"], proc_config["OrderedDataInputs"])
        outputs = self.convertOutputs(proc_config["ProcessOutputs"])

        resp = {"Process Information": globals,
                "Inputs": inputs,
                "Outputs": outputs}
        
        return resp

    def convertGlobals(self, d):
        "Returns an ordered list."
        ordered_ids = ["Title", "ProcessDescription", "Abstract", "ProcessVersion"]
        ordered_long_names = ["Process Name", "Short Description", "Full Description", "Version number"]
        return self._genericMapper(d, ordered_ids, ordered_long_names)

    def convertInputs(self, d, ordered_ids):
        "Return an ordered list of [(id, long_name, value_dict)]."
        ordered_long_names = ordered_ids
        return self._genericMapper(d, ordered_ids, ordered_long_names)

    def convertOutputs(self, d):
        "Return an ordered list."
        ordered_ids = ["NOT DONE YET"]
        ordered_long_names = ["NOTE DONE YET"]
        d["NOT DONE YET"] = "NOT DONE"
        return self._genericMapper(d, ordered_ids, ordered_long_names)
        
    def _genericMapper(self, dct, ordered_ids, ordered_long_names):
        """
        Returns an ordered list of (long_name, dct[ordered_id]) pairs
        built from dct values and ids. All values are converted to strings.
        Length of ordered_ids and ordered_long_names must be the same.
        """
        if len(ordered_ids) != len(ordered_long_names):
            log.exception("ordered_ids and ordered_long_names must be same length in call to _genericMapper().")

        rt_list = []

        for (i, id) in enumerate(ordered_ids):
            
            value = dct[id]
            if type(value) != type({1:2}): value = str(value)
            key = ordered_long_names[i]
            rt_list.append( (key, value) )

        return rt_list