SpagoBI - The Business Intelligence Free Platform

Copyright (C) 2005-2008 Engineering Ingegneria Informatica S.p.A.

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

**/

*

* @author Chiara Chiarelli

*

*/

  private static transient Logger logger = Logger.getLogger(SpagoBIKpiInternalEngine.class);

  public static final String messageBundle = "MessageFiles.messages";

  private static final String RESOURCE="RES_NAME";

  protected String publisher_Name= "KPI_DEFAULT_PUB";//Kpi default publisher

  protected String metadata_publisher_Name= "KPI_METADATA_DEFAULT_PUB";//Kpi default publisher

  protected String trend_publisher_Name= "TREND_DEFAULT_PUB";//Kpi default publisher

  protected String name = "";// Document's title

  protected String subName = "";// Document's subtitle

  protected StyleLabel styleTitle;// Document's title style

  protected StyleLabel styleSubTitle;// Document's subtitle style

  protected String userIdField=null;

  protected Locale locale=null;

  private IEngUserProfile profile=null;

  //internationalized DateFormat

  protected String internationalizedFormat = null;

  //Server dateFormat

  protected String formatServer = null;

  protected HashMap parametersObject;

  protected boolean closed_tree  = false;// true if the kpi tree has to start closed

  protected String model_title = "MODEL";//

  // displayed

  protected String threshold_image_title = null;//

  // displayed

  protected String bullet_chart_title = null;//

  protected String value_title = null;

  // will be displayed

  protected String kpi_title = null;//

  // will be displayed

  protected String weight_title = null;//

 

  protected boolean use_ou = false;

  protected boolean display_semaphore = true;// true if the semaphore will be

  // displayed

  protected boolean display_bullet_chart = false;// true if the bullet chart

  // displayed

  protected boolean display_threshold_image = false;// true if the bullet chart

  // will be displayed

  protected boolean display_weight = false;// true if the weight will be

  // displayed

  protected boolean display_alarm = false;// true if the alarm state will be

  // displayed

  protected boolean register_values = true;//true if the new values calculated will have to be inserted into the db

  protected boolean recalculate_anyway = false;//true if the scheduler calls the engine and wants the kpi to be calculated even if another value already exists

  protected boolean register_par_setted = false;//true if register_values is setted by SpagoBIparameter and so is more important than the template value

  protected boolean show_axis = false;//true if the range axis on the bullet chart has to be shown

  protected boolean weighted_values = false;//true if values visualized have to be weighted

  protected HashMap confMap;// HashMap with all the config parameters

  protected List resources;// List of resources linked to the

  // ModelInstanceNode

  protected Date dateOfKPI = new Date();//date when the kpiValues are requested

  protected Date endKpiValueDate = null;//End validity date for the kpiValues

  protected Integer periodInstID = null;

  protected Integer modelInstanceRootId = null;

  protected String lang = null;

  protected String country = null;

  protected String behaviour = "default";// 4 possible values:

  //default:all old kpiValues are recalculated; all kpivalues without periodicity will not be recalculated

  //display:shows all the last calculated values, even if they are not valid anymore

  //force_recalculation: all the values are recalculated

  //recalculate:old kpiValues are recalculated and also the one without a periodicity

  protected boolean dataset_multires = false;

  protected Date timeRangeFrom = null;//Begin date of range

  protected Date timeRangeTo = null;//End date of range

  protected Date dateIntervalFrom = null;//Begin date of range

  protected Date dateIntervalTo = null;//End date of range

  // used to set the return of the execution

  protected List<KpiResourceBlock> kpiResultsList;

 

  //modality of calculation: scheduler or docuement execution

  private boolean executionModalityScheduler = false;

 

  //collection of OU available and valid

  private ArrayList<OrganizationalUnitGrantNode> ouList = new ArrayList<OrganizationalUnitGrantNode>();

  private String ouWarning = null;

  //Method only called by a specific configuration of the scheduler created through the class KPIEngineJob.java

  public void execute(RequestContainer requestContainer, SourceBean response) throws EMFUserError, SourceBeanException {

    logger.debug("IN");

    //setting locale, formats, profile

    setGeneralVariables(requestContainer);

    this.parametersObject = new HashMap();

    String recalculate = (String)requestContainer.getAttribute("recalculate_anyway");

    if(recalculate.equals("true")){

      this.recalculate_anyway = true;

    } 

    // Date for which we want to see the KpiValues

    this.dateOfKPI = (Date)requestContainer.getAttribute("start_date");

    this.endKpiValueDate = (Date)requestContainer.getAttribute("end_date");

    String cascade = (String)requestContainer.getAttribute("cascade"); 

    // **************take informations on the modelInstance and its KpiValues*****************

    String modelNodeInstance = (String) requestContainer.getAttribute("model_node_instance");

    logger.info("ModelNodeInstance : " + modelNodeInstance);

    if (modelNodeInstance == null) {

      logger.error("The modelNodeInstance specified in the template is null");

      throw new EMFUserError(EMFErrorSeverity.ERROR, "10106", messageBundle);

    }

    List kpiRBlocks = new ArrayList();// List of KpiValues Trees for each Resource: it will be sent to the jsp

    if(!parametersObject.containsKey("ParKpiDate")){

      String dateForDataset = getDateForDataset(dateOfKPI); 

      parametersObject.put("ParKpiDate", dateForDataset);

    }

    // gets the ModelInstanceNode

    ModelInstanceNode mI = DAOFactory.getModelInstanceDAO().loadModelInstanceByLabel(modelNodeInstance, this.dateOfKPI);

    logger.debug("ModelInstanceNode, ID=" + mI.getModelInstanceNodeId());

    modelInstanceRootId = mI.getModelInstanceNodeId();

    logger.debug("Loaded the modelInstanceNode with LABEL " + modelNodeInstance);

    if(dataset_multires){//if datasets return a value for each resource

      this.resources = mI.getResources(); //Set all the Resources for the Model Instance

      logger.info("Dataset multiresource");

      try {

        calculateAndInsertKpiValueWithResources(mI.getModelInstanceNodeId(),this.resources);   

      } catch (EMFInternalError e) {

        e.printStackTrace();

        logger.error("Error in calculateAndInsertKpiValueWithResources",e);

      }

      logger.info("Inserted all values!!");

      return;     

    }

    // I set the list of resources of that specific ModelInstance

    if (this.resources == null || this.resources.isEmpty()) {

      this.resources = mI.getResources();

    }

    logger.debug("Setted the List of Resources related to the specified Model Instance");

    KpiLineVisibilityOptions options = setVisibilityOptions();

    if (cascade!=null && cascade.equals("true")){//in case all the kpi children have to be calculated too

      try {

        if (this.resources == null || this.resources.isEmpty()) {

          logger.debug("There are no resources assigned to the Model Instance");

          KpiResourceBlock block = new KpiResourceBlock();

          block.setD(this.dateOfKPI);

          KpiLine line = getBlock(mI.getModelInstanceNodeId(), null);       

          block.setRoot(line);

          block.setOptions(options);

          logger.debug("Setted the tree Root.");

          kpiRBlocks.add(block);

        } else {

          Iterator resourcesIt = this.resources.iterator();

          while (resourcesIt.hasNext()) {

            Resource r = (Resource) resourcesIt.next();

            logger.info("-------Resource: " + r.getName());

            KpiResourceBlock block = new KpiResourceBlock();

            block.setR(r);

        block.setD(dateOfKPI);

            block.setOptions(options);

            KpiLine line = getBlock(mI.getModelInstanceNodeId(), r);

            block.setRoot(line);

            logger.debug("Setted the tree Root.");

            kpiRBlocks.add(block);

          }

        }

      } catch (EMFInternalError e) {

        e.printStackTrace();

      }

    }else{//in case all the kpi children don't have to be calculated

      try {

        KpiInstance kpiI = mI.getKpiInstanceAssociated();

        IDataSet dataSet = DAOFactory.getKpiDAO().getDsFromKpiId(kpiI.getKpi());

        KpiValue value = new KpiValue();

        if (this.resources == null || this.resources.isEmpty()) {

          logger.debug("There are no resources assigned to the Model Instance");

          logger.debug("Retrieved the Dataset to be calculated: " + dataSet.getId());

          value = getNewKpiValue(dataSet, kpiI, null,mI.getModelInstanceNodeId(), null);

          logger.debug("New value calculated");

        } else {

          Iterator resourcesIt = this.resources.iterator();

          while (resourcesIt.hasNext()) {

            Resource r = (Resource) resourcesIt.next();

            logger.debug("Resource: " + r.getName());

            logger.debug("Retrieved the Dataset to be calculated: " + dataSet.getId());

            value = getNewKpiValue(dataSet, kpiI, r,mI.getModelInstanceNodeId(), null);         

          }

        }

        logger.debug("New value calculated");

        // Insert new Value into the DB

        IKpiDAO dao=DAOFactory.getKpiDAO();

        dao.setUserProfile(profile);

        dao.insertKpiValue(value);

        logger.debug("New value inserted in the DB");   

        // Checks if the value is alarming (out of a certain range)

        // If the value is alarming a new line will be inserted in the sbi_alarm_event table and scheduled to be sent

        DAOFactory.getAlarmDAO().isAlarmingValue(value);    

      } catch (EMFInternalError e) {

        e.printStackTrace();

      }

    }

    logger.debug("OUT");     

  }

  /**

   * Method used by basic execution and by the scheduler. Executes the document and populates the response.

   * @param requestContainer

   *                The <code>RequestContainer</code> object (the session

   *                can be retrieved from this object)

   * @param obj The <code>BIObject</code> representing the document to be executed

   * @param response The response <code>SourceBean</code> to be populated

   * @throws EMFUserError the EMF user error

   */

  public void execute(RequestContainer requestContainer, BIObject obj, SourceBean response) throws EMFUserError {

    logger.debug("IN");

    // AUDIT UPDATE

    Integer auditId = null;

    String auditIdStr = null;

    AuditManager auditManager = AuditManager.getInstance();

   

    if(requestContainer.getServiceRequest()!=null){

      auditIdStr = (String) requestContainer.getServiceRequest().getAttribute(AuditManager.AUDIT_ID);

      if (auditIdStr == null) {

          logger.warn("Audit record id not specified! No operations will be performed");

      } else {

          logger.debug("Audit id = [" + auditIdStr + "]");

          auditId = new Integer(auditIdStr);

      }

     

      if (auditId != null) {

          auditManager.updateAudit(auditId, new Long(System.currentTimeMillis()), null, "EXECUTION_STARTED", null,

            null);

      }

    }

   

    ResponseContainer responseContainer = ResponseContainer.getResponseContainer();

    EMFErrorHandler errorHandler = responseContainer.getErrorHandler();

    //setting locale, formats, profile, parameters, startDate, endDate

    setGeneralVariables(requestContainer);

    if (obj == null) {

      logger.error("The input object is null.");

      throw new EMFUserError(EMFErrorSeverity.ERROR, "100", messageBundle);

    }

    if (!obj.getBiObjectTypeCode().equalsIgnoreCase("KPI")) {

      logger.error("The input object is not a KPI.");

      throw new EMFUserError(EMFErrorSeverity.ERROR, "1001", messageBundle);

    }

    String userId = null;

    if(profile!=null){

      userId=(String) ((UserProfile) profile).getUserId();

    }

    else{

      userId=userIdField;

    }

    String documentId = obj.getId().toString();

    logger.debug("Loaded documentId:" + documentId);   

    ModelInstanceNode mI = null;

    try {

      // **************get the template*****************   

      SourceBean content = getTemplate(documentId);

      logger.debug("Got the template.");

      // Date for which we want to see the KpiValues

      this.dateOfKPI = new Date();

      this.parametersObject = readParameters(obj.getBiObjectParameters());

      addBIParameterDescriptions(obj, this.parametersObject);

     

      if(!parametersObject.containsKey("ParKpiDate")){

        String dateForDataset = getDateForDataset(dateOfKPI); 

        parametersObject.put("ParKpiDate", dateForDataset);

      }

      logger.debug("Got the date for which the KpiValues have to be calculated. Date:" + this.dateOfKPI);

      // **************take informations on the modelInstance and its KpiValues*****************

      String modelNodeInstance = (String) content.getAttribute("model_node_instance");

      logger.info("ModelNodeInstance : " + modelNodeInstance);

      if (modelNodeInstance == null) {

        logger.error("The modelNodeInstance specified in the template is null");

        throw new EMFUserError(EMFErrorSeverity.ERROR, "10106", messageBundle);

      }

      String periodInstanceID = (String) content.getAttribute("periodicity_id");

      logger.debug("PeriodInstanceID : " + (periodInstanceID!=null ? periodInstanceID : "null"));

      if (periodInstanceID == null) {

        logger.debug("No periodInstID specified will use default one");

      }else{

        periodInstID = new Integer(periodInstanceID);

      }

      getSetConf(content);

      logger.debug("Setted the configuration of the template");

      List kpiRBlocks = new ArrayList();// List of KpiValues Trees for each Resource: it will be sent to the jsp

      // gets the ModelInstanceNode

      mI = DAOFactory.getModelInstanceDAO().loadModelInstanceByLabel(modelNodeInstance, this.dateOfKPI);

      if (mI==null) {

        logger.error("MODEL INSTANCE IS NULL, CHECK model_node_instance IN DOCUMENT TEMPLATE.!!!!!!!!!!!!!!");

      }else {

        logger.debug("ModelInstanceNode, ID=" + (mI.getModelInstanceNodeId()!=null ? mI.getModelInstanceNodeId().toString():"null"));

        modelInstanceRootId = (mI.getModelInstanceNodeId()!=null ? mI.getModelInstanceNodeId() : null );

        logger.debug("Loaded the modelInstanceNode with LABEL " + modelNodeInstance);

      }

      if(dataset_multires){//if datasets return a value for each resource

        this.resources = mI.getResources(); //Set all the Resources for the Model Instance

        logger.info("Dataset multiresource");

        calculateAndInsertKpiValueWithResources(mI.getModelInstanceNodeId(),this.resources);   

        logger.info("Inserted all values!!");

        return;     

      }

      // I set the list of resources of that specific ModelInstance

      if (this.resources == null || this.resources.isEmpty()) {

        this.resources = mI.getResources();

      }

      logger.debug("Setted the List of Resources related to the specified Model Instance");

      KpiLineVisibilityOptions options = setVisibilityOptions();

      //sets up register values

      ModelInstanceNode modI = DAOFactory.getModelInstanceDAO().loadModelInstanceById(mI.getModelInstanceNodeId(), dateOfKPI);

      logger.debug("Setted the List of Kpis that does not need to be persisted in db");

      if (this.resources == null || this.resources.isEmpty()) {

        logger.debug("There are no resources assigned to the Model Instance");

        KpiResourceBlock block = new KpiResourceBlock();

        block.setD(this.dateOfKPI);

        block.setParMap(this.parametersObject);

        KpiLine line = getBlock(mI.getModelInstanceNodeId(), null);

        block.setRoot(line);

        block.setTitle(name);

        block.setSubtitle(subName);

        block.setOptions(options);

        logger.debug("Setted the tree Root.");

        kpiRBlocks.add(block);

      }else {

        Iterator resourcesIt = this.resources.iterator();

        while (resourcesIt.hasNext()) {

          Resource r = (Resource) resourcesIt.next();

          logger.info("Resource: " + r.getName());

          KpiResourceBlock block = new KpiResourceBlock();

          block.setR(r);

          block.setD(dateOfKPI);

          block.setParMap(this.parametersObject);

          KpiLine line = getBlock(mI.getModelInstanceNodeId(), r);

          block.setRoot(line);

          block.setOptions(options);

          logger.debug("Setted the tree Root.");

          kpiRBlocks.add(block);

        }

      }

      try {

        logger.debug("Successfull kpis creation");

        response.setAttribute(ObjectsTreeConstants.SESSION_OBJ_ATTR, obj);

        response.setAttribute(SpagoBIConstants.PUBLISHER_NAME, publisher_Name);

        response.setAttribute("metadata_publisher_Name", metadata_publisher_Name);

        response.setAttribute("trend_publisher_Name", trend_publisher_Name);

        if (name != null) {

          response.setAttribute("title", name);

          response.setAttribute("styleTitle", styleTitle);

        }

        if (subName != null) {

          response.setAttribute("subName", subName);

          response.setAttribute("styleSubTitle", styleSubTitle);

        }

        response.setAttribute("kpiRBlocks", kpiRBlocks);

        response.setAttribute(AuditManager.AUDIT_ID, auditId);

        kpiResultsList = kpiRBlocks;

      } catch (Exception eex) {

        EMFUserError userError = new EMFUserError(EMFErrorSeverity.ERROR, 10107);

        userError.setBundle("messages");

        throw userError;

      }

      logger.debug("OUT");

    } catch (EMFUserError e) {

      logger.error("User Error", e);

      errorHandler.addError(e);

      if(auditId!=null){

        auditManager.updateAudit(auditId, null, new Long(System.currentTimeMillis()), "EXECUTION_FAILED", e

              .getMessage(), null);   

         }

    }  

    catch (Exception e) {

      EMFUserError userError = new EMFUserError(EMFErrorSeverity.ERROR, 101);

      logger.error("Generic Error", e);

      errorHandler.addError(userError); 

      if(auditId!=null){

        auditManager.updateAudit(auditId, null, new Long(System.currentTimeMillis()), "EXECUTION_FAILED", e

              .getMessage(), null);   

         }

    }

  }

  private SourceBean getTemplate(String documentId) throws EMFUserError{

    logger.debug("IN");

    SourceBean content = null;

    byte[] contentBytes = null;

    try {

      ObjTemplate template = DAOFactory.getObjTemplateDAO().getBIObjectActiveTemplate(Integer.valueOf(documentId));

      if (template == null) {

        logger.warn("Active Template null.");

        throw new Exception("Active Template null.");

      }

      contentBytes = template.getContent();

      if (contentBytes == null) {

        logger.warn("Content of the Active template null.");

        throw new Exception("Content of the Active template null");

      }

      // get bytes of template and transform them into a SourceBean

      String contentStr = new String(contentBytes);

      content = SourceBean.fromXMLString(contentStr);

      logger.debug("Got the content of the template");

    } catch (Exception e) {

      logger.error("Error while converting the Template bytes into a SourceBean object");

      EMFUserError userError = new EMFUserError(EMFErrorSeverity.ERROR, 2003);

      userError.setBundle("messages");

      throw userError;

    }

    logger.debug("OUT");

    return content;

  }

  private void setGeneralVariables(RequestContainer requestContainer){

    logger.debug("IN");

    String isScheduledExec = (String)requestContainer.getAttribute("scheduledExecution");

    if(isScheduledExec != null && Boolean.valueOf(isScheduledExec)){

      this.executionModalityScheduler = true;

    }

    SessionContainer session = requestContainer.getSessionContainer();

    profile = (IEngUserProfile) session.getPermanentContainer().getAttribute(

        IEngUserProfile.ENG_USER_PROFILE);

    locale=GeneralUtilities.getDefaultLocale();

    lang=(String)session.getPermanentContainer().getAttribute(SpagoBIConstants.AF_LANGUAGE);

    country=(String)session.getPermanentContainer().getAttribute(SpagoBIConstants.AF_COUNTRY);

    if(lang!=null && country!=null){

      locale=new Locale(lang,country,"");

    }

    String internationalizedFormatSB = null;

    if(lang!=null && country!=null){

      internationalizedFormatSB = (SingletonConfig.getInstance().getConfigValue("SPAGOBI.DATE-FORMAT-"+lang.toUpperCase()+"_"+country.toUpperCase()+".format"));       

    }else{

      internationalizedFormatSB = (SingletonConfig.getInstance().getConfigValue("SPAGOBI.DATE-FORMAT-SERVER.format"));

    }

    internationalizedFormat = internationalizedFormatSB; 

    String formatServerSB = (SingletonConfig.getInstance().getConfigValue(("SPAGOBI.DATE-FORMAT-SERVER.format")));

    formatServer = formatServerSB;

    logger.debug("OUT");

  }

  /**

   *

   * @param

   * @param resources

   * @throws EMFUserError

   * @throws EMFInternalError

   */

  public List<KpiResourceBlock> executeCode(RequestContainer requestContainer, BIObject obj, SourceBean response, String userId) throws EMFUserError {  

    logger.debug("IN");

    userIdField=userId;

    this.execute(requestContainer, obj, response);

    if(kpiResultsList==null){

      logger.error("error while executing KPI");

      return null;

    }

    else{

      logger.error("Kpi executed succesfully");

      logger.debug("OUT");

      return kpiResultsList;

    }

  }

  private KpiLineVisibilityOptions setVisibilityOptions(){

    logger.debug("IN");

    KpiLineVisibilityOptions options = new KpiLineVisibilityOptions();

    options.setClosed_tree(closed_tree);

    options.setDisplay_alarm(display_alarm);

    options.setDisplay_bullet_chart(display_bullet_chart);

    options.setDisplay_semaphore(display_semaphore);

    options.setDisplay_threshold_image(display_threshold_image);

    options.setDisplay_weight(display_weight);

    options.setShow_axis(show_axis);

    options.setWeighted_values(weighted_values);

    options.setBullet_chart_title(bullet_chart_title);

    options.setKpi_title(kpi_title);

    options.setModel_title(model_title);

    options.setThreshold_image_title(threshold_image_title);

    options.setWeight_title(weight_title);

    options.setValue_title(value_title);

    logger.debug("OUT");

    return options;

  }

  public void calculateAndInsertKpiValueWithResources(Integer miId,List resources)throws EMFUserError, EMFInternalError, SourceBeanException {

    logger.debug("IN");

    ModelInstanceNode modI =  DAOFactory.getModelInstanceDAO().loadModelInstanceById(miId, dateOfKPI);

    if (modI != null) {

      logger.info("Loaded Model Instance Node with id: " + modI.getModelInstanceNodeId());

    }

    List childrenIds = modI.getChildrenIds();

    if (!childrenIds.isEmpty()) {

      Iterator childrenIt = childrenIds.iterator();

      while (childrenIt.hasNext()) {

        Integer id = (Integer) childrenIt.next(); 

        calculateAndInsertKpiValueWithResources(id, resources);

      }

    }

    KpiInstance kpiI = modI.getKpiInstanceAssociated();

    if (kpiI != null) {

      KpiValue kVal = new KpiValue();

      logger.info("Got KpiInstance with ID: " + kpiI.getKpiInstanceId().toString());

     

      IDataSet dataSet = DAOFactory.getKpiDAO().getDsFromKpiId(kpiI.getKpi()); 

      logger.info("Retrieved the Dataset to be calculated: " + (dataSet!=null ? dataSet.getId():"null"));

      Integer kpiInstanceID = kpiI.getKpiInstanceId();

      Date kpiInstBegDt = kpiI.getD();

      kVal = setTimeAttributes(kVal, kpiI);   

      kVal.setKpiInstanceId(kpiInstanceID);

      logger.debug("Setted the KpiValue Instance ID:"+kpiInstanceID); 

      if ( (dateOfKPI.after(kpiInstBegDt)||dateOfKPI.equals(kpiInstBegDt))) {

        //kpiInstance doesn't change

      }else{

        KpiInstance tempKIn = DAOFactory.getKpiInstanceDAO().loadKpiInstanceByIdFromHistory(kpiInstanceID,dateOfKPI);

        if(tempKIn==null){//kpiInstance doesn't change

        }else{

          // in case older thresholds have to be retrieved

          kpiI = tempKIn;

        }

      }

      kVal = getFromKpiInstAndSetKpiValueAttributes(kpiI,kVal);

      // If it has to be calculated for a Resource. The resource will be set as parameter

      HashMap temp = (HashMap) this.parametersObject.clone();

      temp.put("ParModelInstance", miId); 

      temp.put("ParKpiInstance", kpiInstanceID.toString());

      // If not, the dataset will be calculated without the parameter Resource

      // and the DataSet won't expect a parameter of type resource

      //if(dataSet.hasBehaviour( QuerableBehaviour.class.getName()) ) {

      if(dataSet!=null){

        Kpi kpi = DAOFactory.getKpiDAO().loadKpiById(kpiI.getKpi());

        //if parameter exists and OU is abilitaded for Model Instance, than calculate as dataset parameter

        String parKpiOuLabel = (String)this.parametersObject.get("ParKpiOU");

        logger.info("Got ParKpiOU: " + parKpiOuLabel);

       

        String paramLabelHierarchy = (String)this.parametersObject.get("ParKpiHierarchy");

        logger.info("Got ParKpiHierarchy: " + paramLabelHierarchy);

        setOUAbilitated(miId, parKpiOuLabel, paramLabelHierarchy);

       

        if(ouList != null && !ouList.isEmpty()){

          if(use_ou){

            for(int i = 0; i<ouList.size(); i++){

              OrganizationalUnitGrantNode grantNode = ouList.get(i);

              String ouLabel = grantNode.getOuNode().getOu().getLabel();

              String hierLabel = grantNode.getOuNode().getHierarchy().getLabel();

              if(parKpiOuLabel == null){

                this.parametersObject.put("ParKpiOU", ouLabel);

                this.parametersObject.put("ParKpiHierarchy", hierLabel);

              }

              kVal.setGrantNodeOU(grantNode);

              kVal = recursiveGetKpiValueFromKpiRel(kpi,dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), modI.getModelInstanceNodeId());

              kVal = getKpiValueFromDataset(dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), true, modI.getModelInstanceNodeId());

              if(ouWarning != null && kVal.getValue() == null){

                kVal.setValueDescr(ouWarning);   

              }

              if(parKpiOuLabel == null){

                this.parametersObject.remove("ParKpiOU");

                this.parametersObject.remove("ParKpiHierarchy");

              }

            }

          }else{

            kVal = recursiveGetKpiValueFromKpiRel(kpi,dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), modI.getModelInstanceNodeId());

            kVal = getKpiValueFromDataset(dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), true, modI.getModelInstanceNodeId());

          }

        }else{       

          if(use_ou){   

            kVal = new KpiValue();

            kVal.setValueDescr(ouWarning); 

            kVal.setKpiInstanceId(kpiI.getKpiInstanceId());

                  if(dateIntervalFrom!=null && dateIntervalTo!=null){

                    kVal.setBeginDate(dateIntervalFrom);

                    kVal.setEndDate(dateIntervalTo);

                    } else{

                      kVal.setBeginDate(dateOfKPI);

                      kVal.setEndDate(dateOfKPI);           

                    }

            kVal.setValue(null);

          }else{

            kVal = recursiveGetKpiValueFromKpiRel(kpi,dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), modI.getModelInstanceNodeId());

            kVal = getKpiValueFromDataset(dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), true, modI.getModelInstanceNodeId());

           

          } 

        }

          for(int i = 0; i<ouList.size(); i++){

            OrganizationalUnitGrantNode grantNode = ouList.get(i);

            String ouLabel = grantNode.getOuNode().getOu().getLabel();

            String hierLabel = grantNode.getOuNode().getHierarchy().getLabel();

            kVal.setGrantNodeOU(grantNode);

            kVal = recursiveGetKpiValueFromKpiRel(kpi,dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), modI.getModelInstanceNodeId());

            kVal = getKpiValueFromDataset(dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), true, modI.getModelInstanceNodeId());

          }

        }else{

          kVal = recursiveGetKpiValueFromKpiRel(kpi,dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), modI.getModelInstanceNodeId());

          kVal = getKpiValueFromDataset(dataSet,temp,kVal,dateOfKPI,kVal.getEndDate(), true, modI.getModelInstanceNodeId());

        }*/

      }

    }  

    logger.debug("OUT");

  }

  private KpiLine retrieveKpiLine(KpiLine line,KpiValue value, KpiInstance kpiI, Integer miId, Resource r, boolean alreadyExistent) throws EMFUserError, EMFInternalError, SourceBeanException{

    //if parameter exists and OU is abilitaded for Model Instance, than calculate as dataset parameter

    String parKpiOuLabel = (String)this.parametersObject.get("ParKpiOU");

    logger.info("Got ParKpiOU: " + parKpiOuLabel);

    String paramLabelHierarchy = (String)this.parametersObject.get("ParKpiHierarchy");

    logger.info("Got ParKpiHierarchy: " + paramLabelHierarchy);

    setOUAbilitated(miId, parKpiOuLabel, paramLabelHierarchy);

   

    if(ouList != null && !ouList.isEmpty()){

      if(use_ou){

        for(int i = 0; i<ouList.size(); i++){

          OrganizationalUnitGrantNode grantNode = (OrganizationalUnitGrantNode)ouList.get(i);

          String ouLabel =grantNode.getOuNode().getOu().getLabel();

          String hierLabel =grantNode.getOuNode().getHierarchy().getLabel();

          if(parKpiOuLabel == null){

            this.parametersObject.put("ParKpiOU", ouLabel);

            this.parametersObject.put("ParKpiHierarchy", hierLabel);

          }

          value = getValueDependingOnBehaviour(kpiI, miId, r, alreadyExistent , grantNode);

          line.setValue(value);

          if(ouWarning != null && value.getValue() == null){

            value.setValueDescr(ouWarning);   

          }

          if(parKpiOuLabel == null){

            this.parametersObject.remove("ParKpiOU");

          }

        }

      }else{

        value = getValueDependingOnBehaviour(kpiI, miId, r,alreadyExistent , null);//standard behaviour 

        line.setValue(value);

      }

    }else{       

      if(use_ou){   

        value = new KpiValue();

        value.setValueDescr(ouWarning); 

        value.setKpiInstanceId(kpiI.getKpiInstanceId());

              if(dateIntervalFrom!=null && dateIntervalTo!=null){

                value.setBeginDate(dateIntervalFrom);

                value.setEndDate(dateIntervalTo);

                } else{

          value.setBeginDate(dateOfKPI);

          value.setEndDate(dateOfKPI);           

                }

              value.setValue(null);

      }else{

        value = getValueDependingOnBehaviour(kpiI, miId, r,alreadyExistent , null);//standard behaviour 

       

      }

      line.setValue(value);     

    }

    return line;

  }

  public KpiLine getBlock(Integer miId, Resource r) throws EMFUserError, EMFInternalError, SourceBeanException {

    logger.debug("IN");

    KpiLine line = new KpiLine();

    ModelInstanceNode modI = DAOFactory.getModelInstanceDAO().loadModelInstanceById(miId, dateOfKPI);

    if (modI != null) {

      logger.info("Loaded Model Instance Node with id: " + modI.getModelInstanceNodeId());

    }

    String modelNodeName = modI.getName();

    line.setModelNodeName(modelNodeName);

    line.setModelInstanceNodeId(miId);

    line.setModelInstanceCode(modI.getModelCode());

    List children = new ArrayList();

    List childrenIds = modI.getChildrenIds();

    if (!childrenIds.isEmpty()) {

      Iterator childrenIt = childrenIds.iterator();

      while (childrenIt.hasNext()) {

        Integer id = (Integer) childrenIt.next(); 

        KpiLine childrenLine = getBlock(id, r);

        if(childrenLine != null){

          children.add(childrenLine);

        }

      }

    }

    KpiInstance kpiI = modI.getKpiInstanceAssociated();

    //if true the kpi value will always use the display behaviour

    boolean alreadyExistent = false;

    if (kpiI == null && modI.getModelInstaceReferenceLabel() != null){

      ModelInstanceNode modelInstanceRefered = DAOFactory.getModelInstanceDAO().loadModelInstanceByLabel(modI.getModelInstaceReferenceLabel(), dateOfKPI);

      alreadyExistent = true;

      if (modelInstanceRefered != null && modelInstanceRefered.getKpiInstanceAssociated() != null){

        kpiI = modelInstanceRefered.getKpiInstanceAssociated();

        modI.setKpiInstanceAssociated(kpiI);

      }

    }   

    line.setChildren(children);

    if (kpiI != null) {

      Integer kpiInstID = kpiI.getKpiInstanceId();

      logger.info("Got KpiInstance with ID: " + kpiInstID.toString());

      KpiValue value = null;

     

      line = retrieveKpiLine(line, value, kpiI, miId, r, alreadyExistent);

     

      Integer kpiId = kpiI.getKpi();

      Kpi k = DAOFactory.getKpiDAO().loadKpiById(kpiId);

      logger.debug("Retrieved the kpi with id: " + kpiId.toString());

           

      if (k != null) {

        List docs = k.getSbiKpiDocuments();

        Iterator it = docs.iterator();

        List documents = new ArrayList();

        while(it.hasNext()){

          KpiDocuments doc = (KpiDocuments)it.next();

          String docLabel = doc.getBiObjLabel();

          if (docLabel != null && !docLabel.equals("")) {           

            logger.debug("Retrieved documents associated to the KPI");

            documents.add(docLabel);           

          }

        }

        line.setDocuments(documents);

      }

      if (display_alarm && value!=null && value.getValue()!= null) {

        Boolean alarm = DAOFactory.getKpiInstanceDAO().isKpiInstUnderAlramControl(kpiInstID);

        logger.debug("KPI is under alarm control: " + alarm.toString());

        line.setAlarm(alarm);

      }

    }

    logger.debug("OUT");

    return line;

  }

  /**Method created to fill ouList class attribute, each time a model instance node is examined.

   * If execution modality is document execution:

   * * if node has grants but no document parameter ParKpiOU is passed, than warning (dataset will fail)

   * * if node has grants but ParKpiOU = another organizational unit not granted for the node, than warning (dataset will fail)

   * * if node has grants and ParKpiOU = granted organizational unit for the node, than add this org unit to the ouList

   * * if node doesn't have grants, than standard flow no elements in ouList, no warnings

   *

   * If execution modality is scheduled execution:

   * * if no ParKpiOU document parameter is passed, than all granted ou are added to ouList and kpi value will be calculated for each ou, generating a record on db

   * * if ParKpiOU document parameter = one ou, than the behaviour is the same as document execution modality.

   * @param miId

   * @param paramLabelOU

   */

  private void setOUAbilitated(Integer miId, String paramLabelOU, String paramLabelHierarchy){

    //if paramLabelOU doesn't exist, then scheduling mode

    //else document execution mode

    ouList = new ArrayList<OrganizationalUnitGrantNode>();

    ouWarning = null;

    //looks up for OU grants

    logger.debug("this is hierarchy:"+paramLabelHierarchy);

    List<OrganizationalUnitGrantNode> grants = DAOFactory.getOrganizationalUnitDAO().getGrantsValidByDate(miId, dateOfKPI);

    if(grants != null){

      for(int i = 0; i<grants.size(); i++){       

        OrganizationalUnitGrantNode grantNode = grants.get(i);

        OrganizationalUnitGrant grant = grantNode.getGrant();       

        OrganizationalUnitHierarchy hier = grant.getHierarchy();

        if(paramLabelOU == null){

          //scheduling mode

          if(executionModalityScheduler){

            //than all OU valid by date are filling

            if(hier.getLabel().equalsIgnoreCase(paramLabelHierarchy)){

              ouList.add(grantNode);

              ouWarning = null;

            }

          }else{

            ouWarning = "Warning: kpi needed ParKpiOU parameter.";

          } 

        }else{

          boolean found = behaveLikeDocumentExecution(paramLabelOU, paramLabelHierarchy, grantNode);

          if(!found){

            if(i == grants.size()-1){//last choice

              ouWarning = "Warning: wrong OU/Hierarchy passed as parameters.";

            }else{

              ouWarning = null;

            }

           

          }else{

            break;

          }

        }

      }

    }

  }