/******************************************************************************
    * Chain.java - a chain bean, define a chain of attributes to make one set of contacts
    * 
    * PicMan - The BuckoSoft Picture Manager in Java
    * Copyright(c) 2005 - Dick Balaska
    * 
    */
   package com.buckosoft.PicMan.domain;
   
  import java.io.Serializable;
  import java.util.Iterator;
  import java.util.LinkedList;
  import java.util.List;
  
  /** Define the attributes required to make one set of contacts
   * @author Dick Balaska
   * @since 2005/07/30
   * @see <a href="http://cvs.buckosoft.com/Projects/PicMan/PicMan/src/main/java/com/buckosoft/PicMan/domain/Chain.java">Chain.java</a>
   */
  public class Chain implements Serializable, DataStrings {
  	private static final long serialVersionUID = 1L;
  	
  	private	int		cid = -1;
  	private	String	name;
  	private	String	shortName = "";
  	private	String	contactPrefix = "";
  	private	String	description = "";
  	private	boolean	active = false;
  	private	String	engine = "";
  	private	String	contactDirectory = "";
  	private	int		contactCount = 4;
  	private	int		contactWidth = 640;
  	private	int		contactHeight = 480;
  	private	int		picSelector = PICSELECTOR_SORT;
  	private	int		ratingMin = 1;
  	private	int		ratingMax = 9;
  	private	boolean	showUnusedSets = true;
  	
  	private	LinkedList<SetSize>	setSizes = new LinkedList<SetSize>();
  	
  	public	void	setName(String name) { this.name = name; }
  	public	String	getName() { return(name); }
  	
  	public	void	setDescription(String desc) { this.description = desc; }
  	public	String	getDescription() { return(description); }
  
  	
  	/**
  	 * @return Returns the cid.
  	 */
  	public int getCid() {
  		return cid;
  	}
  	/**
  	 * @param cid The cid to set.
  	 */
  	public void setCid(int cid) {
  		this.cid = cid;
  	}
  
  	/**
  	 * @return Returns the shortName.
  	 */
  	public String getShortName() {
  		return shortName;
  	}
  	/**
  	 * @param shortName The shortName to set.
  	 */
  	public void setShortName(String shortName) {
  		this.shortName = shortName;
  	}
  
  	/**
  	 * @return Returns whether this chain is active.
  	 */
  	public boolean isActive() {
  		return active;
  	}
  	/**
  	 * @param active Set whether this chain is active.
  	 */
  	public void setActive(boolean active) {
  		this.active = active;
  	}
  
  	public String getContactPrefix() { return(contactPrefix); }
  	public void setContactPrefix(String contactPrefix) { this.contactPrefix = contactPrefix; }
  	
  	
  	public int getContactCount() {
  		return contactCount;
  	}
  	public void setContactCount(int contactCount) {
  		this.contactCount = contactCount;
  	}
  	public String getContactDirectory() {
  		return contactDirectory;
  	}
 	public void setContactDirectory(String contactDirectory) {
 		this.contactDirectory = contactDirectory;
 	}
 	public int getContactHeight() {
 		return contactHeight;
 	}
 	public void setContactHeight(int contactHeight) {
 		this.contactHeight = contactHeight;
 	}
 	public int getContactWidth() {
 		return contactWidth;
 	}
 	public void setContactWidth(int contactWidth) {
 		this.contactWidth = contactWidth;
 	}
 	public String getEngine() {
 		return engine;
 	}
 	public void setEngine(String engine) {
 		this.engine = engine;
 	}
 	public LinkedList<SetSize> getSetSizes() { 
 		return setSizes;
 	}
 
 	public	void	addSetSize(SetSize ss) {
 		setSizes.add(ss);
 	}
 	public	void	setSetSizes(LinkedList<SetSize> setSizes) {
 		this.setSizes = setSizes;
 	}
 	
 	/** Get a list of the Set names used in this chain
 	 * @return a list of Strings
 	 */
 	public	List<String>	getSetNames() {
 		LinkedList<String> theList = new LinkedList<String>();
 		Iterator<SetSize> iter = this.setSizes.iterator();
 		while (iter.hasNext()) {
 			SetSize ss = (SetSize)iter.next();
 			boolean match = false;
 			Iterator<String> iterThe = theList.iterator();
 			while (iterThe.hasNext()) {
 				String s = (String)iterThe.next();
 				if (s.equals(ss.getSetName())) {
 					match = true;
 					break;
 				}
 			}
 			if (match == false) {
 				theList.add(ss.getSetName());
 			}
 		}
 		return(theList);
 	}
 	
 	/** Determine whether this set/size is in this chain
 	 * @return true if this set/size is in the chain
 	 */
 	public	boolean	hasSetSize(String setName, int size) {
 		Iterator<SetSize> iter = this.setSizes.iterator();
 		while (iter.hasNext()) {
 			SetSize ss = (SetSize)iter.next();
 			if (ss.getSetName().equals(setName) && ss.getSize() == size)
 				return(true);
 		}
 		return(false);
 	}
 
 	/**
 	 * @return Returns the picSelector.
 	 */
 	public int getPicSelector() {
 		return picSelector;
 	}
 
 	/**
 	 * @param picSelector The picSelector to set.
 	 */
 	public void setPicSelector(int picSelector) {
 		this.picSelector = picSelector;
 	}
 
 	/** Get the maximum rating of a pic that can be used in this chain.
 	 * @return Returns the ratingMax.
 	 */
 	public int getRatingMax() {
 		return ratingMax;
 	}
 
 	/** Set the maximum rating of a pic that can be used in this chain.
 	 * @param ratingMax The ratingMax to set.
 	 */
 	public void setRatingMax(int ratingMax) {
 		this.ratingMax = ratingMax;
 	}
 
 	/** Get the minimum rating of a pic that can be used in this chain.
 	 * @return Returns the ratingsMin.
 	 */
 	public int getRatingMin() {
 		return ratingMin;
 	}
 
 	/** Set the minimum rating of a pic that can be used in this chain.
 	 * @param ratingMin The ratingsMin to set.
 	 */
 	public void setRatingMin(int ratingMin) {
 		this.ratingMin = ratingMin;
 	}
 
 	/** Do we show or hide the unused sets during Chain editing?
 	 * @return the showUnusedSets
 	 */
 	public boolean isShowUnusedSets() {
 		return showUnusedSets;
 	}
 	/** Set do we show or hide the unused sets during Chain editing?
 	 * @param showUnusedSets the showUnusedSets to set
 	 */
 	public void setShowUnusedSets(boolean showUnusedSets) {
 		this.showUnusedSets = showUnusedSets;
 	}
 	
 
 }