Term.java

/*
 * This file is part of gwap, an open platform for games with a purpose
 *
 * Copyright (C) 2013
 * Project play4science
 * Lehr- und Forschungseinheit für Programmier- und Modellierungssprachen
 * Ludwig-Maximilians-Universität München
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package gwap.model.resource;

import gwap.model.Source;
import gwap.model.Tag;

import java.util.ArrayList;
import java.util.List;

import javax.persistence.Entity;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToOne;
import javax.persistence.OrderBy;

import org.hibernate.validator.NotNull;
import org.jboss.seam.ScopeType;
import org.jboss.seam.annotations.Name;
import org.jboss.seam.annotations.Scope;

@NamedQueries({
	@NamedQuery(name="term.random", 
			query="select p from Term p where p.enabled = true and p.tag.language = :language order by random()"),
	@NamedQuery(name="term.randomCustom", 
			query="select p from Term p where p.enabled = true and p.tag.language = :language and p.source = :source order by random()"),
	@NamedQuery(name="term.randomByLevel", 
				query="select p from Term p where p.enabled = true and p.rating = :level and p.tag.language = :language order by random()"),
	@NamedQuery(name="term.randomByLevelCustom", 
				query="select p from Term p where p.enabled = true and p.rating = :level and p.tag.language = :language and p.source = :source order by random()"),
	@NamedQuery(name="term.randomByLevelNotInGameSession", 
				query="select p from Term p where p.enabled = true and p.rating = :level and p.tag.language = :language " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"order by random()"),
	@NamedQuery(name="term.randomByLevelNotInGameSessionCustom", 
				query="select p from Term p where p.enabled = true and p.rating = :level and p.tag.language = :language and p.source = :source " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"order by random()"),
	@NamedQuery(name="term.randomNotInGameSession", 
				query="select p from Term p where p.enabled = true and p.tag.language = :language " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"order by random()"),
	@NamedQuery(name="term.randomNotInGameSessionCustom", 
				query="select p from Term p where p.enabled = true and p.tag.language = :language and p.source = :source " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
							"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGame", 
				query="select p from Term p where p.enabled = true and p.rating = :level and p.tag.language = :language " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"and (select count(*) from p.confirmedTags) >= :minConfirmedTags " +
						"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGameCustom", 
				query="select p from Term p where p.enabled = true and p.rating = :level and p.tag.language = :language and p.source = :source " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"and (select count(*) from p.confirmedTags) >= :minConfirmedTags " +
						"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGameAnyLevel", 
				query="select p from Term p where p.enabled = true and p.tag.language = :language " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"and (select count(*) from p.confirmedTags) >= :minConfirmedTags " +
						"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGameAnyLevelCustom", 
				query="select p from Term p where p.enabled = true and p.tag.language = :language and p.source = :source " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"and (select count(*) from p.confirmedTags) >= :minConfirmedTags " +
						"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGameWithTopic", 
				query="select p from Term p join p.topics t where p.enabled = true and t = :topic and p.rating = :level and p.tag.language = :language " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"and (select count(*) from p.confirmedTags) >= :minConfirmedTags " +
						"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGameWithTopicCustom", 
				query="select p from Term p join p.topics t where p.enabled = true and t = :topic and p.rating = :level and p.tag.language = :language and p.source = :source " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"and (select count(*) from p.confirmedTags) >= :minConfirmedTags " +
						"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGameWithTopicAnyLevel", 
				query="select p from Term p join p.topics t where p.enabled = true and t = :topic and p.tag.language = :language " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"and (select count(*) from p.confirmedTags) >= :minConfirmedTags " +
						"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGameWithTopicAnyLevelCustom", 
				query="select p from Term p join p.topics t where p.enabled = true and t = :topic and p.tag.language = :language and p.source = :source " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"and (select count(*) from p.confirmedTags) >= :minConfirmedTags " +
						"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGameWithoutConfig", 
				query="select p from Term p where p.enabled = true and p.tag.language = :language " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"order by random()"),
	@NamedQuery(name="term.sensibleRandomForGameWithoutConfigCustom", 
				query="select p from Term p where p.enabled = true and p.tag.language = :language and p.source = :source " +
						"and not exists (from Term r2 join r2.gameRounds r where r.gameSession=:gameSession and r2=p) " +
						"order by random()"),
	@NamedQuery(name="term.randomByTopic", 
				query="select p from Term p join p.topics t where p.enabled = true and t = :topic and p.tag.language = :language order by random()"),
	@NamedQuery(name="term.randomByTopicCustom", 
				query="select p from Term p join p.topics t where p.enabled = true and t = :topic and p.tag.language = :language and p.source = :source order by random()"),
	@NamedQuery(name="term.randomTagsNotRelated", 
				query="select t from Term p join p.confirmedTags t where p.enabled = true and p != :term and t.language = :language " +
						"order by random()"),					
	@NamedQuery(name="term.randomTagsNotRelatedCustom", 
				query="select t from Term p join p.confirmedTags t where p.enabled = true and p != :term and t.language = :language and p.source = :source " +
						"order by random()"),					
	@NamedQuery(name = "term.allTerms",
				query = "select t from Term t join t.tag g order by g.name"),			
	@NamedQuery(name = "term.allTermsCustom",
				query = "select t from Term t join t.tag g where t.source = :source order by g.name"),			
	@NamedQuery(name="term.byExternalSessionId", 
				query="select t from Term t join t.gameRounds r join r.gameSession s " +
						"where s.externalSessionId=:externalSessionId " +
						"group by t.id, t.externalId, t.enabled, t.tag, t.rating, r.number order by r.number"),
	@NamedQuery(name = "term.byName",
				query = "from Term t where t.tag.name = :termName")
})
@Entity
@Name("term")
@Scope(ScopeType.CONVERSATION)
public class Term extends Resource {

	private static final long serialVersionUID = 0L;

	@NotNull
	@OneToOne
	private Tag tag;

	private Integer rating;
	
	@ManyToMany
	@OrderBy("name")
	private List<Tag> confirmedTags = new ArrayList<Tag>();

	@ManyToMany
	@JoinTable(name="term_rejectedtag")
	@OrderBy("name")
	private List<Tag> rejectedTags = new ArrayList<Tag>();
	
	@ManyToOne
	private Source source;

	public Term() {
	}

	public Tag getTag() {
		return tag;
	}

	public void setTag(Tag tag) {
		this.tag = tag;
	}

	public List<Tag> getConfirmedTags() {
		return confirmedTags;
	}

	public void setConfirmedTags(List<Tag> confirmedTags) {
		this.confirmedTags = confirmedTags;
	}

	public List<Tag> getRejectedTags() {
		return rejectedTags;
	}

	public void setRejectedTags(List<Tag> rejectedTags) {
		this.rejectedTags = rejectedTags;
	}

	public Integer getRating() {
		return rating;
	}

	public void setRating(Integer rating) {
		this.rating = rating;
	}
	
	public Source getSource() {
		return source;
	}

	public void setSource(Source source) {
		this.source = source;
	}

	public String toString() {
		return "Term#" + tag.getId() + "[name=" + tag.getName() + "]";
	}

}