net.roarsoftware.lastfm
Class Album

java.lang.Object
  extended by net.roarsoftware.lastfm.ImageHolder
      extended by net.roarsoftware.lastfm.MusicEntry
          extended by net.roarsoftware.lastfm.Album

public class Album
extends MusicEntry

Bean for Album info.

Author:
Janni Kovacs

Field Summary
 
Fields inherited from class net.roarsoftware.lastfm.MusicEntry
listeners, mbid, name, playcount, streamable, tags, url
 
Fields inherited from class net.roarsoftware.lastfm.ImageHolder
imageUrls
 
Constructor Summary
protected Album(java.lang.String name, java.lang.String url, java.lang.String artist)
           
protected Album(java.lang.String name, java.lang.String url, java.lang.String mbid, int playcount, int listeners, boolean streamable, java.lang.String artist)
           
 
Method Summary
static Result addTags(java.lang.String artist, java.lang.String album, java.lang.String tags, Session session)
          Tag an album using a list of user supplied tags.
 java.lang.String getArtist()
           
 java.lang.String getId()
           
static Album getInfo(java.lang.String artist, java.lang.String albumOrMbid, java.lang.String apiKey)
          Get the metadata for an album on Last.fm using the album name or a musicbrainz id.
 java.util.Date getReleaseDate()
           
static java.util.Collection<java.lang.String> getTags(java.lang.String artist, java.lang.String album, Session session)
          Get the tags applied by an individual user to an album on Last.fm.
static Result removeTag(java.lang.String artist, java.lang.String album, java.lang.String tag, Session session)
          Remove a user's tag from an album.
static java.util.Collection<Album> search(java.lang.String album, java.lang.String apiKey)
          Search for an album by name.
 
Methods inherited from class net.roarsoftware.lastfm.MusicEntry
getListeners, getMbid, getName, getPlaycount, getTags, getUrl, getWikiLastChanged, getWikiSummary, getWikiText, isStreamable, loadStandardInfo
 
Methods inherited from class net.roarsoftware.lastfm.ImageHolder
availableSizes, getImageURL, loadImages
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Album

protected Album(java.lang.String name,
                java.lang.String url,
                java.lang.String artist)

Album

protected Album(java.lang.String name,
                java.lang.String url,
                java.lang.String mbid,
                int playcount,
                int listeners,
                boolean streamable,
                java.lang.String artist)
Method Detail

getArtist

public java.lang.String getArtist()

getReleaseDate

public java.util.Date getReleaseDate()

getId

public java.lang.String getId()

getInfo

public static Album getInfo(java.lang.String artist,
                            java.lang.String albumOrMbid,
                            java.lang.String apiKey)
Get the metadata for an album on Last.fm using the album name or a musicbrainz id. See playlist.fetch on how to get the album playlist.

Parameters:
artist - Artist's name
albumOrMbid - Album name or MBID
apiKey - The API key
Returns:
Album metadata

addTags

public static Result addTags(java.lang.String artist,
                             java.lang.String album,
                             java.lang.String tags,
                             Session session)
Tag an album using a list of user supplied tags.

Parameters:
artist - The artist name in question
album - The album name in question
tags - A comma delimited list of user supplied tags to apply to this album. Accepts a maximum of 10 tags.
session - The Session instance
Returns:
the Result of the operation
See Also:
Authenticator

removeTag

public static Result removeTag(java.lang.String artist,
                               java.lang.String album,
                               java.lang.String tag,
                               Session session)
Remove a user's tag from an album.

Parameters:
artist - The artist name in question
album - The album name in question
tag - A single user tag to remove from this album.
session - The Session instance
Returns:
the Result of the operation
See Also:
Authenticator

getTags

public static java.util.Collection<java.lang.String> getTags(java.lang.String artist,
                                                             java.lang.String album,
                                                             Session session)
Get the tags applied by an individual user to an album on Last.fm.

Parameters:
artist - The artist name in question
album - The album name in question
session - A Session instance
Returns:
a list of tags

search

public static java.util.Collection<Album> search(java.lang.String album,
                                                 java.lang.String apiKey)
Search for an album by name. Returns album matches sorted by relevance.

Parameters:
album - The album name in question.
apiKey - A Last.fm API key.
Returns:
a Collection of matches