model.show
Class Show

java.lang.Object
  model.show.Show

public class Show
extends Object

This class contains a cueSet and other information about the current show. This class also contains the methods to save a show to a file.

TODO: Modify this class so that it can hold a variable number of cuesets at one time.

Constructor Summary

Show(ArrayList<CueSet> _cueSets, int _maxChannels)
This constructor will create a Show with the given cueset and maximum number of channels.

Show(int _maxChannels)
This constructor will create a Show with the given number of maxChannels.

Show(String _name, int _maxChannels, ArrayList<CueSet> _cueSets)
This constructor will create a Show with the given name, maximum number of channels, and cueset.

Method Summary

void	addCue(ACue cue) This method will add a cue to the current cueset.
ACue	getCue(float cueNumber) This method returns the cue with the given number.
String[]	getCueNames() This method will return the summary of all the cues in the cueset.
String	getFileName() This method returns the file name and path of the show.
float	getHighestCueNumber() This method returns the highest cue number that currently exists.
int	getMaxChannels() This method returns the maximum number of channels for this show.
String	getShowDesc() This method returns the show's description.
String	getShowName() This method returns the show's name.
void	saveShow(String _fileName) This method will save the show to the location stored in filename.
void	setFileName(String _fileName) This method sets the file name and path for the show.
void	setMaxChannels(int _maxChannels) This method sets the maximum number of channels for this show.
void	setShowDesc(String _showDesc) This method sets the shows description.
void	setShowName(String _showName) This method sets the show's name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Show

public Show(int _maxChannels)

This constructor will create a Show with the given number of maxChannels.

Parameters:

_maxChannels - The maximum number of channels for this Show.

Show

public Show(ArrayList<CueSet> _cueSets,
            int _maxChannels)

This constructor will create a Show with the given cueset and maximum number of channels.

Parameters:

_cueSets - The ArrayList of cuesets to use for this show. There must be at least 1 cueset in the arraylist.

_maxChannels - The maximum number of channels for this show.

Show

public Show(String _name,
            int _maxChannels,
            ArrayList<CueSet> _cueSets)

This constructor will create a Show with the given name, maximum number of channels, and cueset.

Parameters:

_name - The show's name.

_maxChannels - The maximum number of channels for this show.

_cueSets - The ArrayList of cuesets to use for this show. There must be at least 1 cueset in the arraylist.

Method Detail

getShowName

public String getShowName()

This method returns the show's name.

Returns:

The show's name.

setShowName

public void setShowName(String _showName)

This method sets the show's name.

Parameters:

_showName - The show's name.

getShowDesc

public String getShowDesc()

This method returns the show's description.

Returns:

The show's description.

setShowDesc

public void setShowDesc(String _showDesc)

This method sets the shows description.

Parameters:

_showDesc - The show's new description.

getFileName

public String getFileName()

This method returns the file name and path of the show.

Returns:

The file name and path of the show.

setFileName

public void setFileName(String _fileName)

This method sets the file name and path for the show.

Parameters:

_fileName - The new file name and path for the show.

getMaxChannels

public int getMaxChannels()

This method returns the maximum number of channels for this show.

Returns:

The maximum number of channels for this show.

setMaxChannels

public void setMaxChannels(int _maxChannels)

This method sets the maximum number of channels for this show.

Parameters:

_maxChannels - The maximum number of channels for this show.

saveShow

public void saveShow(String _fileName)

This method will save the show to the location stored in filename.

Parameters:

_fileName - The file name and path to save the file to.

addCue

public void addCue(ACue cue)

This method will add a cue to the current cueset.

Parameters:

cue - The cue to add.

getCueNames

public String[] getCueNames()

This method will return the summary of all the cues in the cueset.

TODO: This method should be renamed to getCueSummaries().

Returns:

The array containing the summaries of all the cues in the cueset.

getHighestCueNumber

public float getHighestCueNumber()

This method returns the highest cue number that currently exists.

Returns:

The highest cue number that exists in the cueset.

getCue

public ACue getCue(float cueNumber)

This method returns the cue with the given number.

Parameters:

cueNumber - The number of the cue to return.

Returns:

The cue with the given number.