jreceiver.common.rec.source
Interface Tune

All Superinterfaces:

Hashable, Rec, Source

All Known Implementing Classes:

TuneRec

public interface Tune

extends Source

An interface to be implemented by a 'tune' media source, i.e., associated with an mp3 file or stream with unchanging tag info.

Version:

$Revision: 1.3 $ $Date: 2002/09/24 18:20:44 $

Author:

Reed Esau

Field Summary

static java.lang.String	HKEY_ALBUM
static java.lang.String	HKEY_BITRATE
static java.lang.String	HKEY_COMMENT
static java.lang.String	HKEY_COMPOSER
static java.lang.String	HKEY_CONTENT_TYPE
static java.lang.String	HKEY_DATA_OFFSET
static java.lang.String	HKEY_LEAD_PERFORMER
static java.lang.String	HKEY_TRACK_NUMBER
static java.lang.String	HKEY_TUNE_TYPE
static java.lang.String	HKEY_YEAR
static java.lang.String	POPULATE_ALBUM populate album member of a tune bean, if available
static java.lang.String	POPULATE_ARTIST populate artist (lead performer) member of a tune bean, if available
static java.lang.String	POPULATE_COMMENTS populate comment member(s) of a tune bean, if available
static java.lang.String	POPULATE_COMPOSER populate composer member of a tune bean, if available
static java.lang.String	POPULATE_GENRELIST populate genres member of a tune bean (content type), if available
static int	TUNE_TYPE_ALL Corresponds to the tunes tables of all types.
static int	TUNE_TYPE_CD_BASED A 'CD' tune source is a tune located in a CD-carousel and which is not stored in a compressed file format.
static int	TUNE_TYPE_FILE A 'tune file' dynamic source is conventional tune file whose contents have been cached in the database for quick retrieval and filtering
static int	TUNE_TYPE_STATION A 'radio' tune source is a webcast audio source.

Fields inherited from interface jreceiver.common.rec.source.Source

DEFAULT_URL, FORCE_PLAYLIST_URL, HKEY_CONTENT_URL, HKEY_DIRECT_URI, HKEY_DST_MIME, HKEY_DURATION, HKEY_MIME, HKEY_SITE_ID, HKEY_SRC_ID, HKEY_SRC_TYPE, HKEY_TITLE, MAX_SRC_ID, MIN_SRC_ID, POPULATE_CONTENT_URL, POPULATE_DIRECT_URI, POPULATE_MEXTERNAL, POPULATE_MFILE, SRCTYPE_PLAYLIST, SRCTYPE_TUNE, SRCTYPE_UNDEFINED

Fields inherited from interface jreceiver.common.rec.Rec

HKEY_KEY, NO_LIMIT

Method Summary

void	addGenre(java.lang.String genre) assign a single genre
Album	getAlbum() obtain the album
java.lang.String	getAlbumStr() obtain the album name as a string (used for display from jsp)
Artist	getArtist() obtain the lead performer
java.lang.String	getArtistStr() obtain the artist name as a string (used for display from jsp)
int	getBitrate() obtain the 'bitrate'
Comment	getComment() obtain the comment
Composer	getComposer() obtain the composer
java.lang.String	getComposerStr() obtain the composer name as a string (used for display from jsp)
int	getDataOffset() obtain the offset in the music file where the mpeg data starts.
java.util.Vector	getGenres() obtain the genres
java.lang.String	getGenreStr() obtain the genre list, as a comma-delimited string (used for display)
boolean	getIsCdBasedTune()
boolean	getIsStationTune()
boolean	getIsTuneFile()
int	getTrackNo() obtain the 'trackno'
int	getTuneType() obtain the tune type (file, station, or CD)
int	getYear() obtain the 'year'
void	setAlbum(Album album) assign the album
void	setArtist(Artist artist) assign the lead performer
void	setBitrate(int bitrate) assign the 'bitrate'
void	setComment(Comment comment) assign the comment
void	setComposer(Composer composer) assign the composer
void	setDataOffset(int data_offset) assign the offset in the music file where the mpeg data starts.
void	setGenres(java.util.Vector genres) assign the genres
void	setTrackNo(int trackno) assign the 'trackno'
void	setTuneType(int tune_type) assign the tune type (file, station, or CD)
void	setYear(int year) assign the 'year'

Methods inherited from interface jreceiver.common.rec.source.Source

getContentSystemId, getContentURL, getDirectSystemId, getDirectURI, getDstMime, getDuration, getFile, getFileExtension, getFileName, getFilePath, getIsLocal, getIsOffsite, getIsPlaylist, getIsTune, getMime, getSiteId, getSrcId, getTitle, getType, setContentURL, setDirectURI, setDirectURI, setDuration, setMime, setSrcId, setTitle

Methods inherited from interface jreceiver.common.rec.Rec

getKey, setKey

Methods inherited from interface jreceiver.common.rec.Hashable

toHash, toString

Field Detail

HKEY_TUNE_TYPE

public static final java.lang.String HKEY_TUNE_TYPE

HKEY_DATA_OFFSET

public static final java.lang.String HKEY_DATA_OFFSET

HKEY_BITRATE

public static final java.lang.String HKEY_BITRATE

HKEY_YEAR

public static final java.lang.String HKEY_YEAR

HKEY_ALBUM

public static final java.lang.String HKEY_ALBUM

HKEY_COMPOSER

public static final java.lang.String HKEY_COMPOSER

HKEY_LEAD_PERFORMER

public static final java.lang.String HKEY_LEAD_PERFORMER

HKEY_CONTENT_TYPE

public static final java.lang.String HKEY_CONTENT_TYPE

HKEY_TRACK_NUMBER

public static final java.lang.String HKEY_TRACK_NUMBER

HKEY_COMMENT

public static final java.lang.String HKEY_COMMENT

POPULATE_ALBUM

public static final java.lang.String POPULATE_ALBUM

populate album member of a tune bean, if available

POPULATE_ARTIST

public static final java.lang.String POPULATE_ARTIST

populate artist (lead performer) member of a tune bean, if available

POPULATE_COMPOSER

public static final java.lang.String POPULATE_COMPOSER

populate composer member of a tune bean, if available

POPULATE_GENRELIST

public static final java.lang.String POPULATE_GENRELIST

populate genres member of a tune bean (content type), if available

POPULATE_COMMENTS

public static final java.lang.String POPULATE_COMMENTS

populate comment member(s) of a tune bean, if available

TUNE_TYPE_ALL

public static final int TUNE_TYPE_ALL

Corresponds to the tunes tables of all types.

TUNE_TYPE_FILE

public static final int TUNE_TYPE_FILE

A 'tune file' dynamic source is conventional tune file whose contents have been cached in the database for quick retrieval and filtering

Each 'file' tune has a record in the tune table as well as a corresponding record in the mfile table.

TUNE_TYPE_STATION

public static final int TUNE_TYPE_STATION

A 'radio' tune source is a webcast audio source.

Each 'station' Tune has a record in the tune table as well as a corresponding record in the rtune table.

TUNE_TYPE_CD_BASED

public static final int TUNE_TYPE_CD_BASED

A 'CD' tune source is a tune located in a CD-carousel and which is not stored in a compressed file format.

Each 'cd based' Tune has a record in the tune table as well as a corresponding record in the cdtune table.

Method Detail

getTuneType

public int getTuneType()

obtain the tune type (file, station, or CD)

setTuneType

public void setTuneType(int tune_type)

assign the tune type (file, station, or CD)

getDataOffset

public int getDataOffset()

obtain the offset in the music file where the mpeg data starts.

Returns:

a byte offset where the mpeg (or other) data begins

setDataOffset

public void setDataOffset(int data_offset)

assign the offset in the music file where the mpeg data starts.

getBitrate

public int getBitrate()

obtain the 'bitrate'

units are in bps, e.g., 65535 bps == 64 kbps

setBitrate

public void setBitrate(int bitrate)

assign the 'bitrate'

units are in bps, e.g., 65535 bps == 64 kbps

getTrackNo

public int getTrackNo()

obtain the 'trackno'

setTrackNo

public void setTrackNo(int trackno)

assign the 'trackno'

getYear

public int getYear()

obtain the 'year'

setYear

public void setYear(int year)

assign the 'year'

getArtist

public Artist getArtist()

obtain the lead performer

setArtist

public void setArtist(Artist artist)

assign the lead performer

getArtistStr

public java.lang.String getArtistStr()

obtain the artist name as a string (used for display from jsp)

getAlbum

public Album getAlbum()

obtain the album

setAlbum

public void setAlbum(Album album)

assign the album

getAlbumStr

public java.lang.String getAlbumStr()

obtain the album name as a string (used for display from jsp)

getComposer

public Composer getComposer()

obtain the composer

setComposer

public void setComposer(Composer composer)

assign the composer

getComposerStr

public java.lang.String getComposerStr()

obtain the composer name as a string (used for display from jsp)

getComment

public Comment getComment()

obtain the comment

setComment

public void setComment(Comment comment)

assign the comment

getGenres

public java.util.Vector getGenres()

obtain the genres

setGenres

public void setGenres(java.util.Vector genres)

assign the genres

addGenre

public void addGenre(java.lang.String genre)

assign a single genre

getGenreStr

public java.lang.String getGenreStr()

obtain the genre list, as a comma-delimited string (used for display)

getIsTuneFile

public boolean getIsTuneFile()

getIsStationTune

public boolean getIsStationTune()

getIsCdBasedTune

public boolean getIsCdBasedTune()