christophedelory.playlist.rmp
Class Track

java.lang.Object
  christophedelory.playlist.rmp.Track

public class Track
extends Object

A track in a Real Metadata Package.

Since:

0.3.0

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Track()

Method Summary

String	getAlbum() Returns the track album.
String	getArtist() Returns the track artist.
Integer	getChannels() Returns the number of channels in this track.
Integer	getContextInfoHeight() Returns the context info height, in pixels.
String	getContextInfoUrlString() Returns the context info URL.
Integer	getContextInfoWidth() Returns the context info width, in pixels.
Integer	getDuration() Returns the duration of this track, in seconds.
String	getFileName() Returns the track file name.
String	getFormat() Returns the track format.
String	getGenre() Returns the track genre.
String	getId() Returns the track identifier.
String	getIsStreamingString() Specifies that this is a streaming URL that should simply be imported and not downloaded.
Tracklist	getParent() Returns the parent track list, if any.
Integer	getQuality() Returns the quality of this track, in bps.
Long	getSize() Returns the size of this track, in bytes.
String	getTitle() Returns the track title.
String	getUrlString() Returns the MIP URL.
boolean	isStreaming() Specifies that this is a streaming URL that should simply be imported and not downloaded.
void	setAlbum(String album) Initializes the track album.
void	setArtist(String artist) Initializes the track artist.
void	setChannels(int channels) Initializes the number of channels in this track.
void	setChannels(Integer channels) Initializes the number of channels in this track.
void	setContextInfoHeight(int height) Initializes the context info height, in pixels.
void	setContextInfoHeight(Integer height) Initializes the context info height, in pixels.
void	setContextInfoUrlString(String url) Initializes the context info URL.
void	setContextInfoWidth(int width) Initializes the context info width, in pixels.
void	setContextInfoWidth(Integer width) Initializes the context info width, in pixels.
void	setDuration(int duration) Initializes the duration of this track, in seconds.
void	setDuration(Integer duration) Initializes the duration of this track, in seconds.
void	setFileName(String fileName) Initializes the track file name.
void	setFormat(String format) Initializes the track format.
void	setGenre(String genre) Initializes the track genre.
void	setId(String id) Initializes the identifier of this track.
void	setIsStreaming(boolean isStreaming) Specifies that this is a streaming URL that should simply be imported and not downloaded.
void	setIsStreamingString(String isStreaming) Specifies that this is a streaming URL that should simply be imported and not downloaded.
(package private) void	setParent(Tracklist parent) Initializes the parent track list.
void	setQuality(int quality) Initializes the quality of this track, in bps.
void	setQuality(Integer quality) Initializes the quality of this track, in bps.
void	setSize(int size) Initializes the size of this track, in bytes.
void	setSize(Long size) Initializes the size of this track, in bytes.
void	setTitle(String title) Initializes the track title.
void	setUrlString(String url) Initializes the MIP URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

Track

public Track()

Method Detail

setParent

void setParent(Tracklist parent)

Initializes the parent track list.

Parameters:

parent - the parent track list. May be null.

See Also:

getParent()

getParent

public Tracklist getParent()

Returns the parent track list, if any.

Returns:

the parent track list. May be null.

getId

public String getId()

Returns the track identifier.

Returns:

an identifier. May be null.

See Also:

setId(java.lang.String)

setId

public void setId(String id)

Initializes the identifier of this track.

Parameters:

id - an identifier. May be null.

See Also:

getId()

getUrlString

public String getUrlString()

Returns the MIP URL.

Returns:

an URL. May be null.

See Also:

setUrlString(java.lang.String)

setUrlString

public void setUrlString(String url)

Initializes the MIP URL.

Parameters:

url - an URL. May be null.

See Also:

getUrlString()

getTitle

public String getTitle()

Returns the track title.

Returns:

a title. May be null.

See Also:

setTitle(java.lang.String)

setTitle

public void setTitle(String title)

Initializes the track title.

Parameters:

title - a title. May be null.

See Also:

getTitle()

getAlbum

public String getAlbum()

Returns the track album.

Returns:

an album. May be null.

See Also:

setAlbum(java.lang.String)

setAlbum

public void setAlbum(String album)

Initializes the track album.

Parameters:

album - an album. May be null.

See Also:

getAlbum()

getArtist

public String getArtist()

Returns the track artist.

Returns:

an artist. May be null.

See Also:

setArtist(java.lang.String)

setArtist

public void setArtist(String artist)

Initializes the track artist.

Parameters:

artist - an artist. May be null.

See Also:

getArtist()

getGenre

public String getGenre()

Returns the track genre.

Returns:

a genre. May be null.

See Also:

setGenre(java.lang.String)

setGenre

public void setGenre(String genre)

Initializes the track genre.

Parameters:

genre - a genre. May be null.

See Also:

getGenre()

getFileName

public String getFileName()

Returns the track file name. This is the place that the "%f" refers to from the PACKAGE/SERVER/LOCATION tag. This filename is both the filename on the server, as well as the destination filename for the user’s hard drive.

Returns:

a file name. May be null.

See Also:

setFileName(java.lang.String)

setFileName

public void setFileName(String fileName)

Initializes the track file name.

Parameters:

fileName - a file name. May be null.

See Also:

getFileName()

getSize

public Long getSize()

Returns the size of this track, in bytes.

Returns:

a size. May be null.

See Also:

setSize(java.lang.Long)

setSize

public void setSize(Long size)

Initializes the size of this track, in bytes.

Parameters:

size - a size. May be null.

Throws:

IllegalArgumentException - if the specified value is not positive.

See Also:

getSize(), setSize(int)

setSize

public void setSize(int size)

Initializes the size of this track, in bytes.

Parameters:

size - a size. Shall not be strictly negative.

Throws:

IllegalArgumentException - if the specified size is not positive.

See Also:

getSize(), setSize(Long)

getFormat

public String getFormat()

Returns the track format.

Returns:

a format. May be null.

See Also:

setFormat(java.lang.String)

setFormat

public void setFormat(String format)

Initializes the track format.

Parameters:

format - a format. May be null.

See Also:

getFormat()

getQuality

public Integer getQuality()

Returns the quality of this track, in bps.

Returns:

a quality. May be null.

See Also:

setQuality(java.lang.Integer)

setQuality

public void setQuality(Integer quality)

Initializes the quality of this track, in bps.

Parameters:

quality - a quality. May be null.

Throws:

IllegalArgumentException - if the specified value is not positive.

See Also:

getQuality(), setQuality(int)

setQuality

public void setQuality(int quality)

Initializes the quality of this track, in bps.

Parameters:

quality - a quality. Shall not be strictly negative.

Throws:

IllegalArgumentException - if the specified quality is not positive.

See Also:

getQuality(), setQuality(Integer)

getChannels

public Integer getChannels()

Returns the number of channels in this track.

Returns:

a number of channels. May be null.

See Also:

setChannels(java.lang.Integer)

setChannels

public void setChannels(Integer channels)

Initializes the number of channels in this track.

Parameters:

channels - a number of channels. May be null.

Throws:

IllegalArgumentException - if the specified value is not positive.

See Also:

getChannels(), setChannels(int)

setChannels

public void setChannels(int channels)

Initializes the number of channels in this track.

Parameters:

channels - a number of channels. Shall not be strictly negative.

Throws:

IllegalArgumentException - if the specified number of channels is not positive.

See Also:

getChannels(), setChannels(Integer)

getDuration

public Integer getDuration()

Returns the duration of this track, in seconds.

Returns:

a duration. May be null.

See Also:

setDuration(java.lang.Integer)

setDuration

public void setDuration(Integer duration)

Initializes the duration of this track, in seconds.

Parameters:

duration - a duration. May be null.

Throws:

IllegalArgumentException - if the specified value is not positive.

See Also:

getDuration(), setDuration(int)

setDuration

public void setDuration(int duration)

Initializes the duration of this track, in seconds.

Parameters:

duration - a duration. Shall not be strictly negative.

Throws:

IllegalArgumentException - if the specified duration is not positive.

See Also:

getDuration(), setDuration(Integer)

getContextInfoUrlString

public String getContextInfoUrlString()

Returns the context info URL. A URL to be stored in the track’s metadata as "Playback Specifications:Context Info URL".

Returns:

an URL. May be null.

See Also:

setContextInfoUrlString(java.lang.String)

setContextInfoUrlString

public void setContextInfoUrlString(String url)

Initializes the context info URL.

Parameters:

url - an URL. May be null.

See Also:

getContextInfoUrlString()

getContextInfoWidth

public Integer getContextInfoWidth()

Returns the context info width, in pixels. The desired width of the context window.

Returns:

a width. May be null.

See Also:

setContextInfoWidth(java.lang.Integer)

setContextInfoWidth

public void setContextInfoWidth(Integer width)

Initializes the context info width, in pixels.

Parameters:

width - a width. May be null.

Throws:

IllegalArgumentException - if the specified value is not positive.

See Also:

getContextInfoWidth(), setContextInfoWidth(int)

setContextInfoWidth

public void setContextInfoWidth(int width)

Initializes the context info width, in pixels.

Parameters:

width - a width. Shall not be strictly negative.

Throws:

IllegalArgumentException - if the specified width is not positive.

See Also:

getContextInfoWidth(), setContextInfoWidth(Integer)

getContextInfoHeight

public Integer getContextInfoHeight()

Returns the context info height, in pixels. The desired height of the context window.

Returns:

an height. May be null.

See Also:

setContextInfoHeight(java.lang.Integer)

setContextInfoHeight

public void setContextInfoHeight(Integer height)

Initializes the context info height, in pixels.

Parameters:

height - an height. May be null.

Throws:

IllegalArgumentException - if the specified value is not positive.

See Also:

getContextInfoHeight(), setContextInfoHeight(int)

setContextInfoHeight

public void setContextInfoHeight(int height)

Initializes the context info height, in pixels.

Parameters:

height - an height. Shall not be strictly negative.

Throws:

IllegalArgumentException - if the specified height is not positive.

See Also:

getContextInfoHeight(), setContextInfoHeight(Integer)

getIsStreamingString

public String getIsStreamingString()

Specifies that this is a streaming URL that should simply be imported and not downloaded. In this case, the returned string is "1". Otherwise it is null.
Note: The PACKAGE/ACTION tag must also be set to "import-copy" and the PACKAGE/SERVER/URL tag must contain the URL associated with the streaming content. The PACKAGE/TRACKLIST/TRACK/FILENAME tag is considered irrelevant in this situation.

Returns:

the streaming URL indicator. May be null.

See Also:

setIsStreamingString(java.lang.String), isStreaming()

setIsStreamingString

public void setIsStreamingString(String isStreaming)

Specifies that this is a streaming URL that should simply be imported and not downloaded.

Parameters:

isStreaming - the streaming URL indicator. May be null.

See Also:

getIsStreamingString(), setIsStreaming(boolean)

isStreaming

public boolean isStreaming()

Specifies that this is a streaming URL that should simply be imported and not downloaded.

Returns:

the streaming URL indicator.

See Also:

setIsStreaming(boolean), getIsStreamingString()

setIsStreaming

public void setIsStreaming(boolean isStreaming)

Specifies that this is a streaming URL that should simply be imported and not downloaded.

Parameters:

isStreaming - the streaming URL indicator.

See Also:

isStreaming(), setIsStreamingString(java.lang.String)