EDIT

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy 

* http://www.e-taxonomy.eu

* 

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.model.description;

import eu.etaxonomy.cdm.model.location.NamedArea;

import eu.etaxonomy.cdm.model.taxon.Taxon;

import org.apache.log4j.Logger;

import org.hibernate.annotations.Cascade;

import org.hibernate.annotations.CascadeType;

import java.util.*;

import javax.persistence.*;

import javax.xml.bind.annotation.XmlAccessType;

import javax.xml.bind.annotation.XmlAccessorType;

import javax.xml.bind.annotation.XmlElement;

import javax.xml.bind.annotation.XmlElementWrapper;

import javax.xml.bind.annotation.XmlRootElement;

import javax.xml.bind.annotation.XmlTransient;

import javax.xml.bind.annotation.XmlType;

/**

 * A description that delimits this taxon.

 * Equivalent to TCS /DataSet/TaxonConcepts/TaxonConcept/CharacterCircumscription 

 * 

 * @author m.doering

 * @version 1.0

 * @created 08-Nov-2007 13:06:20

 */

@XmlAccessorType(XmlAccessType.FIELD)

@XmlType(name = "TaxonDescription", propOrder = {

    "scopes",

    "geoScopes"

})

@Entity

public class TaxonDescription extends DescriptionBase {

	static Logger logger = Logger.getLogger(TaxonDescription.class);

	@XmlElementWrapper(name = "Scopes")

	@XmlElement(name = "Scope")

	private Set<Scope> scopes = new HashSet<Scope>();

	@XmlElementWrapper( name = "GeoScopes")

	@XmlElement( name = "GeoScope")

	private Set<NamedArea> geoScopes = new HashSet<NamedArea>();

	@XmlTransient

	private Taxon taxon;

	public static TaxonDescription NewInstance(){

		return new TaxonDescription();

	}

	public static TaxonDescription NewInstance(Taxon taxon){

		TaxonDescription description = new TaxonDescription();

		taxon.addDescription(description);

		return description;

	}

	public TaxonDescription(){

		super();

	}

	@OneToMany

	@Cascade({CascadeType.SAVE_UPDATE})

	public Set<NamedArea> getGeoScopes(){

		return this.geoScopes;

	}

	protected void setGeoScopes(Set<NamedArea> geoScopes){

		this.geoScopes = geoScopes;

	}

	public void addGeoScope(NamedArea geoScope){

		this.geoScopes.add(geoScope);

	}

	public void removeGeoScope(NamedArea geoScope){

		this.geoScopes.remove(geoScope);

	}

	@OneToMany

	public Set<Scope> getScopes(){

		return this.scopes;

	}

	protected void setScopes(Set<Scope> scopes){

		this.scopes = scopes;

	}

	public void addScope(Scope scope){

		this.scopes.add(scope);

	}

	public void removeScope(Scope scope){

		this.scopes.remove(scope);

	}

	@ManyToOne

	@JoinColumn(name="taxon_fk")

	@Cascade(CascadeType.SAVE_UPDATE)

	public Taxon getTaxon() {

		return taxon;

	}

	@Deprecated //for hibernate use only, use taxon.addDescription() instead

	protected void setTaxon(Taxon taxon) {

		this.taxon = taxon;

	}

}