package org.musicontroller.importer;
   
   import java.io.Serializable;
   import java.util.ArrayList;
   import java.util.Collection;
   import java.util.Date;
   import java.util.HashMap;
   import java.util.HashSet;
   import java.util.List;
  import java.util.Map;
  import java.util.Set;
  import java.util.TreeSet;
  
  import org.apache.log4j.Logger;
  import org.varienaja.util.DateTools;
  
  /**
   * This class contains information about an uploaded music archive file.
   * <p>The inner class PlaylistImportProperties is used for setting instruction for the importer
   * per playlist name.
   *  
   * @author Hans Drexler
   * @version $Id: MusicArchiveBean.java,v 1.1 2010/03/16 18:55:43 varienaja Exp $
   */
  public class MusicArchiveBean implements Serializable {
  
  	private static final long serialVersionUID = 20071205181533L;
  
  	private static Logger _log = Logger.getLogger(MusicArchiveBean.class);
  	
  	/**
  	 * Stores the release date of the playlist contained in the music archive.
  	 */
  	private Date _releaseDate = null;
  	
  	/**
  	 * Stores aditional information about playlists in the archive, like release date and
  	 * cover art.
  	 */
  	private Map<String,PlaylistImportProperties> _playlistPropertiesMap;
  	
  	/**
  	 * The (file)name of this archive.
  	 */
  	private String _archiveName;
  	
  	/**
  	 * The list of songs contained in this archive.
  	 */
  	private List<MusicArchiveEntryBean> _entries;
  	
  	/**
  	 * The default constructor initializes the entries and the playlist properties to an empty set
  	 * and all other properties to <tt>null</tt>.
  	 */
  	public MusicArchiveBean() {
  		_playlistPropertiesMap = new HashMap<String,PlaylistImportProperties>();
  		_releaseDate = null;
  		_archiveName = null;
  		setEntries(new ArrayList<MusicArchiveEntryBean>());
  	}
  	
  	/**
  	 * Get the per playlist properties of the specified playlist.
  	 * @return The per playlist import properties of the specified playlist or null.
  	 */
  	public PlaylistImportProperties getPlaylistProperties(String playlistName) {
  		if(playlistName==null) {
  			return null;
  		} 
  		return _playlistPropertiesMap.get(playlistName);
  	}
  
  	public Set<PlaylistImportProperties> getPlaylistPropertySet() {
  		Collection<PlaylistImportProperties> allProperties = _playlistPropertiesMap.values();
  		Set<PlaylistImportProperties> result = new HashSet<PlaylistImportProperties>(allProperties);
  		_log.debug("Returned a set of "+result.size()+" playlist import properties.");
  		return result;
  	}
  	
  	/**
  	 * Returns a set of all distinct playlist names in the archive.
  	 * @return A set of all distinct playlist names in the archive.
  	 */
  	public Set<String> getPlaylistNames() {
  		return _playlistPropertiesMap.keySet();
  	}
  	
  	/**
  	 * Setter for the per playlist import properties of the specified playlist.
  	 * @param properties The per playlist import properties.
  	 */
  	public void setPlaylistProperties(String playlistName, PlaylistImportProperties properties) {
  		if(playlistName==null) {
  			return;
  		}		
  		_playlistPropertiesMap.put(playlistName, properties);
  	}
  
 	/**
 	 * Getter for the music archive name.
 	 * @return The music archive name.
 	 */
 	public String getArchiveName() {
 		return _archiveName;
 	}
 
 	/**
 	 * Setter for the music archive name.
 	 * @param name The music archive name.
 	 */
 	public void setArchiveName(String name) {
 		_archiveName = name;
 	}
 
 	/**
 	 * Getter for the list of music entries in this archive.
 	 * @return The list of music entries.
 	 */
 	private List<MusicArchiveEntryBean> getEntries() {
 		return _entries;
 	}
 
 	/**
 	 * Setter for the list of entries in the archive.
 	 * @param entries The list of entries.
 	 */
 	private void setEntries(List<MusicArchiveEntryBean> entries) {
 		this._entries = entries;
 	}
 	
 	
 	public Set<MusicArchiveEntryBean> getEntrySet() {
 		Set<MusicArchiveEntryBean> result = new TreeSet<MusicArchiveEntryBean>();
 		result.addAll(_entries);
 		return result;
 	}
 	
 	/**
 	 * Returns the minimum value of releaseDate of all entries, or the value
 	 * of release date that has been set.
 	 * @return
 	 */
 	public Date getReleaseDate() {
 		Date result = _releaseDate;
 		if (result==null) { //Not initialized, get minimum releasedate from entries.
 			for (MusicArchiveEntryBean entry : _entries) {
 				Date test = entry.getReleaseDate();
 				if (test!=null) {
 					if (result==null || test.before(result)) {
 						result = test;
 					}
 				}
 			}
 		}
 		return result;
 	}
 	
 	/**
 	 * Sets the release date value of this bean.
 	 * @param releaseDate The release date.
 	 */
 	public void setReleaseDate(Date releaseDate) {
 		_releaseDate = releaseDate;
 	}
 	
 	/**
 	 * Adds an entry to the music archive.
 	 * @param entry The entry to add. Null values are ignored. If the playlist name
 	 * 				is null, "" is used as the playlist name.
 	 */
 	public void addEntry(MusicArchiveEntryBean entry) {
 		if(entry==null) {
 			return;
 		}
 		if(entry.getPlaylistName()==null) {
 			entry.setPlaylistName("");
 		}
 		getEntries().add(entry);
 		analyseMusicArchive();
 	}
 	
 	/**
 	 * Analyses the entries in the music archive to create a list of different playlists. If the archive
 	 * already contains an entry for a playlist in the music archive, that entry is not changed.
 	 * Maintain information on every playlist found:
 	 * <ul>
 	 * <li> Release date
 	 * <li> Cover art 
 	 * </ul> 
 	 * @param archive The music archive to analyse.
 	 */
 	public void analyseMusicArchive() {
 		// Build a Map of different Playlist names in the archive, and set up their properties.
 		Set<String> playlistNames = new HashSet<String>();
 		for (MusicArchiveEntryBean entry : getEntries()) {
 			String key = entry.getPlaylistName();
 			playlistNames.add(key);
 			if(getPlaylistProperties(key)==null) {
 				// No entry yet, construct one. We can't set a cover art here, since that would require
 				// Tapestry functionality.
 				PlaylistImportProperties pip = new PlaylistImportProperties();
 				pip.setPlaylistName(key);
 				pip.setReleaseDate(DateTools.currentDate());
 				pip.setAddToExistingPlaylist(false);
 				setPlaylistProperties(key, pip);
 			}
 		}
 		// Remove playlist properties of playlist names that are no longer in the list.
 		for(PlaylistImportProperties pp: getPlaylistPropertySet()) {
 			if (!playlistNames.contains(pp.getPlaylistName())) {
 				_playlistPropertiesMap.remove(pp.getPlaylistName());
 			}
 		}
 	}
 
 	
 }