jreceiver.common.rec.source
Class SplaylistRec

java.lang.Object
  |
  +--jreceiver.common.rec.BaseRec
        |
        +--jreceiver.common.rec.source.SourceRec
              |
              +--jreceiver.common.rec.source.PlaylistRec
                    |
                    +--jreceiver.common.rec.source.SplaylistRec
All Implemented Interfaces:
Hashable, Mexternal, Playlist, Rec, Selectable, Sortable, Source, SourceList

public class SplaylistRec
extends PlaylistRec
implements Mexternal, SourceList

Bean to represent a station playlist

Version:
$Revision: 1.5 $ $Date: 2003/04/27 23:14:31 $
Author:
Reed Esau

Field Summary
protected  boolean m_cache_data
          Indicating whether the stunes will be reused or refreshed each time the splaylist is cued.
protected  java.util.Vector m_stune_ids
          a list of all 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.Mexternal
HKEY_CACHE_DATA
 
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.source.SourceList
HKEY_PL_SRC_ID, HKEY_SOURCE_IDS
 
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.Sortable
HKEY_ORDER_BY
 
Fields inherited from interface jreceiver.common.rec.Selectable
HKEY_CHECKED
 
Constructor Summary
SplaylistRec()
          empty ctor needed for building via Digester
SplaylistRec(java.util.Hashtable hash)
          ctor - construct from a hashtable, usually retrieved via XML-RPC
SplaylistRec(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
SplaylistRec(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, boolean cache_data)
          ctor - with url string
SplaylistRec(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, boolean cache_data, java.util.Vector stune_ids)
          ctor - deep, with url string and stune_ids
 
Method Summary
 boolean getCacheData()
          Obtain the cache_data flag.
 java.util.Vector getSourceIds()
           
 void setCacheData(boolean cache_data)
          Assign the cache_data flag
 void setSourceIds(java.util.Vector stune_ids)
           
 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.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
 

Field Detail

m_stune_ids

protected java.util.Vector m_stune_ids
a list of all src_ids associated with this playlist

m_cache_data

protected boolean m_cache_data
Indicating whether the stunes will be reused or refreshed each time the splaylist is cued.
Constructor Detail

SplaylistRec

public SplaylistRec()
empty ctor needed for building via Digester

SplaylistRec

public SplaylistRec(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

SplaylistRec

public SplaylistRec(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,
                    boolean cache_data)
ctor - with url string

SplaylistRec

public SplaylistRec(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,
                    boolean cache_data,
                    java.util.Vector stune_ids)
ctor - deep, with url string and stune_ids

SplaylistRec

public SplaylistRec(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 SplaylistRec(Hashtable) to transform the data back into an object of this type.

Specified by:
toHash in interface Hashable
Overrides:
toHash in class PlaylistRec
Following copied from interface: jreceiver.common.rec.Hashable
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 stune_ids)
Specified by:
setSourceIds in interface SourceList

setCacheData

public void setCacheData(boolean cache_data)
Assign the cache_data flag
Specified by:
setCacheData in interface Mexternal

getCacheData

public boolean getCacheData()
Obtain the cache_data flag.
Specified by:
getCacheData in interface Mexternal


Copyright © 2001-2002 Reed Esau, All Rights Reserved.