/******************************************************************************
    * ContactParams.java - Define how to make one contact sheet
    * 
    * PicMan - The BuckoSoft Picture Manager in Java
    * Copyright(c) 2005 - Dick Balaska
    * 
    */
   package com.buckosoft.PicMan.domain;
   
  import java.text.DecimalFormat;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  /** Define the rules to make one contact sheet.
   * @author Dick Balaska
   * @since 2005/08/07
   * @see <a href="http://cvs.buckosoft.com/Projects/PicMan/PicMan/src/main/java/com/buckosoft/PicMan/domain/ContactParams.java">ContactParams.java</a>
   */
  public class ContactParams {
  	private static final boolean DEBUG = false;
  	protected final Log logger = LogFactory.getLog(getClass());
  
  	private	int		cid;
  	private	String	setName;
  	private	int		size;
  	private	int		rankMin;
  	private	int		rankMax;
  	private	String	engineName;
  	
  	private	String	outputDirectory;
  	private	int		contactNumber;
  //	private	int		typeHint;
  
  	public ContactParams() {}
  	
  	public ContactParams(int cid, String setName, int size, int item) {
  		this.cid = cid;
  		this.setName = setName;
  		this.size = size;
  		this.contactNumber = item;
  	}
  	public ContactParams(SetSize setSize) {
  		setSetSize(setSize);
  	}
  	
  	/** Compare two ContactParams for equality.<br>
  	 * Compare chain, setName, size, and contactNumber.<br>
  	 * either size = -1 is a wildcard and will match (contactNumber is ignored in this case).<br>
  	 * either contactNumber = -1 is a wildcard and will match.
  	 * @param other The other ContactParams to compare to.
  	 * @return equality
  	 */
  	public	boolean equals(ContactParams other) {
  		if (DEBUG)
  			logger.info("equals: " + this.setName + "/" + this.size + "/" + this.contactNumber + " : " + other.setName + "/" + other.size + "/" + other.contactNumber);
  		if (this.cid != other.cid)
  			return(false);
  		if (!this.setName.equals(other.setName))
  			return(false);
  		if (this.size  == -1
  		 || other.size == -1)
  			return(true);
  		if (this.size != other.size)
  			return(false);
  		if (this.contactNumber  == -1
  		 || other.contactNumber == -1)
  			return(true);
  		if (this.contactNumber == other.contactNumber)
  			return(true);
  		return(false);
  	}
  
  	/** Compare two ContactParams for equality.<br>
  	 * Compare setName, size, min/max.<br>
  	 * Basically, we are checking if these two ContactParams will select the same set of Pics.
  	 * @param other The other ContactParams to compare to.
  	 * @return equality
  	 */
  	public boolean equalsPics(ContactParams other) {
  		if (DEBUG)
  			logger.info("equals: " + this.setName + "/" + this.size + "/" + this.contactNumber + " : " + other.setName + "/" + other.size + "/" + other.contactNumber);
  		if (!this.setName.equals(other.setName))
  			return(false);
  		if (this.size != other.size)
  			return(false);
  		if (this.rankMin != other.rankMin)
  			return(false);
  		if (this.rankMax != other.rankMax)
  			return(false);
  		return(true);
  		
  	}
  
  	/**
  	 * @return Returns the cid.
  	 */
  	public int getCid() {
  		return cid;
 	}
 
 	/**
 	 * @param cid The cid to set.
 	 */
 	public void setCid(int cid) {
 		this.cid = cid;
 	}
 
 	public void	setSetSize(SetSize setSize) {
 		this.setName = setSize.getSetName();
 		this.size	 = setSize.getSize();
 	}
 	
 	public String getSetName() {
 		return setName;
 	}
 	public void setSetName(String setName) {
 		this.setName = setName;
 	}
 	
 	/** Get the thumbnail size we should draw in
 	 * @return most likely 75,100,150,200 or 300
 	 */
 	public int getSize() {
 		return size;
 	}
 
 	/** Set the thumbnail size we should draw in
 	 * @param size most likely 75,100,150,200 or 300
 	 */
 	public void setSize(int size) {
 		this.size = size;
 	}
 
 	public String getOutputDirectory() {
 		return outputDirectory;
 	}
 	public void setOutputDirectory(String outputDirectory) {
 		this.outputDirectory = outputDirectory;
 	}
 	public int getContactNumber() {
 		return contactNumber;
 	}
 	public void setContactNumber(int contactNumber) {
 		this.contactNumber = contactNumber;
 	}
 
 	private static DecimalFormat df2 = new DecimalFormat("00");
 	private static DecimalFormat df3 = new DecimalFormat("000");
 	/** Return a String which is the Uuid of a set/size/item combo 
 	 * @return Something that looks like: mlb-075-001
 	 */
 	public	String	getUuid() {
 		return(new String(getSetName() 
 							+ "-" + df3.format(getSize()) 
 							+ "-" + df2.format(getContactNumber())));
 	}
 
 	/** Return a String which is the Uuid of a set/size combo.
 	 *  Not so much a Uuid, per se. because the item is unknown,
 	 *  so we call it a uid. */
 	public	String	getUid() {
 		DecimalFormat df3 = new DecimalFormat("000");
 		return(new String(getSetName() 
 							+ "-" + df3.format(getSize())));
 	}
 
 	/**
 	 * @return Returns the rankMax.
 	 */
 	public int getRankMax() {
 		return rankMax;
 	}
 
 	/**
 	 * @param rankMax The rankMax to set.
 	 */
 	public void setRankMax(int rankMax) {
 		this.rankMax = rankMax;
 	}
 
 	/**
 	 * @return Returns the rankMin.
 	 */
 	public int getRankMin() {
 		return rankMin;
 	}
 
 	/**
 	 * @param rankMin The rankMin to set.
 	 */
 	public void setRankMin(int rankMin) {
 		this.rankMin = rankMin;
 	}
 	
 	/** Convienence method to set the min and max ratings in one call.
 	 * 
 	 * @param min
 	 * @param max
 	 */
 	public void setRankMinMax(int min, int max) {
 		this.rankMin = min;
 		this.rankMax = max;
 	}
 
 	/** Get the name of the engine that is to build these contacts
 	 * @return the engineName
 	 */
 	public String getEngineName() {
 		return engineName;
 	}
 
 	/** Set the name of the engine that is to build these contacts
 	 * @param engineName the engineName to set
 	 */
 	public void setEngineName(String engineName) {
 		this.engineName = engineName;
 	}
 	
 }