jreceiver.common.rec.source
Class FplaylistRec

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

All Implemented Interfaces:

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

public class FplaylistRec

extends PlaylistRec

implements Mfile, SourceList

Bean to represent a single playlist file record

Version:

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

Author:

Reed Esau

Field Summary

protected long	m_file_size
protected int	m_folder_id
protected long	m_last_modified
protected java.util.Vector	m_source_ids 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.Mfile

HKEY_FILE_SIZE, HKEY_FOLDER_ID, HKEY_LAST_MODIFIED

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

FplaylistRec()
empty ctor needed for building via Digester

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

FplaylistRec(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 PlaylistRec.createInstance ctor - used by PlaylistDB.getRecs

FplaylistRec(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, int folder_id, long file_size, long last_modified)
ctor - shallow, no file list

FplaylistRec(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, int folder_id, long file_size, long last_modified, java.util.Vector source_ids)
ctor - deep, with file list

FplaylistRec(int src_id, java.lang.String mime, java.lang.String name, java.lang.String order_by)
ctor - used by FplaylistEditAction

Method Summary

long	getFileSize() Obtain the file size
int	getFolderId() Obtain the folder id
long	getLastModified() Obtain the unix epoc timestamp of the last time the file was modified
java.util.Vector	getSourceIds()
void	setFileSize(long file_size) Assign the file size
void	setFolderId(int folder_id) Assign the folder_id
void	setLastModified(long last_modified) Assign the unix epoc timestamp of the last time the file was modified
void	setLastModifiedISO(java.lang.String iso_date) Assign the timestamp of the last time the file was modified
void	setSourceIds(java.util.Vector source_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_source_ids

protected java.util.Vector m_source_ids

a list of all mfile src_ids associated with this playlist

m_folder_id

protected int m_folder_id

m_file_size

protected long m_file_size

m_last_modified

protected long m_last_modified

Constructor Detail

FplaylistRec

public FplaylistRec()

empty ctor needed for building via Digester

FplaylistRec

public FplaylistRec(int src_id,
                    java.lang.String mime,
                    java.lang.String name,
                    java.lang.String order_by)

ctor - used by FplaylistEditAction

FplaylistRec

public FplaylistRec(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 PlaylistRec.createInstance ctor - used by PlaylistDB.getRecs

FplaylistRec

public FplaylistRec(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,
                    int folder_id,
                    long file_size,
                    long last_modified)

ctor - shallow, no file list

FplaylistRec

public FplaylistRec(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,
                    int folder_id,
                    long file_size,
                    long last_modified,
                    java.util.Vector source_ids)

ctor - deep, with file list

FplaylistRec

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

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

Method Detail

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)

Specified by:

setSourceIds in interface SourceList

getFolderId

public int getFolderId()

Obtain the folder id

Specified by:

getFolderId in interface Mfile

setFolderId

public void setFolderId(int folder_id)

Assign the folder_id

Specified by:

setFolderId in interface Mfile

getFileSize

public long getFileSize()

Obtain the file size

Specified by:

getFileSize in interface Mfile

setFileSize

public void setFileSize(long file_size)

Assign the file size

Specified by:

setFileSize in interface Mfile

getLastModified

public long getLastModified()

Obtain the unix epoc timestamp of the last time the file was modified

Units are in milliseconds.

Specified by:

getLastModified in interface Mfile

setLastModified

public void setLastModified(long last_modified)

Assign the unix epoc timestamp of the last time the file was modified

Units are in milliseconds.

Specified by:

setLastModified in interface Mfile

setLastModifiedISO

public void setLastModifiedISO(java.lang.String iso_date)

Assign the timestamp of the last time the file was modified

Provide a date in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss)

Note that we have to use a different name than 'setLastModified' as Struts/BeanUtils gets confused and thinks that getLastModified should return a string.

Specified by:

setLastModifiedISO in interface Mfile

toHash

public java.util.Hashtable toHash()

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

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

Specified by:

toHash in interface Hashable

Overrides:

toHash in class PlaylistRec

Returns: