de.umass.lastfm
Class Album

java.lang.Object
  de.umass.lastfm.ImageHolder
      de.umass.lastfm.MusicEntry
          de.umass.lastfm.Album

public class Album
extends MusicEntry

Wrapper class for Album related API calls and Album Bean.

Author:

Janni Kovacs

Field Summary

Fields inherited from class de.umass.lastfm.MusicEntry

id, listeners, mbid, name, percentageChange, playcount, streamable, tags, url, userPlaycount

Fields inherited from class de.umass.lastfm.ImageHolder

imageUrls

Method Summary

static Result	addTags(String artist, String album, String tags, Session session) Tag an album using a list of user supplied tags.
String	getArtist()
static Collection<BuyLink>	getBuylinks(String artist, String albumOrMbid, String country, String apiKey) Get a list of Buy Links for a particular Album.
static Album	getInfo(String artist, String albumOrMbid, String apiKey) Get the metadata for an album on Last.fm using the album name or a musicbrainz id.
static Album	getInfo(String artist, String albumOrMbid, String username, String apiKey) Get the metadata for an album on Last.fm using the album name or a musicbrainz id.
Date	getReleaseDate()
static PaginatedResult<Shout>	getShouts(String artist, String albumOrMbid, int page, int limit, String apiKey) Get shouts for an album.
static PaginatedResult<Shout>	getShouts(String artist, String albumOrMbid, int page, String apiKey) Get shouts for an album.
static PaginatedResult<Shout>	getShouts(String artist, String albumOrMbid, String apiKey) Get shouts for an album.
static Collection<String>	getTags(String artist, String album, Session session) Get the tags applied by an individual user to an album on Last.fm.
static Collection<Tag>	getTopTags(String artist, String albumOrMbid, String apiKey) Get the top tags for an album on Last.fm, ordered by popularity.
Collection<Track>	getTracks() Returns the list of Tracks on this album.
static Result	removeTag(String artist, String album, String tag, Session session) Remove a user's tag from an album.
static Collection<Album>	search(String album, String apiKey) Search for an album by name.

Methods inherited from class de.umass.lastfm.MusicEntry

getId, getListeners, getMbid, getName, getPercentageChange, getPlaycount, getSimilarityMatch, getTags, getUrl, getUserPlaycount, getWikiLastChanged, getWikiSummary, getWikiText, isStreamable, loadStandardInfo, toString

Methods inherited from class de.umass.lastfm.ImageHolder

availableSizes, getImageURL, loadImages

Methods inherited from class java.lang.Object

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

Method Detail

getArtist

public String getArtist()

getReleaseDate

public Date getReleaseDate()

getTracks

public Collection<Track> getTracks()

Returns the list of Tracks on this album. This information is only available in getInfo(String, String, String) responses.

Returns:

the list of tracks

See Also:

getInfo(String, String, String)

getInfo

public static Album getInfo(String artist,
                            String albumOrMbid,
                            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

getInfo

public static Album getInfo(String artist,
                            String albumOrMbid,
                            String username,
                            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

username - The username for the context of the request. If supplied, the user's playcount for this album is included in the response.

apiKey - The API key

Returns:

Album metadata

addTags

public static Result addTags(String artist,
                             String album,
                             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(String artist,
                               String album,
                               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 Collection<String> getTags(String artist,
                                         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 Collection<Album> search(String album,
                                       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

getBuylinks

public static Collection<BuyLink> getBuylinks(String artist,
                                              String albumOrMbid,
                                              String country,
                                              String apiKey)

Get a list of Buy Links for a particular Album. It is required that you supply either the artist and track params or the mbid param.

Parameters:

artist - The artist name in question

albumOrMbid - Album name or MBID

country - A country name, as defined by the ISO 3166-1 country names standard

apiKey - A Last.fm API key

Returns:

a Collection of BuyLinks

getTopTags

public static Collection<Tag> getTopTags(String artist,
                                         String albumOrMbid,
                                         String apiKey)

Get the top tags for an album on Last.fm, ordered by popularity. You either have to specify an album and artist name or an mbid. If you specify an mbid you may pass null for the first parameter.

Parameters:

artist - The artist name

albumOrMbid - Album name or MBID

apiKey - A Last.fm API key

Returns:

list of top tags

getShouts

public static PaginatedResult<Shout> getShouts(String artist,
                                               String albumOrMbid,
                                               String apiKey)

Get shouts for an album.

Parameters:

artist - The artist name

albumOrMbid - The album name or a mausicbrainz id

apiKey - A Last.fm API key.

Returns:

a page of Shouts

getShouts

public static PaginatedResult<Shout> getShouts(String artist,
                                               String albumOrMbid,
                                               int page,
                                               String apiKey)

Get shouts for an album.

Parameters:

artist - The artist name

albumOrMbid - The album name or a mausicbrainz id

page - The page number to fetch

apiKey - A Last.fm API key.

Returns:

a page of Shouts

getShouts

public static PaginatedResult<Shout> getShouts(String artist,
                                               String albumOrMbid,
                                               int page,
                                               int limit,
                                               String apiKey)

Get shouts for an album.

Parameters:

artist - The artist name

albumOrMbid - The album name or a mausicbrainz id

page - The page number to fetch

limit - An integer used to limit the number of shouts returned per page or -1 for default

apiKey - A Last.fm API key.

Returns:

a page of Shouts