/*
    * The contents of this file are subject to the terms 
    * of the Common Development and Distribution License 
    * (the "License").  You may not use this file except 
    * in compliance with the License.
    * 
    * You can obtain a copy of the license at 
    * http://www.sun.com/cddl/cddl.html. 
    * See the License for the specific language governing 
   * permissions and limitations under the License.
   * 
   * When distributing Covered Code, include this CDDL 
   * HEADER in each file and include the License file at 
   * license.txt.  If applicable, add the following below 
   * this CDDL HEADER, with the fields enclosed by brackets 
   * "[]" replaced with your own identifying information: 
   * Portions Copyright [yyyy] [name of copyright owner]
   * 
   * Portions Copyright 2004 eBay, Inc.
   */
  package com.ebay.carad.os.vitalsigns;
  
  import java.util.Collections;
  import java.util.List;
  
  import org.apache.commons.lang.builder.ToStringBuilder;
  import org.apache.log4j.Logger;
  
  import com.ebay.carad.os.vitalsigns.templates.ITemplatizable;
  import com.ebay.carad.os.vitalsigns.util.ITimeConstants;
  import com.ebay.carad.os.vitalsigns.util.MessageFormatUtil;
  
  /***
   * Configuration object for the reports that are run by ReportAgent.
   * 
   * @author Jeremy Kraybill
   * @author Jeremy Thomerson
   * @version $Id$
   */
  public class DashboardReport extends AbstractListenerContainer implements Comparable, IDashboardReport, IDashboardReportContainer, ITemplatizable {
  	
  	private String title;
  	private String subTitle;
      private String mGroupName;
      private int frequencyInMinutes;
  	private int id = -1;
  	private int sortOrder;
  	private boolean moreIsBetter;
      private IDataRetriever mDataRetriever = IDataRetriever.NO_OP_DATA_RETRIEVER;
  	
      private Float lastObservedValue = IDataRetriever.ZERO;
      private Float previouslyObservedValue = IDataRetriever.ZERO;
  	private long lastRunTimestamp = 0;
  	private boolean mIncludeInSummary;
  
  	private static final Logger LOGGER = Logger.getLogger(DashboardReport.class);
  	
  	/***
  	 * Basic constructor.
  	 */
  	public DashboardReport() {
  		// do nothing
  	}
  	
  	/***
  	 * Copy constructor.
  	 * 
  	 * @param copyFrom report to use as a template
  	 */
  	public DashboardReport(DashboardReport copyFrom) {
  		frequencyInMinutes = copyFrom.getFrequencyInMinutes();
  		id = copyFrom.getID();
  		moreIsBetter = copyFrom.getMoreIsBetter();
  		sortOrder = copyFrom.getSortOrder();
  		subTitle = copyFrom.getSubTitle();
  		title = copyFrom.getTitle();
  		try {
              mDataRetriever = (IDataRetriever) copyFrom.mDataRetriever.clone();
          } catch (CloneNotSupportedException cnse) {
              throw new ReportingException("error cloning data retriever for template creation: " + cnse.getMessage(), cnse);
          }
  		mIncludeInSummary = copyFrom.mIncludeInSummary;
  	}
  
  	public void run(IDashboardAgent agent, long inRunTime) {
          // run daily reports at 2 AM (UTC - 5 for eastern, then -2 to key off 2am)
  		// TODO FIXME : this is specialized for CARad - needs to be genericized 
          //      -- preferably allow daily run time to be configured (injected)
  	    long runTime = inRunTime - (7 * ITimeConstants.HOUR); 
  	    long runMinute = runTime / ITimeConstants.MINUTE;
  		if ((runMinute % getFrequencyInMinutes() == 0) || (runTime - lastRunTimestamp >= getFrequencyInMinutes() * ITimeConstants.MINUTE)) {
  		    // it's either on the correct minute for us to run, 
              //      or it's been longer than our frequency since we last ran; do it now.
              Float data = mDataRetriever.getData(agent);
              // preserve this and previous data
              previouslyObservedValue = lastObservedValue;
              lastObservedValue = data;
  			lastRunTimestamp = runTime;
  	        if (lastObservedValue != null) {
 	            agent.getDefaultDataDAO().storeReportData(lastObservedValue.floatValue(), agent, this);
 	        }
 		}
 		
 		// The following line is not necessary because a well-behaved implementation of 
 		//	IDashboardAgent will perform this function.
 		// fireListenersReportRan(agent, this);
     }
 	
     /***
      * Templatizes the title / subtitle / ID based on the objects passed in.
      * Note the behavior: we reset ID based on templatized title's hashcode, therefore,
      * the ID must be unique among your report set.
      * @see com.ebay.carad.os.vitalsigns.templates.ITemplatizable#templatize(java.lang.Object[])
      */
     public void templatize(Object[] substitutions) {
     	setTitle(MessageFormatUtil.format(getTitle(), substitutions));
     	setSubTitle(MessageFormatUtil.format(getSubTitle(), substitutions));
 		setID(getTitle().hashCode());
         if (mDataRetriever instanceof ITemplatizable) {
             ((ITemplatizable) mDataRetriever).templatize(substitutions);
         }
 		LOGGER.info("templatize(): templatized into report \"" + getTitle() + "\" as ID " + getID());
     }
 
 	public int getID() {
 	    return id;
 	}
 
 	public String getTitle() {
 	    return title;
 	}
 	
 	public String getSubTitle() {
 	    return subTitle;
 	}
 	
 	public boolean getMoreIsBetter() {
 	    return moreIsBetter;
 	}
 	
 	/***
 	 * Sets the title of this report.
 	 * 
 	 * @param inTitle the title to set to
 	 */
 	public void setTitle(String inTitle) { 
 	    title = inTitle;
     }
 	
 	/***
 	 * Sets the sub-title of this report.
 	 * 
 	 * @param title the sub-title to use
 	 */
 	public void setSubTitle(String title) {
 	    subTitle = title;
 	}	
 	
 	public int getFrequencyInMinutes() {
 	    return frequencyInMinutes;
 	}
 	
 	/***
 	 * Sets the frequency in minutes for the generation of this report. Currently, only valid values are
 	 * 15, 60 or 1440.
 	 * TODO : is this comment still correct?  is there a restriction on how often it can run? I presume this is only valid if the reportagent is triggered less than given amount
 	 * 
 	 * @param freq the frequency in minutes
 	 */
 	public void setFrequencyInMinutes(int freq) {
 	    frequencyInMinutes = freq;
 	}
 	
 	/***
 	 * Sets the ID of this report. If more than one report has the same ID, bad things will happen!
 	 * 
 	 * @param setId the ID to use
 	 */
 	public void setID(int setId) { 
 		id = setId;
 	}	
 
     /***
 	 * Sets the display sort order of this report. Reports with the same sort order will be sorted
 	 * in a non-guaranteed order.
 	 * 
 	 * @param setSortorder the order to use
 	 */
 	public void setSortOrder(int setSortorder) {
 	    sortOrder = setSortorder;
 	}
 
 	/***
 	 * Sets whether this report represents a value that should be increasing over time.
 	 * 
 	 * @param flag if true, this report is "happy" when its value has increased
 	 */
 	public void setMoreIsBetter(boolean flag) { moreIsBetter = flag; }
 	
 	public int compareTo(Object obj) {
 		IDashboardReportContainer rc = (IDashboardReportContainer) obj;
 		return getSortOrder() - rc.getSortOrder();
 	}
 	
 	public List getReports() {
 		return Collections.singletonList(this);
 	}
 
 	public int getSortOrder() {
 		return sortOrder;
 	}
 
     public void setDataRetriever(IDataRetriever dataRetriever) {
         mDataRetriever = dataRetriever;
     }
 
     public Float getThisRunData() {
         return lastObservedValue;
     }
 
     public Float getPreviousData() {
         return previouslyObservedValue;
     }
 
 	public boolean getIncludeInSummary() {
 		return mIncludeInSummary;
 	}
 	public void setIncludeInSummary(boolean includeInSummary) {
 		mIncludeInSummary = includeInSummary;
 	}
 
 
     /***
      * @return Returns the groupName.
      * @see IDashboardReportContainer#getGroupName()
      */
     public String getGroupName() {
         return mGroupName;
     }
 
     /***
      * @param groupName The groupName to set.
      * @see IDashboardReportContainer#getGroupName()
      */
     public void setGroupName(String groupName) {
         mGroupName = groupName;
     }
 
     public String toString() {
         return new ToStringBuilder(this)
             .append("id", id)
             .append("title", title)
             .append("sortOrder", sortOrder)
             .toString();
     }
 }