jreceiver.common.rec.source
Interface Playlist

All Superinterfaces:

Hashable, Rec, Selectable, Sortable, Source

All Known Implementing Classes:

PlaylistRec

public interface Playlist

extends Source, Sortable, Selectable

An interface to be implemented by all playlist sources.

Corresponds to playlist table in JReceiver database.

Version:

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

Author:

Reed Esau

Field Summary

static java.lang.String	HKEY_PL_TYPE
static java.lang.String	HKEY_TUNE_COUNT
static int	PLAYLIST_TYPE_ALL Corresponds to the playlists tables of all types.
static int	PLAYLIST_TYPE_DYNAMIC A 'dynamic' playlist source is the result of a database query.
static int	PLAYLIST_TYPE_FILE A 'file' dynamic source is conventional playlist file whose contents have been cached in the database for quick retrieval and filtering
static int	PLAYLIST_TYPE_STATION A 'station' playlist source refers to a streaming internet radio station.
static int	PLAYLIST_TYPE_TREE A 'tree' playlist source is a user-specified hierarchy of files and folders.
static java.lang.String	POPULATE_FILTERABLE populate filterable interface of a playlist bean, if available
static java.lang.String	POPULATE_FOLDERLIST populate folderlist interface of a playlist bean, if available
static java.lang.String	POPULATE_SOURCELIST populate sourcelist interface of a playlist bean, if available

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

Fields inherited from interface jreceiver.common.rec.Sortable

HKEY_ORDER_BY

Fields inherited from interface jreceiver.common.rec.Selectable

HKEY_CHECKED

Method Summary

boolean	getIsDynamicPlaylist()
boolean	getIsFilePlaylist()
boolean	getIsStationPlaylist()
boolean	getIsTreePlaylist()
int	getPlaylistType() obtain the playlist type (file, dynamic or tree)
int	getTuneCount() Obtain the number of media files (not lines!) specified in a playlist file.
void	setPlaylistType(int pl_type) assign the playlist type (file, dynamic or tree)
void	setTuneCount(int count) Assign the number of media files (not lines!) specified in a playlist file.
java.util.Hashtable	toHash() Store the object as a hash suitable for transport over an XML-RPC connection or similar.

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

toString

Methods inherited from interface jreceiver.common.rec.Sortable

getOrderBy, setOrderBy

Methods inherited from interface jreceiver.common.rec.Selectable

getChecked, setChecked

Field Detail

HKEY_PL_TYPE

public static final java.lang.String HKEY_PL_TYPE

HKEY_TUNE_COUNT

public static final java.lang.String HKEY_TUNE_COUNT

POPULATE_SOURCELIST

public static final java.lang.String POPULATE_SOURCELIST

populate sourcelist interface of a playlist bean, if available

POPULATE_FOLDERLIST

public static final java.lang.String POPULATE_FOLDERLIST

populate folderlist interface of a playlist bean, if available

POPULATE_FILTERABLE

public static final java.lang.String POPULATE_FILTERABLE

populate filterable interface of a playlist bean, if available

PLAYLIST_TYPE_ALL

public static final int PLAYLIST_TYPE_ALL

Corresponds to the playlists tables of all types.

PLAYLIST_TYPE_FILE

public static final int PLAYLIST_TYPE_FILE

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

Corresponds to the fplaylists tables.

PLAYLIST_TYPE_DYNAMIC

public static final int PLAYLIST_TYPE_DYNAMIC

A 'dynamic' playlist source is the result of a database query.

Corresponds to the dplaylist table.

PLAYLIST_TYPE_TREE

public static final int PLAYLIST_TYPE_TREE

A 'tree' playlist source is a user-specified hierarchy of files and folders.

Corresponds to the source_list and source_folder tables.

PLAYLIST_TYPE_STATION

public static final int PLAYLIST_TYPE_STATION

A 'station' playlist source refers to a streaming internet radio station.

Corresponds to the splaylist_url.

Method Detail

getPlaylistType

public int getPlaylistType()

obtain the playlist type (file, dynamic or tree)

setPlaylistType

public void setPlaylistType(int pl_type)

assign the playlist type (file, dynamic or tree)

getTuneCount

public int getTuneCount()

Obtain the number of media files (not lines!) specified in a playlist file.

setTuneCount

public void setTuneCount(int count)

Assign the number of media files (not lines!) specified in a playlist file.

toHash

public java.util.Hashtable toHash()

Store the object as a hash suitable for transport over an XML-RPC connection or similar.

Use a constructor appropriate to the playlist type to transform the data back into an object of this type.

Specified by:

toHash in interface Hashable

Following copied from interface: jreceiver.common.rec.Hashable

Returns:

getIsDynamicPlaylist

public boolean getIsDynamicPlaylist()

getIsTreePlaylist

public boolean getIsTreePlaylist()

getIsFilePlaylist

public boolean getIsFilePlaylist()

getIsStationPlaylist

public boolean getIsStationPlaylist()