package org.musicontroller.importer;
   
   import java.io.Serializable;
   import java.util.Date;
   import java.util.HashSet;
   import java.util.Set;
   
   import org.varienaja.util.StringUtil;
   
  /**
   * This class holds information about a music archive entry (usually a song), 
   * including song title, band name, playlist name, length and tags. 
   * <p>During the import process this bean also contains the location of the extracted
   * MP3 file.
   * 
   * @author Hans Drexler
   * @version $Id: MusicArchiveEntryBean.java,v 1.1 2010/03/16 18:55:43 varienaja Exp $
   */
  public class MusicArchiveEntryBean implements Serializable, Comparable<MusicArchiveEntryBean> {
  
  	private static final long serialVersionUID = 20071205181556L;;
  
  	/**
  	 * Default constructor. Initializes the keyword set (empty).
  	 * Sets the included indicator to true.
  	 */
  	public MusicArchiveEntryBean() {
  		setKeywords(new HashSet<String>());
  		setInclude(true);
  	}
  	
  	/**
  	 * The name of the plasylist (album) contained
  	 * in this music archive.
  	 */
  	private String _playlistName;
  	
  	/**
  	 * The band name of the band performing in
  	 * this music archive.
  	 */
  	private String _bandName;
  
  	/**
  	 * The name of the song.
  	 */
  	private String _songName;
  	
  	/**
  	 * The length of the song in milliseconds.
  	 */
  	private int _songLength;
  	
  	/**
  	 * The set of keywords associated with this song.
  	 */
  	private Set<String> _keywords;
  
  	/**
  	 * The song index of this song in its playlist.
  	 */
  	private int _songIndex;
  
  	/**
  	 * Indicates if this entry should be imported or not.
  	 */
  	private boolean _include;
  
  	/**
  	 * This string is the location of the MP3 file in the <tt>inspected</tt> directory.
  	 */
  	private String _entryName;
  	
  	/**
  	 * The releasedate of the playlist where this song is part of.
  	 */
  	private Date _releaseDate;
  	
  	/**
  	 * Getter for the bandname.
  	 * @return The bandname.
  	 */
  	public String getBandName() {
  		return _bandName;
  	}
  
  	/**
  	 * Setter for the bandname.
  	 * @param name The bandname.
  	 */
  	public void setBandName(String name) {
  		_bandName = name;
  	}
  
  	/**
  	 * Getter for the playlist name.
  	 * @return The playlist name.
  	 */
  	public String getPlaylistName() {
 		return _playlistName;
 	}
 
 	/**
 	 * Setter for the playlist-name.
 	 * @param name The new playlist name.
 	 */
 	public void setPlaylistName(String name) {
 		_playlistName = name;
 	}
 
 	/**
 	 * Getter for the set of keywords.
 	 * @return The keyword set. 
 	 */
 	public Set<String> getKeywords() {
 		return _keywords;
 	}
 
 	/**
 	 * Setter for the keyword set.
 	 * @param keywords The keyword set.
 	 */
 	public void setKeywords(Set<String> keywords) {
 		this._keywords = keywords;
 	}
 
 	/**
 	 * Getter for the song length.
 	 * @return The length of the song in milliseconds.
 	 */
 	public int getSongLength() {
 		return _songLength;
 	}
 
 	/**
 	 * Setter for the song length.
 	 * @param seconds The song length in milliseconds.
 	 */
 	public void setSongLength(int seconds) {
 		_songLength = seconds;
 	}
 
 	/**
 	 * Getter for the name of the song.
 	 * @return The song name.
 	 */
 	public String getSongName() {
 		return _songName;
 	}
 
 	/**
 	 * Setter for the name of the song.
 	 * @param name The song name.
 	 */
 	public void setSongName(String name) {
 		_songName = name;
 	}
 
 	/**
 	 * Getter for the song index.
 	 * @return The song index.
 	 */
 	public int getSongIndex() {
 		return _songIndex;
 	}
 	
 	/**
 	 * Setter for the song index.
 	 * @param index The index 
 	 */
 	public void setSongIndex(int index) {
 		_songIndex = index;
 	}
 
 	/**
 	 * Setter for the included indicator.
 	 * @param include The included indicator.
 	 */
 	public void setInclude(boolean include) {
 		this._include = include;
 	}
 	
 	/**
 	 * Getter for the included indicator.
 	 * @return The included indicator
 	 */
 	public boolean getInclude() {
 		return this._include;
 	}
 
 	/**
 	 * Getter for the file name of the MP3 file in the <tt>inspected</tt> directrory. 
 	 * @return The music entry file name.
 	 */
 	public String getEntryName() {
 		return this._entryName;
 	}
 	
 	/**
 	 * Setter for the file name of the MP3 file in the <tt>inspected</tt> directrory.
 	 * @param entryName The music entry file name.
 	 */
 	public void setEntryName(String entryName) {
 		this._entryName = entryName;
 	}
 	
 	/**
 	 * Getter for the release date of the playlist.
 	 * @return The release date.
 	 */
 	public Date getReleaseDate() {
 		return _releaseDate;
 	}
 	
 	public void setReleaseDate(Date releaseDate) {
 		this._releaseDate = releaseDate;
 	}
 	
 	/**
 	 * Returns a String repesentation of the keywords in the
 	 * bean as a comma-separated String of keywords.
 	 * @return String representation of the Keywords
 	 */
 	public String getKeywordString() {
 		StringBuilder result = new StringBuilder();
 		boolean putComma = false;
 		for(String kw: getKeywords()) {
 			if(putComma) {
 				result.append(",");
 			} else {
 				putComma = true;
 			}
 			result.append(kw);
 		}
 		return result.toString();
 	}
 	
 	/**
 	 * Splits the argument into comma-separated keywords and stores
 	 * them in the keywords property of the bean. The first letter
 	 * of each keyword will be capitalized. Empty keywords are
 	 * ignored.
 	 * @param keywords The comma-separated list of keywords.
 	 */
 	public void setKeywordString(String keywords) {
 		getKeywords().clear();
 		getKeywords().addAll(StringUtil.getIndividualWords(keywords));
 	}
 
 	/**
 	 * Two MusicArchiveEntryBean objects are the same if they have the same song index greater than 0.
 	 * If the song index on both objects is zero, then they are equal if they have the same band name
 	 * and song name.
 	 */
 	public boolean equals(Object o) {
 		if (o==null) return false;
 		
 		if (o instanceof MusicArchiveEntryBean) {
 			MusicArchiveEntryBean b= (MusicArchiveEntryBean) o;
 			if(getSongIndex()==0) {
 				StringBuilder sb1 = new StringBuilder();
 				StringBuilder sb2 = new StringBuilder();
 				sb1.append(getBandName());
 				sb1.append(getSongName());
 				sb2.append(b.getBandName());
 				sb2.append(b.getSongName());
 				return b.getSongIndex()==0 && sb1.toString().equals(sb2.toString());
 			} else {
 				return getSongIndex() == b.getSongIndex();
 			}
 		} else {
 			return false;
 		}
 
 	}
 	
 	/**
 	 * Returns a hash code based on the song index. If the song index is zero,
 	 * the hash code is computed from the band name and song name.
 	 */
 	public int hashCode() {
 		if (getSongIndex()==0) {
 			StringBuilder sb = new StringBuilder();
 			sb.append(getBandName());
 			sb.append(getSongName());
 			return sb.toString().hashCode();
 		} else {
 			return getSongIndex();
 		}
 	}
 	
 	/**
 	 * Define a natural ordening on MusicArchiveEntryBeans based on track number.
 	 * If both track numbers are 0 then the Band name decides. If Band names are
 	 * equal then song name decides.
 	 */
 	public int compareTo(MusicArchiveEntryBean o) {
 		if(getSongIndex()==0) {
 			int bandCompare = 0;
 			if(getBandName()==null) {
 				if(o.getBandName()==null) {
 					// Go on to compare song names.
 				} else {
 					bandCompare = -1;
 				}
 			} else {
 				if(o.getBandName()==null) {
 					bandCompare = 1;
 				} else {
 					bandCompare = getBandName().compareTo(o.getBandName());
 				}
 			}
 			if(bandCompare!=0) {
 				return bandCompare;
 			}
 			// Band names are equal. Compare song names.
 			int songCompare = 0;
 			if(getSongName()==null) {
 				if(o.getSongName()==null) {
 					// Treat both song names null as being equal.
 				} else {
 					songCompare = -1;
 				}
 			} else {
 				if(o.getSongName()==null) {
 					songCompare = 1;
 				} else {
 					songCompare = getSongName().compareTo(o.getSongName());
 				}
 			}
 			return songCompare;
 		} else {
 			return Integer.valueOf(getSongIndex()).compareTo(Integer.valueOf(o.getSongIndex()));
 		}
 	}
 }