Class MixTapeModel

java.lang.Object

MixTapeModel

public class MixTapeModel
extends java.lang.Object

MixTapeModel is the underlying data model for the MixTapeCalculator. The model consists of a song "pool" of candidate songs and a playlist of selected songs. The model also knows the "capacity" available on the recording media, the current total time on the playlist, and the remaining time on the playlist. No user interaction happens here.
Implementation Requirement: All the methods contain only a single statement except:
the constructor - 2 statements.
addToMix() - 4 statements.

Version:

9/2009

Author:

J. Dalbey

Constructor Summary

Constructors

Constructor and Description
MixTapeModel() Constructor for objects of type MixTapeModel

Method Summary

Methods

Modifier and Type	Method and Description
void	addSong(Song newSong) Add a new song to the song pool.
boolean	addToMix(int position) Move a song from the pool to the playlist.
void	clearPool() Clear the songs in the song pool.
java.util.Vector<Song>	getPlayList() Return the list of songs in the playlist.
TimeDuration	getRemainingTime() Determine the time available, i.e., total playlist time subtracted from current tape length.
java.util.Vector<Song>	getSongPool() Return the list of songs in the pool.
TimeDuration	getTapeLength() Accessor to current tape length.
TimeDuration	getTotalTime() Determine the total time of the songs in the playlist.
void	importFile(java.io.File songFile) Load the song pool from a plain text file.
void	loadM3U(java.io.File m3uFile) Load the song pool from an M3U file.
void	removeFromMix(int position) Move a song from the playlist to the pool
void	save(java.io.File saveFile) Write the playlist to a text file.
boolean	setTapeLength(int desiredMinutes) Set the maximum length of time for the playlist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MixTapeModel

public MixTapeModel()

Constructor for objects of type MixTapeModel

Method Detail

getSongPool

public java.util.Vector<Song> getSongPool()

Return the list of songs in the pool.

Returns:

List list of songs

getPlayList

public java.util.Vector<Song> getPlayList()

Return the list of songs in the playlist.

Returns:

List list of songs

loadM3U

public void loadM3U(java.io.File m3uFile)

Load the song pool from an M3U file.

Parameters:

m3uFile - a file containing an m3u format playlist.

importFile

public void importFile(java.io.File songFile)

Load the song pool from a plain text file.

Parameters:

songFile - a file containing a playlist in a simple text format.

save

public void save(java.io.File saveFile)

Write the playlist to a text file.

Parameters:

saveFile - the name of the file to contain the output playlist

addSong

public void addSong(Song newSong)

Add a new song to the song pool.

Parameters:

newSong - Song to be added to the list of songs in the pool

setTapeLength

public boolean setTapeLength(int desiredMinutes)

Set the maximum length of time for the playlist. if desiredMinutes >= getTotalTime() sets tapelength to desiredMinutes else no effect

Parameters:

desiredMinutes - how many minutes are available on the recording media

Returns:

true if desiredMinutes >= getTotalTime(), false otherwise

getTapeLength

public TimeDuration getTapeLength()

Accessor to current tape length.

Returns:

current tape length

clearPool

public void clearPool()

Clear the songs in the song pool.

addToMix

public boolean addToMix(int position)

Move a song from the pool to the playlist.

Parameters:

position - the zero-based index of the song to be moved.

Returns:

true if the song was added to the playlist, false if adding the song would have exceeded the current tapelength time.

Precondition:

A song exists in the songpool at the specified position.

removeFromMix

public void removeFromMix(int position)

Move a song from the playlist to the pool

Parameters:

position - the zero-based index of the song to be moved.

Precondition:

A song exists in the playlist at the specified position.

getTotalTime

public TimeDuration getTotalTime()

Determine the total time of the songs in the playlist.

Returns:

TimeDuration total of songs currently in the playlist.

getRemainingTime

public TimeDuration getRemainingTime()

Determine the time available, i.e., total playlist time subtracted from current tape length.

Returns:

TimeDuration remaining time