org.musicontroller.gui.edit
Class PlaylistEdit

java.lang.Object
  org.apache.hivemind.impl.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.BaseComponent
              org.apache.tapestry.AbstractPage
                  org.apache.tapestry.html.BasePage
                      org.musicontroller.gui.edit.PlaylistEdit

All Implemented Interfaces:

java.util.EventListener, org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, org.apache.tapestry.event.PageBeginRenderListener, org.apache.tapestry.event.PageEndRenderListener, org.apache.tapestry.IComponent, org.apache.tapestry.IDirectEvent, org.apache.tapestry.IExternalPage, org.apache.tapestry.internal.Component, org.apache.tapestry.IPage, org.apache.tapestry.IRender, org.apache.tapestry.ITemplateComponent

public abstract class PlaylistEdit
extends org.apache.tapestry.html.BasePage
implements org.apache.tapestry.event.PageBeginRenderListener, org.apache.tapestry.event.PageEndRenderListener, org.apache.tapestry.IExternalPage

Implements the MusiController screen Edit Playlist. The functions of this screen:

• Change the name of the playlist.
• Change the release date of the playlist.
• Change the names of the songs on the playlist.
• Change the lengths of the songs on the playlist.
• Change the keywords of the songs on the playlist.
• Add or Remove keywords to all songs at once.
• Add or Remove an artist as a performer to some or all of the songs.
• Change the cover art image of the playlist.

In additon, this screen provides:

• A link to the playlist info screen of the playlist.
• A button to request all songs in the playlist.
• A button to download a ZIP file with all songs in the playlist.
• A picture of the cover art.

Version:

$Id: PlaylistEdit.java,v 1.1 2010/03/16 18:55:42 varienaja Exp $

Author:

Hans Drexler

Field Summary

Fields inherited from class org.apache.tapestry.AbstractComponent

_body, _bodyCount

Constructor Summary

PlaylistEdit()

Method Summary

void	activateExternalPage(java.lang.Object[] args, org.apache.tapestry.IRequestCycle cycle) The first parameter is always the playlist id.
void	addKeywords(org.apache.tapestry.IRequestCycle cycle) Add the keywords entered by the user to all songs in the playlist.
void	addMusician(org.apache.tapestry.IRequestCycle cycle)
void	deleteMusician(org.apache.tapestry.IRequestCycle cycle)
org.apache.tapestry.engine.ILink	editCoverArt(org.apache.tapestry.IRequestCycle cycle) Goto the EditCoverArt page.
void	editSongs(org.apache.tapestry.IRequestCycle cycle) Cycle through the songs in the list of song beans and apply changes to the song name, song length and song keywords to each.
abstract java.util.List<AiRelationBean>	getAiRelationList()
abstract java.lang.String	getArtistfirstname()
abstract java.lang.String	getArtistlastname()
abstract org.apache.tapestry.engine.IEngineService	getExternalService()
abstract java.lang.String	getInstruments()
abstract McService	getMcService()
abstract java.util.List<PlaylistMergeBean>	getMergePlaylistBeanList()
Playlist	getPlaylist() Lazily loads the playlist using the playlist id.
abstract long	getPlaylistId()
abstract java.lang.String	getPlaylistKeywords()
abstract java.lang.String	getPlaylistName()
abstract java.util.Date	getPlaylistReleasedate()
abstract java.util.List<SongBean>	getSongBeanList()
abstract java.lang.String	getTracks()
abstract User	getUser()
void	pageBeginRender(org.apache.tapestry.event.PageEvent event) Prepare the page for rendering.
void	pageEndRender(org.apache.tapestry.event.PageEvent event) Clear the page variables just before the page returns to the page pool.
void	removeKeywords(org.apache.tapestry.IRequestCycle cycle) Remove the keywords entered by the user from all songs in the playlist.
void	save(org.apache.tapestry.IRequestCycle cycle) Save the changed playlist properties releaseDate, playlist name.
abstract void	setAiRelationList(java.util.List<AiRelationBean> relations)
abstract void	setArtistfirstname(java.lang.String firstname)
abstract void	setArtistlastname(java.lang.String lastname)
abstract void	setInstruments(java.lang.String instruments)
abstract void	setMergePlaylistBeanList(java.util.List<PlaylistMergeBean> list)
abstract void	setPlaylistId(long id)
abstract void	setPlaylistKeywords(java.lang.String keywords)
abstract void	setPlaylistName(java.lang.String playlistname)
abstract void	setPlaylistReleasedate(java.util.Date releasedate)
abstract void	setSongBeanList(java.util.List<SongBean> list)
abstract void	setTracks(java.lang.String tracks)

Methods inherited from class org.apache.tapestry.html.BasePage

getResponseContentType

Methods inherited from class org.apache.tapestry.AbstractPage

addPageAttachListener, addPageBeginRenderListener, addPageDetachListener, addPageEndRenderListener, addPageValidateListener, attach, beginPageRender, cleanupAfterRender, detach, endPageRender, firePageAttached, firePageBeginRender, firePageDetached, firePageEndRender, firePageValidate, getChangeObserver, getEngine, getExtendedId, getIdPath, getLocale, getNestedComponent, getOutputEncoding, getPageName, getRequestCycle, hasFormComponents, hasWidgets, removePageAttachListener, removePageBeginRenderListener, removePageDetachListener, removePageEndRenderListener, removePageValidateListener, renderPage, setChangeObserver, setHasFormComponents, setHasWidgets, setLocale, setPageName, validate

Methods inherited from class org.apache.tapestry.BaseComponent

addOuter, finishLoad, getContainedRenderers, getInnerRenderers, renderComponent

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, checkActiveLock, enterActiveState, equals, finishLoad, generateClientId, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getBoundId, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getId, getListeners, getMessages, getNamespace, getPage, getRenderWorker, getSpecification, getSpecifiedId, getTemplateTagName, hasEvents, hashCode, isInActiveState, isParameterBound, isRendering, isStateful, peekClientId, prepareForRender, render, renderBody, renderIdAttribute, renderInformalParameters, setBinding, setClientId, setContainedComponent, setContainer, setHasEvents, setId, setNamespace, setPage, setTemplateTagName, toString, triggerEvent

Methods inherited from class org.apache.hivemind.impl.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tapestry.IPage

addPageAttachListener, addPageBeginRenderListener, addPageDetachListener, addPageEndRenderListener, addPageValidateListener, attach, beginPageRender, detach, endPageRender, firePageAttached, getChangeObserver, getEngine, getLocale, getNestedComponent, getPageName, getPropertyChangeObserver, getRequestCycle, getResponseContentType, hasFormComponents, hasWidgets, removePageAttachListener, removePageBeginRenderListener, removePageDetachListener, removePageEndRenderListener, removePageValidateListener, renderPage, setChangeObserver, setHasFormComponents, setHasWidgets, setLocale, setPageName, validate

Methods inherited from interface org.apache.tapestry.IComponent

addAsset, addBody, addComponent, enterActiveState, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getSpecification, getSpecifiedId, getTemplateTagName, isRendering, peekClientId, renderBody, setBinding, setClientId, setContainedComponent, setContainer, setId, setNamespace, setPage, setTemplateTagName

Methods inherited from interface org.apache.tapestry.IRender

render

Methods inherited from interface org.apache.hivemind.LocationHolder

setLocation

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Constructor Detail

PlaylistEdit

public PlaylistEdit()

Method Detail

getPlaylistId

public abstract long getPlaylistId()

setPlaylistId

public abstract void setPlaylistId(long id)

setPlaylistName

public abstract void setPlaylistName(java.lang.String playlistname)

setPlaylistKeywords

public abstract void setPlaylistKeywords(java.lang.String keywords)

setPlaylistReleasedate

public abstract void setPlaylistReleasedate(java.util.Date releasedate)

setSongBeanList

public abstract void setSongBeanList(java.util.List<SongBean> list)

getPlaylistName

public abstract java.lang.String getPlaylistName()

getPlaylistKeywords

public abstract java.lang.String getPlaylistKeywords()

getPlaylistReleasedate

public abstract java.util.Date getPlaylistReleasedate()

getSongBeanList

public abstract java.util.List<SongBean> getSongBeanList()

getAiRelationList

public abstract java.util.List<AiRelationBean> getAiRelationList()

setAiRelationList

public abstract void setAiRelationList(java.util.List<AiRelationBean> relations)

getArtistfirstname

public abstract java.lang.String getArtistfirstname()

getArtistlastname

public abstract java.lang.String getArtistlastname()

getInstruments

public abstract java.lang.String getInstruments()

getTracks

public abstract java.lang.String getTracks()

setArtistfirstname

public abstract void setArtistfirstname(java.lang.String firstname)

setArtistlastname

public abstract void setArtistlastname(java.lang.String lastname)

setInstruments

public abstract void setInstruments(java.lang.String instruments)

setTracks

public abstract void setTracks(java.lang.String tracks)

getMergePlaylistBeanList

public abstract java.util.List<PlaylistMergeBean> getMergePlaylistBeanList()

setMergePlaylistBeanList

public abstract void setMergePlaylistBeanList(java.util.List<PlaylistMergeBean> list)

getMcService

public abstract McService getMcService()

getExternalService

@InjectObject(value="engine-service:external")
public abstract org.apache.tapestry.engine.IEngineService getExternalService()

getUser

public abstract User getUser()

activateExternalPage

public void activateExternalPage(java.lang.Object[] args,
                                 org.apache.tapestry.IRequestCycle cycle)

The first parameter is always the playlist id. The second argument is optional. When supplied, it contains a CoverArtSearchResult that has been selected as the new cover art for this playlist. This argument can be ignored by this page.

Specified by:

activateExternalPage in interface org.apache.tapestry.IExternalPage

pageBeginRender

public void pageBeginRender(org.apache.tapestry.event.PageEvent event)

Prepare the page for rendering.

• Fills the page properties for the playlist name, band name, release date and keywords.
• Builds a list of SongBean objects filled with the id, songname, bandname, length and keyword list of each song. The list is saved as a page property. The user will be able to see and modify the values stored in the SongBean objects.
• Builds a list of AiRelationBean objects for the artist-instrument relations that are part of every song in the playlist.
• Builds a list of PlaylistMergeBean objects, one for each playlist that has exactly the same name as the playlist being edited. Each bean has a boolean property with which the user can indicate if the playslist should be merged with the playlist being edited.
• Clear input fields that should always be reset before rendering.

  Specified by:

  pageBeginRender in interface org.apache.tapestry.event.PageBeginRenderListener

  Parameters:

  event - The page event.

pageEndRender

public void pageEndRender(org.apache.tapestry.event.PageEvent event)

Clear the page variables just before the page returns to the page pool.

Specified by:

pageEndRender in interface org.apache.tapestry.event.PageEndRenderListener

Overrides:

pageEndRender in class org.apache.tapestry.AbstractComponent

Parameters:

event - The page event.

getPlaylist

public Playlist getPlaylist()

Lazily loads the playlist using the playlist id.

Returns:

The playlist to edit.

save

public void save(org.apache.tapestry.IRequestCycle cycle)

Save the changed playlist properties releaseDate, playlist name. Merges the playlists with another playlist of the same name if the user authorized it.

Parameters:

cycle - The Tapestry MVC cycle.

addKeywords

public void addKeywords(org.apache.tapestry.IRequestCycle cycle)

Add the keywords entered by the user to all songs in the playlist.

Parameters:

cycle - The Tapestry MVC cycle.

removeKeywords

public void removeKeywords(org.apache.tapestry.IRequestCycle cycle)

Remove the keywords entered by the user from all songs in the playlist.

Parameters:

cycle - The Tapestry MVC cycle.

editSongs

public void editSongs(org.apache.tapestry.IRequestCycle cycle)

Cycle through the songs in the list of song beans and apply changes to the song name, song length and song keywords to each.

Parameters:

cycle - The Tapestry MVC cycle.

addMusician

public void addMusician(org.apache.tapestry.IRequestCycle cycle)

deleteMusician

public void deleteMusician(org.apache.tapestry.IRequestCycle cycle)

editCoverArt

public org.apache.tapestry.engine.ILink editCoverArt(org.apache.tapestry.IRequestCycle cycle)

Goto the EditCoverArt page. Pass the page 2 parameters. The first is the playlist id of the playlist being edited. The second is the name of the page the CoverArtEdit page should return to ("PlaylistEdit").