MusicEntry.java

/*
 * Copyright (c) 2010, the Last.fm Java Project and Committers
 * All rights reserved.
 *
 * Redistribution and use of this software in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer in the documentation and/or other
 *   materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package de.umass.lastfm;

import de.umass.xml.DomElement;

import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.Locale;

/**
 * <code>MusicEntry</code> is the abstract superclass for {@link Track}, {@link Artist} and {@link Album}. It encapsulates data and provides
 * methods used in all subclasses, for example: name, playcount, images and more.
 *
 * @author Janni Kovacs
 */
public abstract class MusicEntry extends ImageHolder {

	private static final DateFormat DATE_FORMAT = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss ZZZZ",
			Locale.ENGLISH);

	protected String name;
	protected String url;
	protected String mbid;
	protected int playcount;
	protected int userPlaycount;
	protected int listeners;
	protected boolean streamable;
	protected String id;

	/**
	 * This property is only available on hype charts, like {@link Chart#getHypedArtists(String)} or {@link
	 * de.umass.lastfm.Group#getHype(String, String)}
	 */
	protected int percentageChange;

	protected Collection<String> tags = new ArrayList<String>();
	private Date wikiLastChanged;
	private String wikiSummary;
	private String wikiText;

	protected MusicEntry(String name, String url) {
		this(name, url, null, -1, -1, false);
	}

	protected MusicEntry(String name, String url, String mbid, int playcount, int listeners, boolean streamable) {
		this.name = name;
		this.url = url;
		this.mbid = mbid;
		this.playcount = playcount;
		this.listeners = listeners;
		this.streamable = streamable;
	}

	public int getListeners() {
		return listeners;
	}

	public String getMbid() {
		return mbid;
	}

	public String getName() {
		return name;
	}

	public String getId() {
		return id;
	}

	public int getPlaycount() {
		return playcount;
	}

	public int getUserPlaycount() {
		return userPlaycount;
	}

	public boolean isStreamable() {
		return streamable;
	}

	public String getUrl() {
		return url;
	}

	public Collection<String> getTags() {
		return tags;
	}

	/**
	 * Returns the value of the "percentage change" fields in weekly hype charts responses, such as in {@link Group#getHype(String, String)}
	 * or {@link Chart#getHypedArtists(String)}.
	 *
	 * @return Weekly percentage change
	 */
	public int getPercentageChange() {
		return percentageChange;
	}

	/**
	 * Loads all generic information from an XML <code>DomElement</code> into the given <code>MusicEntry</code> instance, i.e. the following
	 * tags:<br/> <ul> <li>playcount/plays</li> <li>listeners</li> <li>streamable</li> <li>name</li> <li>url</li> <li>mbid</li> <li>image</li>
	 * <li>tags</li> </ul>
	 *
	 * @param entry An entry
	 * @param element XML source element
	 */
	protected static void loadStandardInfo(MusicEntry entry, DomElement element) {
		// playcount & listeners
		DomElement statsChild = element.getChild("stats");
		String playcountString;
		String userPlaycountString;
		String listenersString;
		if (statsChild != null) {
			playcountString = statsChild.getChildText("playcount");
			userPlaycountString = statsChild.getChildText("userplaycount");
			listenersString = statsChild.getChildText("listeners");
		} else {
			playcountString = element.getChildText("playcount");
			userPlaycountString = element.getChildText("userplaycount");
			listenersString = element.getChildText("listeners");
		}
		if (element.hasChild("id")) {
			entry.id = element.getChildText("id");
		}
		// percentagechange in getHype() responses
		if (element.hasChild("percentagechange")) {
			entry.percentageChange = Integer.parseInt(element.getChildText("percentagechange"));
		}
		int playcount = playcountString == null || playcountString.length() == 0 ? -1 : Integer
				.parseInt(playcountString);
		int userPlaycount = userPlaycountString == null || userPlaycountString.length() == 0 ? -1 : Integer
				.parseInt(userPlaycountString);
		int listeners = listenersString == null || listenersString.length() == 0 ? -1 : Integer
				.parseInt(listenersString);
		// streamable
		String s = element.getChildText("streamable");
		boolean streamable = s != null && s.length() != 0 && Integer.parseInt(s) == 1;
		// copy
		entry.name = element.getChildText("name");
		entry.url = element.getChildText("url");
		entry.mbid = element.getChildText("mbid");
		entry.playcount = playcount;
		entry.userPlaycount = userPlaycount;
		entry.listeners = listeners;
		entry.streamable = streamable;
		// tags
		DomElement tags = element.getChild("tags");
		if (tags == null)
			tags = element.getChild("toptags");
		if (tags != null) {
			for (DomElement tage : tags.getChildren("tag")) {
				entry.tags.add(tage.getChildText("name"));
			}
		}
		// wiki
		DomElement wiki = element.getChild("bio");
		if (wiki == null)
			wiki = element.getChild("wiki");
		if (wiki != null) {
			String publishedText = wiki.getChildText("published");
			try {
				entry.wikiLastChanged = DATE_FORMAT.parse(publishedText);
			} catch (ParseException e) {
				// try parsing it with current locale
				try {
					DateFormat clFormat = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss ZZZZ", Locale.getDefault());
					entry.wikiLastChanged = clFormat.parse(publishedText);
				} catch (ParseException e2) {
					// cannot parse date, wrong locale. wait for last.fm to fix.
				}
			}
			entry.wikiSummary = wiki.getChildText("summary");
			entry.wikiText = wiki.getChildText("content");
		}
		// images
		ImageHolder.loadImages(entry, element);
	}

	public Date getWikiLastChanged() {
		return wikiLastChanged;
	}

	public String getWikiSummary() {
		return wikiSummary;
	}

	public String getWikiText() {
		return wikiText;
	}
}