/******************************************************************************
    * Set.java - a set bean, define a group of pictures
    * 
    * PicMan - The BuckoSoft Picture Manager in Java
    * Copyright(c) 2005 - Dick Balaska
    * 
    */
   package com.buckosoft.PicMan.domain;
   
  import java.io.Serializable;
  import java.util.Comparator;
  import java.util.Date;
  
  public class Set implements Serializable, Comparator<Set> {
  	private static final long serialVersionUID = 1L;
  	
  	public final static String	FUNC_NAME_DATE	= "[date]";
  	public final static int		FUNC_SID_DATE	= -2;
  	public final static String	FUNC_NAME_ROOT	= "[root]";
  	public final static int		FUNC_SID_ROOT	= -3;
  
  	
  	private	int		sid;
  	private	String	name;
  	private	String	description;
  	private	boolean	active = true;
  	private	boolean	metaSet = false;
  	private	boolean	microSet = false;
  	private boolean nanoSet = false;
  	private	Date	editDate = new Date();
  
  	/** Default constructor, create an empty set.
  	 */
  	public Set() {
  	}
  	
  	/** Convienence constructor to preset some values.
  	 * @param sid The set id to set
  	 * @param name The name of this set
  	 */
  	public Set(int sid, String name) {
  		this.sid = sid;
  		this.name = name;
  	}
  
  	/** Clone this set.
  	 * @return A copy of this Set.
  	 */
  	public Set clone() {
  		Set set = new Set();
  		set.setSid(this.getSid());
  		set.setName(this.getName());
  		set.setDescription(this.getDescription());
  		set.setActive(this.isActive());
  		set.setMetaSet(this.isMetaSet());
  		set.setMicroSet(this.isMicroSet());
  		set.setNanoSet(this.isNanoSet());
  		set.editDate.setTime(this.editDate.getTime());
  		return(set);
  	}
  
  	
  	/* (non-Javadoc)
  	 * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
  	 */
  	public int compare(Set set0, Set set1) {
  		if (!set1.name.equals(set0.name))
  			return(set1.name.compareTo(set0.name));
  		if (!set1.description.equals(set0.description))
  			return(set1.description.compareTo(set0.description));
  		if (set0.sid != set1.sid)
  			return(set1.sid - set0.sid);
  		if (set0.active != set1.active)
  			return(set1.active ? 1 : -1);
  		if (set0.metaSet != set1.metaSet)
  			return(set1.metaSet ? 1 : -1);
  		if (set0.microSet != set1.microSet)
  			return(set1.microSet ? 1 : -1);
  		if (set0.nanoSet != set1.nanoSet)
  			return(set1.nanoSet ? 1 : -1);
  		if (set0.editDate.getTime() != set1.editDate.getTime())
  			return((int)(set1.editDate.getTime() - set0.editDate.getTime()));
  		return 0;
  	}
  
  
  	/** Fetch the PicMan unique Set id.
  	 * @return Returns the set id.
  	 */
  	public int getSid() {
  		return sid;
  	}
  	/**
  	 * @param sid The set id to set.
  	 */
  	public void setSid(int sid) {
  		this.sid = sid;
  	}
  	public	void	setName(String name) { this.name = name; }
 	public	String	getName() { return(name); }
 	
 	/** Set the user's desciption of this set.
 	 * @param description
 	 */
 	public void setDescription(String description) {
 		this.description = description; 
 	}
 
 	public	String	getDescription() { return(description); }
 	/**
 	 * @return Returns whether this Set is active.
 	 */
 	public boolean isActive() {
 		return active;
 	}
 	/**
 	 * @param active Set whether this Set is active.
 	 */
 	public void setActive(boolean active) {
 		this.active = active;
 	}
 	/** Is this a metaSet?
 	 * @return Returns the metaSet flag.
 	 */
 	public boolean isMetaSet() {
 		return metaSet;
 	}
 	/**
 	 * @param metaSet The metaSet to set.
 	 */
 	public void setMetaSet(boolean metaSet) {
 		this.metaSet = metaSet;
 	}
 	/** Is this a microSet?
 	 * @return the microSet
 	 */
 	public boolean isMicroSet() {
 		return microSet;
 	}
 	/**
 	 * @param microSet the microSet to set
 	 */
 	public void setMicroSet(boolean microSet) {
 		this.microSet = microSet;
 	}
 	/** Is this a nanoSet?
 	 * A pic in a nanoSet contains a boolean yes/no value.
 	 * @return the nanoSet
 	 */
 	public boolean isNanoSet() {
 		return nanoSet;
 	}
 	/**
 	 * @param nanoSet the nanoSet to set
 	 */
 	public void setNanoSet(boolean nanoSet) {
 		this.nanoSet = nanoSet;
 	}
 
 	public boolean	isFuncSet() {
 		return(this.sid < -1);
 	}
 
 	/**
 	 * @return the editDate
 	 */
 	public Date getEditDate() {
 		return editDate;
 	}
 
 	/**
 	 * @param editDate the editDate to set
 	 */
 	public void setEditDate(Date editDate) {
 		this.editDate = editDate;
 	}
 
 	/** Set the time of this set's edit to be now.
 	 */
 	public void setEditDateNow() {
 		this.editDate = new Date();
 	}
 }