/******************************************************************************
    * JobLogEntry.java - Describe what happened
    * 
    * PicMan - The BuckoSoft Picture Manager in Java
    * Copyright(c) 2007 - Dick Balaska
    * 
    */
   package com.buckosoft.PicMan.domain;
   
  import java.text.SimpleDateFormat;
  import java.util.Date;
  
  import com.buckosoft.PicMan.util.DateUtil;
  
  /** describe an event.
   * @author Dick Balaska
   * @since 2007/12/07
   * @see <a href="http://cvs.buckosoft.com/Projects/java/PicMan/PicMan/src/com/buckosoft/PicMan/domain/JobLogEntry.java">JobLogEntry.java</a>
   */
  public class JobLogEntry {
  	public static final int	CONTACT	= 0;
  	public static final int	PICSIZE = 1;
  	public static final int	MLBFIXER = 2;
  	public static final int	MD5SUM	= 3;	
  	public static final int	MOSAIC	= 4;
  	public static final int	MOSAICV	= 5;
  	public static final int INFO	= 6;
  
  	/** Finished processing a batch run */
  	public static final int	DONE	= 7;
  	/** Unknown job log */
  	public static final int	OTHER	= 8;
  	
  	/** For subclasses to continue counting */
  	protected static final int JLELAST = 9;
  
  	public	static final int	COLOR_NORMAL = 0;
  	public	static final int	COLOR_OK = 1;
  	public	static final int	COLOR_BAD = 2;
  	
  	static private SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  
  	protected	int			type = OTHER;
  
  	private	String		note = "";
  	private	String		name = "";
  	private	Date		startTime = new Date();
  	private	Date		endTime = null;
  	private	int			color = COLOR_NORMAL;
  	private	static int	serialKey = 1;
  	private	int			serial = serialKey++;
  
  	/**
  	 * @param type the type to set
  	 */
  	public void setType(int type) {
  		this.type = type;
  	}
  
  	/**
  	 * @return the type
  	 */
  	public int getType() {
  		return type;
  	}
  
  	/** Get the Serial number for this JobLogEntry
  	 * @return The "unique" key for this entry
  	 */
  	public int	getSerial() {
  		return(serial);
  	}
  
  	/**
  	 * @return the type as a string
  	 */
  	public	String getTypeAsString() {
  		switch (type) {
  		case CONTACT:
  			return("contact");
  		case PICSIZE:
  			return("PicSize");
  		case MLBFIXER:
  			return("mlbFixer");
  		case MD5SUM:
  			return("md5sum");
  		case MOSAIC:
  			return("mosaic");
  		case MOSAICV:
  			return("mosVec");
  		case INFO:
  			return("Info");
  		case DONE:
  			return("done");
  		case OTHER:
  			return("other");
  		}
  		return("unknown");
  	}
 
 	/**
 	 * @return the endTime
 	 */
 	public Date getEndTime() {
 		return endTime;
 	}
 
 	/**
 	 * @param endTime the endTime to set
 	 */
 	public void setEndTime(Date endTime) {
 		this.endTime = endTime;
 	}
 
 	/** Set the end time of this JobLogEntry to now.
 	 */
 	public void setEndTime() {
 		this.endTime = new Date();
 	}
 
 	/**
 	 * @return the name
 	 */
 	public String getName() {
 		return name;
 	}
 
 	/**
 	 * @param name the name to set
 	 */
 	public void setName(String name) {
 		this.name = name;
 	}
 
 	/** Get any note the job might have about it's status.
 	 * @return the note
 	 */
 	public String getNote() {
 		return note;
 	}
 
 	/**
 	 * @param note the note to set
 	 */
 	public void setNote(String note) {
 		this.note = note;
 	}
 
 	/**
 	 * @return the color
 	 */
 	public int getColor() {
 		return color;
 	}
 
 	/**
 	 * @param color the color to set
 	 */
 	public void setColor(int color) {
 		this.color = color;
 	}
 
 	/**
 	 * @return the startTime
 	 */
 	public Date getStartTime() {
 		return startTime;
 	}
 
 	public void setError() {
 		setColor(COLOR_BAD);
 	}
 
 	public boolean isError() {
 		return(this.color == COLOR_BAD);
 	}
 	/**
 	 * @param startTime the startTime to set
 	 */
 	public void setStartTime(Date startTime) {
 		this.startTime = startTime;
 	}
 
 	public String getStartTimeAsString() {
 		return(dateFormat.format(getStartTime()));
 	}
 
 	public String getEndTimeAsString() {
 		if (getEndTime() != null)
 			return(dateFormat.format(getEndTime()));
 		return("0");
 	}
 
 	public String getDurationAsString() {
 		if (getEndTime() != null) {
 			return(DateUtil.timeToString(getEndTime().getTime() - getStartTime().getTime()));
 		}
 		return(DateUtil.timeToString(new Date().getTime() - getStartTime().getTime()));
 	}
 
 }