/******************************************************************************
    * Mosaic.java - Describe a Mosaic
    * 
    * PicMan - The BuckoSoft Picture Manager in Java
    * Copyright(c) 2008 - Dick Balaska
    * 
    */
   package com.buckosoft.PicMan.domain;
   
  import java.util.Date;
  import java.util.HashMap;
  
  /** Describe the parameters of a Mosaic that was made
   * @author Dick Balaska
   * @since 2008/02/04
   * @see <a href="http://cvs.buckosoft.com/Projects/java/PicMan/PicMan/src/com/buckosoft/PicMan/domain/Mosaic.java">Mosaic.java</a>
   */
  public class Mosaic implements Comparable<Mosaic> {
  	private	int		mid;
  	private	boolean	batch;
  	private	boolean	makeBackup = true;
  	private	String	name;
  	private	String	engine;
  	private	String	masterPic;
  	private	String	outPic;
  	private	int		tileHeight;
  	private	int		sid;
  	private	Date	startTime;
  	
  	private	int		tilesComplete;
  
  	private	HashMap<String, String>	engineConfig = new HashMap<String, String>();
  	
  	public int compareTo(Mosaic arg0) {
  		return(this.name.compareToIgnoreCase(arg0.name));
  	}
  	
  	/** Fetch the unique mosaicId
  	 * @return the mid
  	 */
  	public int getMid() {
  		return mid;
  	}
  	/**
  	 * @param mid the mid to set
  	 */
  	public void setMid(int mid) {
  		this.mid = mid;
  	}
  	/** Is this part of the definition of a MosaicBatch?
  	 * @return the batch mode flag
  	 */
  	public boolean isBatch() {
  		return batch;
  	}
  	/**
  	 * @param batch the batch to set
  	 */
  	public void setBatch(boolean batch) {
  		this.batch = batch;
  	}
  	/** Fetch the descriptive name of this mosaic run.
  	 * @return the name
  	 */
  	public String getName() {
  		return name;
  	}
  	/**
  	 * @param name the name to set
  	 */
  	public void setName(String name) {
  		this.name = name;
  	}
  	/**
  	 * @return the engine
  	 */
  	public String getEngine() {
  		return engine;
  	}
  	/**
  	 * @param engine the engine to set
  	 */
  	public void setEngine(String engine) {
  		this.engine = engine;
  	}
  	/**
  	 * @return the masterPic
  	 */
  	public String getMasterPic() {
  		return masterPic;
  	}
  	/**
  	 * @param masterPic the masterPic to set
  	 */
  	public void setMasterPic(String masterPic) {
  		this.masterPic = masterPic;
  	}
  	/** The full path to the jpeg to write.
  	 * @return the outPic
 	 */
 	public String getOutPic() {
 		return outPic;
 	}
 	/** The full path to the jpeg to write
 	 * @param outPic the outPic to set
 	 */
 	public void setOutPic(String outPic) {
 		this.outPic = outPic;
 	}
 	/**
 	 * @return the sid
 	 */
 	public int getSid() {
 		return sid;
 	}
 	/**
 	 * @param sid the sid to set
 	 */
 	public void setSid(int sid) {
 		this.sid = sid;
 	}
 	
 	/**
 	 * @return the tileHeight
 	 */
 	public int getTileHeight() {
 		return tileHeight;
 	}
 	/**
 	 * @param tileHeight the tileHeight to set
 	 */
 	public void setTileHeight(int tileHeight) {
 		this.tileHeight = tileHeight;
 	}
 	/**
 	 * @return the startTime
 	 */
 	public Date getStartTime() {
 		return startTime;
 	}
 	/**
 	 * @param startTime the startTime to set
 	 */
 	public void setStartTime(Date startTime) {
 		this.startTime = startTime;
 	}
 	/** 
 	 * @return the tilesComplete
 	 */
 	public int getTilesComplete() {
 		return tilesComplete;
 	}
 	/**
 	 * @param tilesComplete the tilesComplete to set
 	 */
 	public void setTilesComplete(int tilesComplete) {
 		this.tilesComplete = tilesComplete;
 	}
 
 	/** Should we save the mosaic output jpeg before overwriting it with a new file?
 	 * @return the makeBackup
 	 */
 	public boolean isMakeBackup() {
 		return makeBackup;
 	}
 
 	/** Should we save the mosaic output jpeg before overwriting it with a new file?
 	 * @param makeBackup the makeBackup to set
 	 */
 	public void setMakeBackup(boolean makeBackup) {
 		this.makeBackup = makeBackup;
 	}
 
 	/** Return a reference to the engine config map.
 	 * These are stored key = param name, value = String value
 	 * @return the engineConfig
 	 */
 	public HashMap<String, String> getEngineConfig() {
 		return engineConfig;
 	}
 
 	/** Set the map of engine config parameters.
 	 * @param engineConfig the engineConfig to set
 	 */
 	public void setEngineConfig(HashMap<String, String> engineConfig) {
 		this.engineConfig = engineConfig;
 	}
 	
 }