net.dontdrinkandroot.lastfm.api.model

Class Track

java.lang.Object

net.dontdrinkandroot.lastfm.api.model.LfmEntity

net.dontdrinkandroot.lastfm.api.model.Track

All Implemented Interfaces:

Serializable, AlbumEntity, ArtistEntity, DateEntity, DurationEntity, Entity, IdEntity, ListenersEntity, MbidEntity, MusicBrainzEntity, NameEntity, NowPlayingEntity, PlayCountEntity, RankEntity, StreamableEntity, UrlEntity, UserPlayCountEntity

public class Track
extends LfmEntity
implements MusicBrainzEntity, NameEntity, UrlEntity, PlayCountEntity, UserPlayCountEntity, IdEntity, DurationEntity, StreamableEntity, DateEntity, RankEntity, AlbumEntity, NowPlayingEntity, ArtistEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Track(Element element) Create a track from a dom4j element.
Track(String name)

Method Summary

Methods

Modifier and Type	Method and Description
Album	getAlbum()
List<Album>	getAlbums()
Artist	getArtist()
Date	getDate()
Long	getDuration()
Long	getId()
static UnauthenticatedGetQuery<Track>	getInfo(String artist, String track, String mbid, String username) Get the metadata for a track on Last.fm using the artist/track name or a musicbrainz id.
Integer	getListeners()
Float	getMatch()
String	getMbid()
String	getName()
Boolean	getNowPlaying()
Integer	getPlayCount()
Integer	getRank()
static UnauthenticatedGetQuery<ArrayList<Track>>	getSimilar(String track, String artist, String mbid, Boolean autocorrect, Integer limit) Get the similar tracks for this track on Last.fm, based on listening data.
Streamable	getStreamable()
List<Tag>	getTags()
URL	getUrl()
Integer	getUserPlayCount()
Wiki	getWiki()
static PostQuery<Scrobble>	scrobble(String artist, String track, Long startTime, String album, Integer trackNumber, String mbid, String albumArtist, Long duration, String sessionKey) Used to add a track-play to a user's profile.
void	setAlbum(Album album)
void	setAlbums(List<Album> albums)
void	setArtist(Artist artist)
void	setDate(Date date)
void	setDuration(Long duration)
void	setId(Long id)
void	setListeners(Integer listeners)
void	setMatch(Float match)
void	setMbid(String mbid)
void	setName(String name)
void	setNowPlaying(Boolean nowPlaying)
void	setPlayCount(Integer playCount)
void	setRank(Integer rank)
void	setStreamable(Streamable streamable)
void	setTags(List<Tag> tags)
void	setUrl(URL url)
void	setUserPlayCount(Integer userPlayCount)
void	setWiki(Wiki wiki)

Methods inherited from class java.lang.Object

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

Constructor Detail

Track

public Track(String name)

Track

public Track(Element element)

Create a track from a dom4j element.

Parameters:

element - The dom4j element to convert.

Method Detail

getName

public final String getName()

Specified by:

getName in interface NameEntity

getUrl

public final URL getUrl()

Specified by:

getUrl in interface UrlEntity

getDate

public final Date getDate()

Specified by:

getDate in interface DateEntity

setDate

public final void setDate(Date date)

Specified by:

setDate in interface DateEntity

setName

public final void setName(String name)

Specified by:

setName in interface NameEntity

setUrl

public final void setUrl(URL url)

Specified by:

setUrl in interface UrlEntity

getListeners

public final Integer getListeners()

Specified by:

getListeners in interface ListenersEntity

setStreamable

public final void setStreamable(Streamable streamable)

Specified by:

setStreamable in interface StreamableEntity

getStreamable

public final Streamable getStreamable()

Specified by:

getStreamable in interface StreamableEntity

getMbid

public final String getMbid()

Specified by:

getMbid in interface MbidEntity

getPlayCount

public final Integer getPlayCount()

Specified by:

getPlayCount in interface PlayCountEntity

getRank

public final Integer getRank()

Specified by:

getRank in interface RankEntity

setListeners

public final void setListeners(Integer listeners)

Specified by:

setListeners in interface ListenersEntity

setMbid

public final void setMbid(String mbid)

Specified by:

setMbid in interface MbidEntity

setPlayCount

public final void setPlayCount(Integer playCount)

Specified by:

setPlayCount in interface PlayCountEntity

setRank

public final void setRank(Integer rank)

Specified by:

setRank in interface RankEntity

getAlbums

public final List<Album> getAlbums()

getAlbum

public Album getAlbum()

Specified by:

getAlbum in interface AlbumEntity

setAlbum

public void setAlbum(Album album)

Specified by:

setAlbum in interface AlbumEntity

setAlbums

public final void setAlbums(List<Album> albums)

getArtist

public final Artist getArtist()

Specified by:

getArtist in interface ArtistEntity

setArtist

public final void setArtist(Artist artist)

Specified by:

setArtist in interface ArtistEntity

getMatch

public final Float getMatch()

setMatch

public final void setMatch(Float match)

getNowPlaying

public Boolean getNowPlaying()

Specified by:

getNowPlaying in interface NowPlayingEntity

setNowPlaying

public void setNowPlaying(Boolean nowPlaying)

Specified by:

setNowPlaying in interface NowPlayingEntity

getDuration

public final Long getDuration()

Specified by:

getDuration in interface DurationEntity

setDuration

public final void setDuration(Long duration)

Specified by:

setDuration in interface DurationEntity

getTags

public final List<Tag> getTags()

setTags

public final void setTags(List<Tag> tags)

getWiki

public final Wiki getWiki()

setWiki

public final void setWiki(Wiki wiki)

getId

public final Long getId()

Specified by:

getId in interface IdEntity

setId

public final void setId(Long id)

Specified by:

setId in interface IdEntity

getUserPlayCount

public final Integer getUserPlayCount()

Specified by:

getUserPlayCount in interface UserPlayCountEntity

setUserPlayCount

public final void setUserPlayCount(Integer userPlayCount)

Specified by:

setUserPlayCount in interface UserPlayCountEntity

getInfo

public static UnauthenticatedGetQuery<Track> getInfo(String artist,
                                     String track,
                                     String mbid,
                                     String username)

Get the metadata for a track on Last.fm using the artist/track name or a musicbrainz id. TODO: autocorrect is not supported, implement userloved

Parameters:

artist - The artist name (Required (unless mbid).

track - The track name (Required (unless mbid).

mbid - The musicbrainz id for the track (Optional).

username - The username for the context of the request (Optional). If supplied, the user's playcount for this track and whether they have loved the track is included in the response.

Returns:

getSimilar

public static UnauthenticatedGetQuery<ArrayList<Track>> getSimilar(String track,
                                                   String artist,
                                                   String mbid,
                                                   Boolean autocorrect,
                                                   Integer limit)

Get the similar tracks for this track on Last.fm, based on listening data.

Parameters:

track - The track name (Optional).

artist - The artist name (Optional).

mbid - The musicbrainz id for the track (Optional).

autocorrect - Transform misspelled artist and track names into correct artist and track names, returning the correct version instead (Optional). The corrected artist and track name will be returned in the response. TODO: currently the corrected originally requested artist/trackname will NOT be returned.

limit - Maximum number of similar tracks to return (Optional).

Returns:

TODO: Using ArrayList to avoid complex generics.

scrobble

public static PostQuery<Scrobble> scrobble(String artist,
                           String track,
                           Long startTime,
                           String album,
                           Integer trackNumber,
                           String mbid,
                           String albumArtist,
                           Long duration,
                           String sessionKey)

Used to add a track-play to a user's profile.

Parameters:

artist - The artist name (Required).

track - The track name (Required).

startTime - The time the track started playing in UNIX timestamp format in milliseconds (Required).

album - The album name (Optional).

trackNumber - The track number of the track on the album (Optional).

mbid - The MusicBrainz Track ID (Optional).

albumArtist - The album artist - if this differs from the track artist (Optional).

duration - The length of the track in milliseconds (Optional).

sessionKey - A session key generated by authenticating a user via the authentication protocol.