jreceiver.common.rec.source
Class HplaylistRec

java.lang.Object
  |
  +--jreceiver.common.rec.BaseRec
        |
        +--jreceiver.common.rec.source.SourceRec
              |
              +--jreceiver.common.rec.source.PlaylistRec
                    |
                    +--jreceiver.common.rec.source.HplaylistRec

All Implemented Interfaces:

Hashable, Playlist, Rec, Selectable, Sortable, Source, SourceFolder, SourceList

public class HplaylistRec

extends PlaylistRec

implements SourceList, SourceFolder

Bean to represent a single Tree (hierarchical) playlist record

Version:

$Revision: 1.4 $ $Date: 2003/04/27 23:14:31 $

Author:

Reed Esau

Field Summary

protected java.util.Set	m_folder_id_set a list of all folder_ids associated with this playlist
protected java.util.Set	m_source_id_set a list of all mfile src_ids associated with this playlist

Fields inherited from class jreceiver.common.rec.source.PlaylistRec

m_is_checked, m_order_by, m_pl_type, m_tune_count

Fields inherited from class jreceiver.common.rec.source.SourceRec

m_content_url, m_direct_uri, m_dst_mime, m_duration, m_mime, m_site_id, m_src_id, m_src_type, m_title

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

HKEY_PL_SRC_ID, HKEY_SOURCE_IDS

Fields inherited from interface jreceiver.common.rec.Rec

HKEY_KEY, NO_LIMIT

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

HKEY_FOLDER_IDS, HKEY_PL_SRC_ID

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

HKEY_PL_TYPE, HKEY_TUNE_COUNT, PLAYLIST_TYPE_ALL, PLAYLIST_TYPE_DYNAMIC, PLAYLIST_TYPE_FILE, PLAYLIST_TYPE_STATION, PLAYLIST_TYPE_TREE, POPULATE_FILTERABLE, POPULATE_FOLDERLIST, POPULATE_SOURCELIST

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.Sortable

HKEY_ORDER_BY

Fields inherited from interface jreceiver.common.rec.Selectable

HKEY_CHECKED

Constructor Summary

HplaylistRec()
ctor - used by HplaylistEditAction

HplaylistRec(java.util.Hashtable hash)
ctor - construct from a hashtable, usually retrieved via XML-RPC

HplaylistRec(int src_id, java.lang.String mime, int duration, org.esau.ptarmigan.util.PtarURI direct_uri, java.net.URL content_url, java.lang.String name, java.lang.String order_by, int tune_count)
ctor - used by PlaylistRecs.createInstance() ctor - used by PlaylistDB.getRecs

HplaylistRec(int src_id, java.lang.String mime, int duration, org.esau.ptarmigan.util.PtarURI direct_uri, java.net.URL content_url, java.lang.String name, java.lang.String order_by, int tune_count, java.util.Vector source_ids, java.util.Vector folder_ids)
ctor - deep, i.e., with source_ids and folders

Method Summary

int	getFolderCount()
java.util.Vector	getFolderIds()
java.util.Set	getFolderIdSet()
int	getSourceCount()
java.util.Vector	getSourceIds()
java.util.Set	getSourceIdSet()
void	setFolderIds(java.util.Vector folder_ids) TODO: get rid of this in favor of immutable concrete objects
void	setFolderIdSet(java.util.Set folder_id_set) TODO: get rid of this in favor of immutable concrete objects
void	setSourceIds(java.util.Vector source_ids) TODO: get rid of this in favor of immutable concrete objects
void	setSourceIdSet(java.util.Set source_id_set) TODO: get rid of this in favor of immutable concrete objects
java.util.Hashtable	toHash() Store the object as a hash suitable for transport over an XML-RPC connection or similar.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class jreceiver.common.rec.source.PlaylistRec

createInstance, createInstance, getChecked, getIsDynamicPlaylist, getIsFilePlaylist, getIsStationPlaylist, getIsTreePlaylist, getOrderBy, getPlaylistType, getTuneCount, setChecked, setOrderBy, setPlaylistType, setTuneCount

Methods inherited from class jreceiver.common.rec.source.SourceRec

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

Methods inherited from class jreceiver.common.rec.BaseRec

dissolve, dissolveMap, find, find, find, find

Methods inherited from class java.lang.Object

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

Methods inherited from interface jreceiver.common.rec.Rec

getKey, setKey

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

Field Detail

m_source_id_set

protected java.util.Set m_source_id_set

a list of all mfile src_ids associated with this playlist

m_folder_id_set

protected java.util.Set m_folder_id_set

a list of all folder_ids associated with this playlist

Constructor Detail

HplaylistRec

public HplaylistRec()

ctor - used by HplaylistEditAction

HplaylistRec

public HplaylistRec(int src_id,
                    java.lang.String mime,
                    int duration,
                    org.esau.ptarmigan.util.PtarURI direct_uri,
                    java.net.URL content_url,
                    java.lang.String name,
                    java.lang.String order_by,
                    int tune_count)

ctor - used by PlaylistRecs.createInstance() ctor - used by PlaylistDB.getRecs

HplaylistRec

public HplaylistRec(int src_id,
                    java.lang.String mime,
                    int duration,
                    org.esau.ptarmigan.util.PtarURI direct_uri,
                    java.net.URL content_url,
                    java.lang.String name,
                    java.lang.String order_by,
                    int tune_count,
                    java.util.Vector source_ids,
                    java.util.Vector folder_ids)

ctor - deep, i.e., with source_ids and folders

HplaylistRec

public HplaylistRec(java.util.Hashtable hash)
             throws RecException

ctor - construct from a hashtable, usually retrieved via XML-RPC

Method Detail

toHash

public java.util.Hashtable toHash()

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

Use HplaylistRec(Hashtable) to transform the data back into an object of this type.

Specified by:

toHash in interface Hashable

Overrides:

toHash in class PlaylistRec

Returns:

toString

public java.lang.String toString()

Description copied from interface: Hashable

Returns a string representation of the object.

Specified by:

toString in interface Hashable

Overrides:

toString in class PlaylistRec

getSourceIds

public java.util.Vector getSourceIds()

Specified by:

getSourceIds in interface SourceList

setSourceIds

public void setSourceIds(java.util.Vector source_ids)

TODO: get rid of this in favor of immutable concrete objects

Specified by:

setSourceIds in interface SourceList

getFolderIds

public java.util.Vector getFolderIds()

Specified by:

getFolderIds in interface SourceFolder

setFolderIds

public void setFolderIds(java.util.Vector folder_ids)

TODO: get rid of this in favor of immutable concrete objects

Specified by:

setFolderIds in interface SourceFolder

getFolderCount

public int getFolderCount()

getSourceCount

public int getSourceCount()

getSourceIdSet

public java.util.Set getSourceIdSet()

setSourceIdSet

public void setSourceIdSet(java.util.Set source_id_set)

TODO: get rid of this in favor of immutable concrete objects

getFolderIdSet

public java.util.Set getFolderIdSet()

setFolderIdSet

public void setFolderIdSet(java.util.Set folder_id_set)

TODO: get rid of this in favor of immutable concrete objects