/**
    * Copyright 2005-2013 The Kuali Foundation
    *
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    * http://www.opensource.org/licenses/ecl2.php
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.kuali.rice.krms.framework.engine.result;
  
  import java.util.Collections;
  import java.util.EventObject;
  import java.util.Map;
  
  import org.joda.time.DateTime;
  import org.joda.time.format.DateTimeFormat;
  import org.joda.time.format.DateTimeFormatter;
  import org.kuali.rice.krms.api.engine.ExecutionEnvironment;
  import org.kuali.rice.krms.api.engine.ResultEvent;
  
  /**
   * An implementation of {@link ResultEvent} with start DateTime, end DateTime, and elapsed time in Milliseconds.
   * The Date is formatted using org.joda.time.format.DateTimeFormat pattern of "yyyy-MM-dd HH.mm.ss.SSS"
   *
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  public class TimingResult extends EventObject implements ResultEvent {
      
  	private static final long serialVersionUID = 5335636381355236617L;
  
      private static final DateTimeFormatter fmt = DateTimeFormat.forPattern("yyyy-MM-dd HH.mm.ss.SSS");
  	
      private String type;
  	private DateTime start;
  	private DateTime end;
  	private ExecutionEnvironment environment;
  	private String description;
  	private Map<String, ?> resultDetails;
  
      /**
       * Constructor
       * @param description of the TimingResult
       * @param type of the TimingResult
       * @param source of the TimingResult
       * @param environment {@link ExecutionEnvironment} of the TimingResult
       * @param start org.joda.time.DateTime of the TimingResult
       * @param end org.joda.time.DateTime of the TimingResult
       */
  	public TimingResult(String description, String type, Object source, ExecutionEnvironment environment, DateTime start, DateTime end){
  		super(source);
  		this.type = type;
  		this.environment = environment;
  		this.start = start;
  		this.end = end;
  		this.description = description;
  	}
  
      /**
       * Constructor
       * @param type of the TimingResult
       * @param source of the TimingResult
       * @param environment {@link ExecutionEnvironment} of the TimingResult
       * @param start org.joda.time.DateTime of the TimingResult
       * @param end org.joda.time.DateTime of the TimingResult
       */
  	public TimingResult(String type, Object source, ExecutionEnvironment environment, DateTime start, DateTime end){
  		super(source);
  		this.type = type;
  		this.environment = environment;
  		this.start = start;
  		this.end = end;
  	}
  
      /**
       * Returns the Elapsed Time in Milliseconds
       * @return Long end milliseconds minus start milliseconds
       */
  	public Long getElapsedTimeInMilliseconds(){
  		return Long.valueOf(end.getMillis() - start.getMillis());
  	}
  
      @Override
  	public ExecutionEnvironment getEnvironment(){
  		return environment;
  	};
  
      @Override
  	public String toString(){
  		StringBuffer sb = new StringBuffer();
  		sb.append(fmt.print(end));
  		sb.append(" EventType: "+ type);
  		sb.append(" (Start = " + fmt.print(start));
 		sb.append(", End = " + fmt.print(end));
 		sb.append(",  Elapsed Time = "+ getElapsedTimeInMilliseconds().toString());
 		sb.append(" milliseconds.)");
 		return sb.toString();
 	}
 
 	@Override
 	public Boolean getResult() {
 		return null;
 	}
 
 	@Override
 	public DateTime getTimestamp() {
 		return end;
 	}
 
 	@Override
 	public String getType() {
 		return type;
 	}
 
     /**
      * Returns the result details of the ResultEvent as an unmodifiable Map<?,?>
      * @return result details of the ResultEvent as an unmodifiable Map<?,?>
      */
 	@Override
 	public Map<String, ?> getResultDetails() {
 	    if (resultDetails == null) {
 	        return Collections.emptyMap();
 	    } else {
 	        return Collections.unmodifiableMap(resultDetails);
 	    }
 	}
 	
 	@Override
 	public String getDescription() {
 		return description;
 	}
 }