catalog integration

elena
1 parent afe1c354
Showing 6 changed files with 236 additions and 15 deletions Show diff stats
src/InputOutput/IHMImpl/IHMInputOutputClass.php
src/InputOutput/IHMImpl/Params/CatalogImpl/IHMInputOutputParamsCatalogClass.php
src/InputOutput/IHMImpl/Tools/IHMParamManagerClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputStatisticNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputsNodeClass.php
src/RequestManager.php
@@ -48,6 +48,10 @@ class IHMInputOutputClass implements InputOutputInterface
 						if (($input->format == "PNG") && ($input->tabId != ""))
 							$requestId = "Plot".$input->tabId;
 						break;
+					case 'catalog' :
+						//catalog generation
+						$this->inputOutput = new IHMInputOutputParamsCatalogClass();
+						break;	
 					default :
 						throw new Exception('Params request type '.$input_request->nodeType.' not implemented for this client.');
 				}
@@ -58,7 +62,7 @@ class IHMInputOutputClass implements InputOutputInterface
 				break;
 			case FunctionTypeEnumClass::ACTION :
 				$this->inputOutput = new IHMInputOutputParamsPlotClass();
-				$requestId = str_replace("_","",$input->folderId);
+				$requestId = str_replace("_","",$input->folderId);
 				break;
 			case FunctionTypeEnumClass::PROCESSDELETE :
 				$this->inputOutput = new IHMInputOutputDeleteProcessClass();
@@ -69,8 +73,8 @@ class IHMInputOutputClass implements InputOutputInterface
 			case FunctionTypeEnumClass::PROCESSGETINFO :
 				$this->inputOutput = new IHMInputOutputGetInfoProcessClass();
 				break;
-			case FunctionTypeEnumClass::PROCESSCLEAN :
-				$this->inputOutput = new IHMInputOutputCleanProcessClass();
+			case FunctionTypeEnumClass::PROCESSCLEAN :
+				$this->inputOutput = new IHMInputOutputCleanProcessClass();
 				break;
 				/*case FunctionTypeEnumClass::TTMERGE :
 				 $this->inputOutput = new IHMInputOutputMergeTTClass();
@@ -97,4 +101,4 @@ class IHMInputOutputClass implements InputOutputInterface
 	}
 }
-?>
+?>
@@ -0,0 +1,63 @@
+<?php
+
+define ("CATALOG_RESULT_FILE_KEY", "statistic");
+
+/**
+ * @class IHMInputOutputParamsCatalogClass
+ * @brief Implementation of IHMInputOutputParamsAbstractClass to treat catalog generation request
+ * @details
+*/
+class IHMInputOutputParamsCatalogClass extends IHMInputOutputParamsAbstractClass
+{
+	/*
+	 * @brief method to unmarshall a catalog generation request
+	*/
+	protected function unmarshallRequest($input)
+	{
+		/*
+		   {"id":"","timesrc":"TimeTable","name":"test","created":null,"description":"first","objName":"","objFormat":"","folderId":"","nbIntervals":0,"cacheToken":"","parameter":[{"param":"imf_gsm","function":"min"},{"param":"imf_mag","function":"max"}],"timeTables":[{"id":"sharedtt_26"},{"id":"sharedtt_27"}],"leaf":true,"nodeType":"catalog"}]'
+		 */
+		$paramsNode = $this->paramsData->getRequestNode()->getParamsNode();
+
+		//unmarshall time definition
+		$this->unmarshallTimeDefinition($input);
+
+		//unmarshall statistic output definition
+		$outputsNode = $this->paramsData->getRequestNode()->getOutputsNode();
+		$catalogNode = $outputsNode->addNewOutput(RequestOutputTypeEnum::STATISTIC);
+		$catalogNode->setTimeFormat(RequestOutputStatisticTimeFormatEnum::ISO);
+		$catalogNode->setFileFormat(RequestOutputStatisticFileFormatEnum::XML);
+		
+		// parse parameters / functions array                       
+                foreach ($input->parameter as $obj) { 
+                   $paramFunctionAssociation[$obj->param][] = $obj->function;                
+                }
+                
+                foreach ($paramFunctionAssociation as $param => $functions) {
+                     $paramsNode->addParam($param);
+                     $outputParamNode = $catalogNode->addParam($param);
+                     foreach ($functions as $function) $outputParamNode->addFunction($function);
+                     $paramInfo = $this->paramManager->addExistingParam($param,$this->paramsData);
+                } 
+
+ 		$resultFile = "result_".$this->requestID;
+		$this->paramsData->addWaitingResult(CATALOG_RESULT_FILE_KEY, $resultFile);
+// 
+		$postProcessCmd  = "mv statistic_*";
+	 	$postProcessCmd .= '.xml';
+		$postProcessCmd .= " ".$resultFile.$extension;
+ 
+// 
+		$this->paramsData->setPostCmd($postProcessCmd);
+ 		return $this->paramsData;
+	}
+
+	/*
+	 * @brief method to marshall the result of a catalog generation request
+	*/
+	protected function marshallResult($data)
+	{
+		return $this->commonMarshallResult($data,CATALOG_RESULT_FILE_KEY);
+	}
+}
+?>
 \ No newline at end of file
@@ -80,7 +80,6 @@ class IHMParamManagerClass
 			$paramId = $param;
 		$paramPath = IHMConfigClass::getLocalParamDBPath().$paramId.".xml";
-
 		if (!file_exists($paramPath))
 			throw new Exception('Cannot find parameter local file '.$paramId);
@@ -96,8 +95,8 @@ class IHMParamManagerClass
 	*/
 	private function addLinkedLocalParams($paramId,$paramsData)
 	{
-		$doc = new DOMDocument("1.0", "UTF-8");
-		$doc->preserveWhiteSpace = false;
+		$doc = new DOMDocument("1.0", "UTF-8");
+		$doc->preserveWhiteSpace = false;
 		$doc->formatOutput = true;
 		$paramPath = IHMConfigClass::getLocalParamDBPath().$paramId.".xml";
@@ -143,14 +142,14 @@ class IHMParamManagerClass
 		//parse expression
 		if (!isset($this->expressionParser))
-			$this->expressionParser = new IHMExpressionParserClass();
+			$this->expressionParser = new IHMExpressionParserClass();
 		$expressionInfo = $this->expressionParser->parse($res["param"]["expression"]);
-		$paramId = $param;
-		
-		//create a process param for the derived parameter
-		$this->addProcessParam($paramId, $expressionInfo["expression"],
-				$expressionInfo['params'], $res["param"]["timestep"],
+		$paramId = $param;
+		
+		//create a process param for the derived parameter
+		$this->addProcessParam($paramId, $expressionInfo["expression"],
+				$expressionInfo['params'], $res["param"]["timestep"],
 				0,$res["param"]["dateModif"],$paramsData);
 		return array("id" => $paramId, "indexes" => array(), "calib_infos" => array());
@@ -0,0 +1,150 @@
+<?php
+
+define ("REQUESTOUTPUTSTATISTIC_NAME", "statistic");
+define ("REQUESTOUTPUTSTATISTIC_TIMEFORMAT", "timeFormat");
+define ("REQUESTOUTPUTSTATISTIC_FILEFORMAT", "fileFormat");
+define ("REQUESTOUTPUTSTATISTIC_STRUCTURE", "outputStructure");
+define ("REQUESTOUTPUTSTATISTIC_FILENAME", "fileName");
+
+define ("REQUESTOUTPUTSTATISTICPARAM_NAME",  "param");
+define ("REQUESTOUTPUTSTATISTICFUNCTION_NAME",  "function");
+define ("REQUESTOUTPUTSTATISTICPARAM_ID", "id");
+define ("REQUESTOUTPUTSTATISTICFUNCTION_ID",  "name");
+
+abstract class RequestOutputStatisticTimeFormatEnum
+{
+	const UNKNOWN = "";
+	const ISO   = "ISO";
+}
+
+abstract class RequestOutputStatisticFileFormatEnum
+{
+	const UNKNOWN = "";
+	const ASCII   = "ASCII";
+	const XML     = "XML";
+	const VOT     = "VOT";
+}
+
+abstract class RequestOutputStatisticStructureEnum
+{
+	const UNKNOWN                             = "";
+	const ONE_FILE                            = "one-file";
+	const ONE_FILE_PER_INTERVAL               = "one-file-per-interval";
+}
+
+class RequestOutputStatisticFunctionNodeClass extends NodeClass
+{
+	public function __construct()
+	{
+		parent::__construct(REQUESTOUTPUTSTATISTICFUNCTION_NAME);		
+	}
+
+	public function setFunctionName($name)
+	{
+		$this->setAttribute(REQUESTOUTPUTSTATISTICFUNCTION_ID, $name);
+	}
+}
+
+class RequestOutputStatisticParamNodeClass extends NodeClass
+{
+	public function __construct()
+	{
+		parent::__construct(REQUESTOUTPUTSTATISTICPARAM_NAME);
+	}
+
+	public function setId($id)
+	{
+		$this->setAttribute(REQUESTOUTPUTSTATISTICPARAM_ID, $id);
+	}
+
+	public function getId()
+	{
+		return $this->getAttribute(REQUESTOUTPUTSTATISTICPARAM_ID);
+	}
+		
+	public function addFunction($name)
+	{		
+		$node = new RequestOutputStatisticFunctionNodeClass();	 
+		$this->addChild($node);		 
+	 	$node->setFunctionName($name);		 
+	}
+}
+
+/**
+ * @class RequestOutputStatisticNodeClass
+ * @brief Definition of a request data mining output node for AMDA_Kernel
+ * @details
+ */
+class RequestOutputStatisticNodeClass extends NodeClass
+  {
+	public function __construct()
+	{
+		parent::__construct(REQUESTOUTPUTSTATISTIC_NAME);				
+	}
+
+	public function setTimeFormat($timeFormat)
+	{
+		$node = $this->getChildInstanceByName(REQUESTOUTPUTSTATISTIC_TIMEFORMAT, true);
+		$node->setValue($timeFormat);
+	}
+
+	public function setFileFormat($fileFormat)
+	{
+		$node = $this->getChildInstanceByName(REQUESTOUTPUTSTATISTIC_FILEFORMAT, true);
+		$node->setValue($fileFormat);
+	}
+
+	public function setStructure($structure)
+	{
+		$node = $this->getChildInstanceByName(REQUESTOUTPUTSTATISTIC_STRUCTURE, true);
+		$node->setValue($structure);						
+	}
+
+	public function setFileName($fileName)
+	{
+		$node = $this->getChildInstanceByName(REQUESTOUTPUTSTATISTIC_FILENAME, true);
+		$node->setValue($fileName);
+	}
+
+	public function addParam($id)
+	{
+		$paramsNode = $this->getFirstChildByName(REQUESTPARAMS_NAME);
+		
+		if (!$paramsNode)
+		{
+			$paramsNode = new RequestParamsNodeClass();
+			$this->addChild($paramsNode);
+		}
+
+		$node = new RequestOutputStatisticParamNodeClass();
+		$paramsNode->addChild($node);
+
+		$node->setId($id);
+		
+		return $node;
+	}
+	
+	public function addPostProcessing($process)
+	{
+		$node = $this->getChildInstanceByName(REQUESTOUTPUTPOSTPROCESSING_NAME);
+		if ($node == NULL)
+		{
+			$node = new RequestOutputPostProcessingNodeClass();
+			$this->addChild($node);
+		}
+
+		$node->addPostProcessing($process);
+	}
+
+	public function isPostProcessing($process)
+	{
+		$node = $this->getChildInstanceByName(REQUESTOUTPUTPOSTPROCESSING_NAME);
+
+		if ($node == NULL)
+			return false;
+			
+		return $node->isPostProcessing($process);
+	}
+}
+
+?>
 \ No newline at end of file
@@ -6,6 +6,7 @@ abstract class RequestOutputTypeEnum
 	const DOWNLOAD   = "Download";
 	const DATAMINING = "DataMining";
 	const PLOT       = "Plot";
+	const STATISTIC  = "Statistic";
 }
 /**
@@ -33,6 +34,9 @@ class RequestOutputsNodeClass extends NodeClass
 			case RequestOutputTypeEnum::PLOT :
 				$output = new RequestOutputPlotNodeClass();
 				break;
+			case RequestOutputTypeEnum::STATISTIC :			
+				$output = new RequestOutputStatisticNodeClass();
+				break;	
 			default :
 				throw new Exception('Output node not implemented');
 		}
@@ -9,6 +9,7 @@ function amdaintegration_autoload($class_name)
 			'InputOutput/IHMImpl/Config',
 			'InputOutput/IHMImpl/Params',
 			'InputOutput/IHMImpl/Params/DataMiningImpl',
+			'InputOutput/IHMImpl/Params/CatalogImpl',
 			'InputOutput/IHMImpl/Params/DownloadImpl',
 			'InputOutput/IHMImpl/Params/PlotImpl',
 			'InputOutput/IHMImpl/Params/GeneratorImpl',
@@ -151,10 +152,10 @@ Class RequestManagerClass
 		//get the input data from the request input data by using the InputOutput interface
 		$inputdata = $inputOutput->getInputData($input,$function);
-
+		
 		//create an instance of the RequestClass to run the request
 		$request = $this->createRequest($userHost, $function);
-
+		
 		if (is_array($inputdata))
 		{
 			$outputdata = array();