Badge.java

package info.interactivesystems.gamificationengine.entities.rewards;

import info.interactivesystems.gamificationengine.dao.GoalDAO;
import info.interactivesystems.gamificationengine.dao.RuleDAO;
import info.interactivesystems.gamificationengine.entities.Player;
import info.interactivesystems.gamificationengine.entities.PlayerGroup;

import java.net.URL;

import javax.persistence.Column;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.Lob;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

/**
 * The badge class serves as a Reward-subclass that represents a distinct icon.
 * It should be used as a an instantly recognizable visual reference to an badge
 * a player was able to reach. A badge is a permanent reward, so a player can
 * award a specific badge only once.
 */
@Entity
@DiscriminatorValue("RewBadge")
@JsonIgnoreProperties({ "belongsTo", "imageIcon" })
public class Badge extends PermanentReward {


	private URL iconURL;

	@Lob
	@Column(columnDefinition = "BLOB")
	private byte[] imageIcon;



	/**
	 * Gets the URL of the badge's icon, when it was created.
	 * 
	 * @return The URL of the associated icon.
	 */
	public URL getIconURL() {
		return iconURL;
	}

	/**
	 * Sets the URL value of the badge's icon, when it was created.
	 * 
	 * @param icon
	 *            The URL of the associated icon.
	 */
	public void setIconURL(URL icon) {
		this.iconURL = icon;
	}

	/**
	 * Gets the badge's icon as byte[].
	 * 
	 * @return Byte[] of the badge's icon that is stored in the database.
	 */
	public byte[] getImageIcon() {
		return imageIcon;
	}

	/**
	 * Sets the byte[] as an icon of a badge that is stored in the database.
	 * 
	 * @param icon
	 *            The icon that should be connected with the badge as byte[].
	 */
	public void setImageIcon(byte[] icon) {
		imageIcon = icon;
	}

	/**
	 * With this method the player awards an badge if she/he hasn't awarded it, yet. 
	 * Therefore the badge is added to her/his list of permanent rewards.
	 * 
	 * @param player
	 *            The player who should award the badge. This parameter must
	 *            not be null.
	 * @param goalDao
	 *            The goal DAO is required to access created goals. 
	 * @param ruleDao
	 *            The rule DAO is required to access the created rules. 
	 */
	@Override
	public void addReward(Player player, GoalDAO goalDao, RuleDAO ruleDao) {
		if(!player.getRewards().contains(this)){
			player.addPermanentReward(this);
		}
	}

	/**
	 * With this method a group awards an badge and adds it to the list with permanent
	 * rewards, but only if this badge isn't already in the list of permanent rewards.
	 * 
	 * @param group
	 *            The group of players which should award the badge. This 
	 *            parameter must not be null.
	 * @param goalDao
	 *            The goal DAO is required to access created goals. 
	 * @param ruleDao
	 *            The rule DAO is required to access the created rules. 
	 */
	@Override
	public void addReward(PlayerGroup group, GoalDAO goalDao, RuleDAO ruleDao) {
		if(!group.getRewards().contains(this)){
			group.addPermanentReward(this);
		}
	}
}