* Copyright (c) 2007, 2010 The Planets Project Partners.

*

* All rights reserved. This program and the accompanying

* materials are made available under the terms of the

* Apache License, Version 2.0 which accompanies

* this distribution, and is available at

* http://www.apache.org/licenses/LICENSE-2.0

*

*******************************************************************************/

* @author <a href="mailto:andrew.lindley@arcs.ac.at">Andrew Lindley</a>

* @since 03.04.2009

*

*/

 

  public static final int PHASE_EXPERIMENTSETUP_1   = 1;

  public static final int PHASE_EXPERIMENTSETUP_2   = 2;

  public static final int PHASE_EXPERIMENTSETUP_3   = 3;

  public static final int PHASE_EXPERIMENTAPPROVAL   = 4;

  public static final int PHASE_EXPERIMENTEXECUTION  = 5;

    public static final int PHASE_EXPERIMENTEVALUATION = 6;

    public static final int PHASE_EXPERIMENTFINALIZED   = 7;

 

  // To avoid the data held here falling out of date, store the experiment:

  Experiment exp = null;

              

  private static Log log = LogFactory.getLog(ExperimentBean.class);

  private long id;

  private boolean formality = true;

  private String ename = new String();

    private String esummary = new String();

    private String econtactname = new String();

    private String econtactemail = new String();

    private String econtacttel = new String();

    private String econtactaddress = new String();

    private String epurpose = new String();

    private String efocus = new String();

    private String eparticipants = new String();

    private String exid = new String();

    private ArrayList<String> eref = new ArrayList<String>();

    private String erefFinder = new String();

   

    private ArrayList<String> litrefdesc = new ArrayList<String>();

    private ArrayList<String> litrefuri = new ArrayList<String>();

    private ArrayList<String> litreftitle = new ArrayList<String>();

    private ArrayList<String> litrefauthor = new ArrayList<String>();

    private String escope = new String();

    private String eapproach = new String();

    private String econsiderations = new String();

    //the selected TBServiceTemplate's ID

    private TestbedServiceTemplate selSerTemplate;

    private String sSelSerTemplateID="";

    private String sSelSerOperationName="";

    private UIComponent panelAddedSerTags = new UIPanel();

    private UIComponent panelAddedFiles = new UIPanel();

    private boolean bOperationSelectionCompleted = false;

   

    //contains the overall experiment Benchmarks. Map<BMGoal.ID, BenchmarkBean>

    private Map<String,BenchmarkBean> experimentBenchmarks = new HashMap<String,BenchmarkBean>();

    private String intensity="0";

   

    //contains the benchmarks per file basis. Map<InputFileURI+BMGoalID, BenchmarkBean>

    private Map<String, BenchmarkBean> fileBenchmarks = new HashMap<String,BenchmarkBean>();

    boolean bAnyAutoEvalConfigured = false;

   

    //The input file refs with Map<Position+"",localFileRef>

    private Map<String,String> inputData = new HashMap<String,String>();

    //distinguish between migration and characterisation output results

    //output in the form of localInputFile Ref and localFileRef/String

    private Collection<Map.Entry<String,String>> outputData = new Vector<Map.Entry<String,String>>();

    //the external file refs provided for step evaluate experiment

  private List<String> evaluationData = new ArrayList<String>();

 

    private int currStage = ExperimentBean.PHASE_EXPERIMENTSETUP_1;

    private boolean approved = false;

   

    private List<String> dtype = new ArrayList<String>();

    private List<SelectItem> dtypeList = new ArrayList<SelectItem>();

    private DigitalObjectTypesImpl dtypeImpl = new DigitalObjectTypesImpl();

    private List<String[]> fullDtypes = new ArrayList<String[]>();

   

    private ExecutionRecordImpl selectedExecutionRecord = null;

    private BatchExecutionRecordImpl selectedBatchExecutionRecord = null;

    private String selectedDigitalObject = null;

    private ExperimentStageBean selectedStage;

   

    private String ereportTitle;

    private String ereportBody;

 

  private int expRating = 0;

  private int serviceRating = 0;

   

    //a list of added annotationTagNames to restrict the displayed services

    private Map<String,ServiceTag> mapAnnotTagVals = new HashMap<String,ServiceTag>();

    //triggers the XMLResponds in case of an error for stage6

    private boolean bRenderXMLResponds = false;

   

    private long numExecutions;

       

    public ExperimentBean() {

      /*experimentBenchmarks = new HashMap<String,BenchmarkBean>();

      Iterator iter = BenchmarkGoalsHandlerImpl.getInstance().getAllBenchmarkGoals().iterator();

      while (iter.hasNext()) {

        BenchmarkGoal bm = (BenchmarkGoal)iter.next();

        experimentBenchmarks.put(bm.getID(), new BenchmarkBean(bm));

      }*/

       

        fullDtypes = dtypeImpl.getAlLDtypes();

       

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

           

            String[] tmp = fullDtypes.get(i);

           

            SelectItem option = new SelectItem(tmp[0],tmp[1]);

            dtypeList.add(option); 

        }

       

        // Add in default data:

        UserBean user = (UserBean)JSFUtil.getManagedObject("UserBean");

        this.setUserData(user);

       

        // Default spaces:

        this.litrefdesc.add("");

        this.litrefuri.add("");

        this.litreftitle.add("");

        this.litrefauthor.add("");

        // log

        log.info("New ExperimentBean constructed.");

    }

   

    public void setUserData( UserBean user ) {

        if( user != null ) {

            this.eparticipants = user.getUserid();

            this.econtactname = user.getFullname();

            this.econtactemail = user.getEmail();

            this.econtacttel = user.getTelephone();

            this.econtactaddress = user.getAddress();

        } else {

            log.error("Attempted to re-fill user data with a null user.");

        }

    }

   

    @SuppressWarnings("deprecation")

  public void fill(Experiment exp) {

        log.info("Filling the ExperimentBean with experiment: "+ exp.getExperimentSetup().getBasicProperties().getExperimentName() + " ID:"+exp.getEntityID());

        log.debug("Experiment Phase Name = " + exp.getPhaseName());

        log.debug("Experiment Current Phase " + exp.getCurrentPhase());

        if( exp.getCurrentPhase() != null )

            log.debug("Experiment Current Phase Stage is " + exp.getCurrentPhase().getState());

        this.exp = exp;

      ExperimentSetup expsetup = exp.getExperimentSetup();

      BasicProperties props = expsetup.getBasicProperties();

      this.id = exp.getEntityID();

      this.ename =(props.getExperimentName());

      this.escope=(props.getScope());

      this.econsiderations=(props.getConsiderations());

      this.econtactaddress=(props.getContactAddress());

      this.econtactemail=(props.getContactMail());

      this.econtacttel=(props.getContactTel());

      this.econtactname=(props.getContactName());

       

        // references

        this.exid=props.getExternalReferenceID();

       

        List<String[]> lit = props.getAllLiteratureReferences();

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

            this.litrefdesc = new ArrayList<String>(lit.size());

            this.litrefuri = new ArrayList<String>(lit.size());

            this.litreftitle = new ArrayList<String>(lit.size());

            this.litrefauthor = new ArrayList<String>(lit.size());

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

            this.litrefdesc.add(i, lit.get(i)[0]);

            this.litrefuri.add(i,lit.get(i)[1]);

            this.litreftitle.add(i,lit.get(i)[2]);

            this.litrefauthor.add(i,lit.get(i)[3]);

            }

        }      

       

        List<Long> refs = props.getExperimentReferences();

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

            this.eref = new ArrayList<String>(refs.size());

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

                this.eref.add(i, ""+refs.get(i) );

        }       

        List<String> involvedUsers = props.getInvolvedUserIds();

        String partpnts = " ";

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

            partpnts +=involvedUsers.get(i);

            if( i < involvedUsers.size()-1 ) partpnts += ", ";

        }

       

        this.eparticipants = partpnts;

       

        String Test = props.getExternalReferenceID();

       

        this.exid=(Test);

       

        this.efocus=(props.getFocus());

      this.epurpose=(props.getPurpose());

      this.esummary=(props.getSummary());

      this.formality = props.isExperimentFormal();     

     

        //get already added TestbedServiceTemplate data

        log.debug("fill expBean: executable = "+exp.getExperimentExecutable());

        if(exp.getExperimentExecutable()!=null){

          ExperimentExecutable executable = exp.getExperimentExecutable();

          this.selSerTemplate = executable.getServiceTemplate();

          if( selSerTemplate != null )

              this.sSelSerTemplateID = selSerTemplate.getUUID();

          this.sSelSerOperationName = executable.getSelectedServiceOperationName();

          this.bOperationSelectionCompleted = true;

          helperLoadInputData(executable.getInputData());

          if(executable.isExecutionSuccess()){

            //uses the executable to get the data

              this.outputData = exp.getExperimentExecutable().getOutputDataEntries();

          }

        }

    

        //fill the file benchmarks

        log.info("Looking for BMGs... ");

        try {

          if (exp.getCurrentPhase() instanceof ExperimentEvaluation) {

              if (this.inputData != null) {

                  //iterate over all input files

                  for(String localFileRef : this.inputData.values()) {

                      // Clean up the localFileRef, so that the TB can cope with it's data store being moved.

                      //store a set of file BMGoals for every record item

                      DataHandler dh = new DataHandlerImpl();

                      DigitalObjectRefBean dorb = dh.get(localFileRef);

                      if( dorb != null ) {

                          URI inputFileURI = dorb.getDownloadUri();

                          Collection<BenchmarkGoal> colFileBMGoals = exp.getExperimentEvaluation().getEvaluatedFileBenchmarkGoals(inputFileURI);

                          if(colFileBMGoals==null)

                              throw new Exception("Exception while setting file benchmarks for record: "+inputFileURI);

                          for(BenchmarkGoal bmg : colFileBMGoals){

                              log.info("Found fileBMG: " + bmg.getName());

                              log.info("Found fileBMG.id: " + bmg.getID());

                              //now crate the bmb out of the bmg

                              BenchmarkBean bmb = new BenchmarkBean(bmg);

                              bmb.setSourceValue(bmg.getSourceValue());

                              bmb.setTargetValue(bmg.getTargetValue());

                              bmb.setEvaluationValue(bmg.getEvaluationValue());

                              bmb.setWeight(String.valueOf(bmg.getWeight()));

                              bmb.setSelected(true);

                              if((bmb.getSourceValue()==null)||(bmb.getSourceValue().equals("")))

                                  bmb.setSrcError(true);

                              if((bmb.getTargetValue()==null)||(bmb.getTargetValue().equals("")))

                                  bmb.setTarError(true);             

                              //now add the file bmbs for this experimentbean

                              fileBenchmarks.put(inputFileURI+bmb.getID(), bmb);

                          }

                      }

            }

          }

          }

         

          //fill the experiment overall benchmarks

          Collection<BenchmarkGoal> lbmbs;

          if (exp.getCurrentPhase() instanceof ExperimentEvaluation){

            //get the data from the evaluation phase

            lbmbs = exp.getExperimentEvaluation().getEvaluatedExperimentBenchmarkGoals();

                log.info("Found eval #BMGs = " + lbmbs.size());

                log.info("Found pre-eval #BMGs = " + exp.getExperimentSetup().getAllAddedBenchmarkGoals().size());

                // if none, get the data from the setup phase

                if( lbmbs.size() == 0 )

                    lbmbs = exp.getExperimentSetup().getAllAddedBenchmarkGoals();

          }

          else{

            //get the data from the setup phase

            lbmbs = exp.getExperimentSetup().getAllAddedBenchmarkGoals();

                log.info("Found pre-eval #BMGs = " + lbmbs.size());

          }    

        for(BenchmarkGoal bmg : lbmbs){

                log.info("Found BMG: " + bmg.getName());

                log.info("Found BMG.id: " + bmg.getID());

            BenchmarkBean bmb = new BenchmarkBean(bmg);

            bmb.setSourceValue(bmg.getSourceValue());

            bmb.setTargetValue(bmg.getTargetValue());

            bmb.setEvaluationValue(bmg.getEvaluationValue());

            bmb.setWeight(String.valueOf(bmg.getWeight()));

            bmb.setSelected(true);

            experimentBenchmarks.put(bmg.getID(), bmb);

          }

        }catch (Exception e) {

          log.error("Exception during attempt to create ExperimentBean for: "+e.toString());

          if( log.isDebugEnabled() ) e.printStackTrace();

        }

     

       

      String intensity = Integer.toString(exp.getExperimentSetup().getExperimentResources().getIntensity());

      if (intensity != null && intensity != "-1")

        this.intensity = intensity;

      // determine current Stage

      ExperimentPhase currPhaseObj = exp.getCurrentPhase();

      if (currPhaseObj != null) {

        String currPhase = currPhaseObj.getPhaseName();

        if (currPhase.equals(ExperimentPhase.PHASENAME_EXPERIMENTSETUP)) {

          this.currStage = exp.getExperimentSetup().getSubStage();

        } else if (currPhase.equals(ExperimentPhase.PHASENAME_EXPERIMENTAPPROVAL)) {

          this.currStage = ExperimentBean.PHASE_EXPERIMENTAPPROVAL;

        } else if (currPhase.equals(ExperimentPhase.PHASENAME_EXPERIMENTEXECUTION)) {

          this.currStage = ExperimentBean.PHASE_EXPERIMENTEXECUTION;

            } else if (currPhase.equals(ExperimentPhase.PHASENAME_EXPERIMENTEVALUATION)) {

                this.currStage = ExperimentBean.PHASE_EXPERIMENTEVALUATION;

            } else if (currPhase.equals(ExperimentPhase.PHASENAME_EXPERIMENTFINALIZED)) {

                this.currStage = ExperimentBean.PHASE_EXPERIMENTFINALIZED;               

            }

      }

      if(currStage>ExperimentBean.PHASE_EXPERIMENTSETUP_3) {

          approved=true;

      } else {

          approved=false;

      }

       

        this.dtype = props.getDigiTypes();

       

        // Set the report up:

        this.ereportTitle = exp.getExperimentEvaluation().getExperimentReport().getHeader();

        this.ereportBody = exp.getExperimentEvaluation().getExperimentReport().getBodyText();

        this.evaluationData = exp.getExperimentEvaluation().getExternalEvaluationDocuments();

   

    //deal with ratings

    this.expRating = exp.getExperimentEvaluation().getExperimentRating();

    this.serviceRating = exp.getExperimentEvaluation().getServiceRating();

    }

    //END OF FILL METHOD

    /**

     */

    public String redirectToCurrentStage() {

        NewExpWizardController.redirectToCurrentStage(this.exp);

        return "success";

    }

   

    public Map<String,BenchmarkBean> getExperimentBenchmarks() {

    return experimentBenchmarks;     

    }

   

    /**

     * Please note the String (key) is composed by the Input file's URI+BMGoalID

     * @return

     */

    public Map<String, BenchmarkBean> getFileBenchmarkBeans(){

      return this.fileBenchmarks;

    }

   

    public List<BenchmarkBean> getExperimentBenchmarkBeans() {

      return new ArrayList<BenchmarkBean>(experimentBenchmarks.values());

    }

   

   

    /**

     * It's only possible to add/remove experiment overall benchmark beans.

     * File BMBs are identically and are cloned from them

     * @param bmb

     */

    public void addBenchmarkBean(BenchmarkBean bmb) {

      this.experimentBenchmarks.put(bmb.getID(),bmb);

    }

   

    /**

     * It's only possible to add/remove experiment overall benchmark beans.

     * File BMBs are identically and are cloned from them

     * @param bmb

     */

    public void deleteBenchmarkBean(BenchmarkBean bmb) {

      this.experimentBenchmarks.remove(bmb.getID());

    }

   

    /**

     * It's only possible to add/remove experiment overall benchmark beans.

     * File BMBs are identically and are cloned from them

     * @param bmb

     */

    public void setBenchmarks(Map<String,BenchmarkBean>bms) {

      this.experimentBenchmarks = bms;

    }

   

    /**

     * Returns the selected service template UUID

     * @return

     */

    public String getSelectedServiceTemplateID() {

      if (selSerTemplate !=null)

        return selSerTemplate.getUUID();

      else

        return this.sSelSerTemplateID;

    }

   

    public void setSelServiceTemplateID(String sID){

      this.sSelSerTemplateID = sID;

      setSelectedServiceTemplate(sID);

    }

   

    public void setSelectedServiceOperationName(String sName){

      this.sSelSerOperationName = sName;

    }

   

    public String getSelectedServiceOperationName(){

      return this.sSelSerOperationName;

    }

   

    /**

     * Sets the selected object's id and also fetches the object from the registry

     * @param sID

     */

    public void setSelectedServiceTemplate(String sID){

      ServiceTemplateRegistry registry = ServiceTemplateRegistryImpl.getInstance();

      this.selSerTemplate = registry.getServiceByID(sID);

    }

   

    public TestbedServiceTemplate getSelectedServiceTemplate(){

      return this.selSerTemplate;

    }

   

    public void removeSelectedServiceTemplate(){

      this.selSerTemplate = null;

      this.sSelSerTemplateID = null;

      this.sSelSerOperationName = null;

    }

    public ServiceOperation getSelectedServiceOperation(){

      if( this.selSerTemplate != null ) {

        TestbedServiceTemplate template = this.getSelectedServiceTemplate();

        List<String> allOpNames = template.getAllServiceOperationNames();

        String selOpName = this.getSelectedServiceOperationName();

        //template contains no operations

        if(allOpNames.size()==0)

          return null;

        //template is being changed - select first op as selected

        if(!allOpNames.contains(selOpName)){

          this.setSelectedServiceOperationName(allOpNames.iterator().next());

        }

       

        return template.getServiceOperation(this.getSelectedServiceOperationName());

      }

      return null;

    }

    /**

     * Get a copy of the experiment underneath this bean.

     * @return The Experiment this Bean wraps.

     */

    public Experiment getExperiment() {

        return exp;

    }

    public void setExperiment(Experiment exp) {

        this.exp = exp;

    }

    /**

     * Returns a Map of added file Refs

     * Map<position+"",fileRef>

     * @return

     */

    public Map<String,String> getExperimentInputData() {

        log.debug("getting experiment input data: "+this.inputData);

        return this.inputData;

    }

 

    //public Map<String,String> getExperimentEvaluationData() {

    //    log.debug("getting experiment evaluation data: "+this.evaluationData);

    //    return this.evaluationData;

    //}

   

    /**

     * fetches a jsf usable list of the experimentInputData values

     * @return

     */

    public List<DigitalObjectBean> getExperimentInputDataValues(){

      List<DigitalObjectBean> ret = new ArrayList<DigitalObjectBean>();

      for(String val : this.getExperimentInputData().values()){

        DigitalObjectBean digoBean = new DigitalObjectBean(val);

        ret.add(digoBean);

      }

      return ret;

    }

 

    //public List<DigitalObjectBean> getExperimentEvaluationDataValues(){

    //  List<DigitalObjectBean> ret = new ArrayList<DigitalObjectBean>();

    //  for(String val : this.getExperimentEvaluationData().values()){

    //    DigitalObjectBean digoBean = new DigitalObjectBean(val);

    //    ret.add(digoBean);

    //  }

    //  return ret;

    //}

   

    /**

     * Get the list of files as a simple String collection.

     * @return

     */

    public Collection<String> getExperimentInputDataFiles() {

        return this.inputData.values();

    }

 

    //public Collection<String> getExperimentEvaluationDataFiles() {

    //    return this.evaluationData.values();

    //}

   

    /**

     * Returns a map containing the input data's uri as key and its corresponding

     * original logical file name as value

     * e.g. Collection<Map<"http://../planets-testbed/inputdata/fdsljfsdierw.doc,"data1.doc">>

     * This is used to render as dataTable within the GUI

     * @return

     */

    public Collection<Map<String,String>> getExperimentInputDataNamesAndURIs(){

      return helperGetDataNamesAndURIS("design experiment");

    }

   

    /**

     * Returns a map containing the evaluation data's uri as key and its corresponding

     * original logical file name as value

     * e.g. Collection<Map<"http://../planets-testbed/inputdata/fdsljfsdierw.doc,"data1.doc">>

     * This is used to render as dataTable within the GUI

     * @return

     */

    public Collection<Map<String,String>> getExperimentEvaluationDataNamesAndURIs(){

      return helperGetDataNamesAndURIS("evaluate expeirment");

    }

   

   

    private Collection<Map<String,String>> helperGetDataNamesAndURIS(String expStage){

      Collection<Map<String,String>> ret = new Vector<Map<String,String>>();

      DataHandler dh = new DataHandlerImpl();

     

      //when we're calling this in design experiment -> fetch the input data refs

      if(expStage.equals("design experiment")){

        Map<String, String> localFileRefs = this.getExperimentInputData();

          for( String key : localFileRefs.keySet() ) {

              boolean found = false;

            try {

              Map<String,String> map = new HashMap<String,String>();

              //retrieve URI

                String fInput = localFileRefs.get(key);

                DigitalObjectRefBean dobr = dh.get(fInput);

                if( dobr != null ) {

                    URI uri = dobr.getDownloadUri();

                    map.put("uri", uri.toString()) ;

                    map.put("name", this.createShortDoName(dobr) );

                    map.put("inputID", key);

                    ret.add(map);

                    found = true;

                } else {

                    log.error("Digital Object "+key+" could not be found!");

                }

          } catch (FileNotFoundException e) {

            log.error(e.toString());

          }

          // Catch lost items...

          if( !found ) {

                    Map<String,String> map = new HashMap<String,String>();

                    String fInput = localFileRefs.get(key);

                    map.put("uri", fInput);

                    map.put("name", "ERROR: Digital Object Not Found: " + getLeafnameFromPath(fInput));

                    map.put("inputID", key);

                    ret.add(map);

          }

          }

      }

      //when we're calling this in evaluate experiment -> fetch the external eval data refs

      if(expStage.equals("evaluate expeirment") && this.getEvaluationExternalDigoRefs() != null ){

        for(String digoRef : this.getEvaluationExternalDigoRefs()){

          try {

          Map<String,String> map = new HashMap<String,String>();

          DigitalObjectRefBean dobr = dh.get(digoRef);

          if(dobr != null ) {

            URI uri = dobr.getDownloadUri();

            map.put("uri", uri.toString()) ;

            map.put("name", this.createShortDoName(dobr) );

            map.put("inputID", dobr.getDomUri()+"");

            ret.add(map);

                } else {

                  log.error("Digital Object "+digoRef+" could not be found!");

                }

          } catch (FileNotFoundException e) {

            log.error(e.toString());

          }

        }

      }

      return ret;

    }

   

    /**

     * returns the digital objects that are uploaded in step: evaluate experiment

     * @return

     */

    public List<String> getEvaluationExternalDigoRefs(){

      return this.evaluationData;

    }

   

    public void removeEvaluationExternalDigoRef(String digoRef){

      this.evaluationData.remove(digoRef);

      //this.getExperiment().getExperimentEvaluation().removeExternalEvaluationDocument(digoRef);

      this.updateExperiment();

    }

   

    public void addEvaluationExternalDigoRef(String digoRef){

      this.evaluationData.add(digoRef);

      //this.getExperiment().getExperimentEvaluation().addExternalEvaluationDocument(digoRef);

      this.updateExperiment();

    }

 

    //public Collection<Map<String,String>> getExperimentEvaluationDataNamesAndURIs(){

    //  Collection<Map<String,String>> ret = new Vector<Map<String,String>>();

    //  DataHandler dh = new DataHandlerImpl();

    //  Map<String, String> localFileRefs = this.getExperimentEvaluationData();

    //  for( String key : localFileRefs.keySet() ) {

    //    try {

    //      Map<String,String> map = new HashMap<String,String>();

    //      //retrieve URI

    //        String fInput = localFileRefs.get(key);

    //        DigitalObjectRefBean dobr = dh.get(fInput);

    //        if(dobr != null ) {

  //      URI uri = dobr.getDownloadUri();

  //      map.put("uri", uri.toString()) ;

  //      map.put("name", this.createShortDoName(dobr) );

  //      map.put("inputID", key);

  //      ret.add(map);

    //        } else {

    //          log.error("Digital Object "+key+" could not be found!");

    //        }

  //    } catch (FileNotFoundException e) {

  //      log.error(e.toString());

  //    }

    //  }