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.location;

import java.util.HashMap;

import java.util.HashSet;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.UUID;

import javax.persistence.Entity;

import javax.persistence.FetchType;

import javax.persistence.JoinTable;

import javax.persistence.ManyToMany;

import javax.persistence.ManyToOne;

import javax.persistence.Transient;

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.XmlIDREF;

import javax.xml.bind.annotation.XmlRootElement;

import javax.xml.bind.annotation.XmlSchemaType;

import javax.xml.bind.annotation.XmlSeeAlso;

import javax.xml.bind.annotation.XmlType;

import org.apache.log4j.Logger;

import org.hibernate.annotations.Cascade;

import org.hibernate.annotations.CascadeType;

import org.hibernate.envers.Audited;

import eu.etaxonomy.cdm.hibernate.HibernateProxyHelper;

import eu.etaxonomy.cdm.model.common.DefinedTermBase;

import eu.etaxonomy.cdm.model.common.OrderedTermBase;

import eu.etaxonomy.cdm.model.common.TermVocabulary;

import eu.etaxonomy.cdm.model.common.TimePeriod;

import eu.etaxonomy.cdm.model.media.Media;

/**

 * @author m.doering

 * @version 1.0

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

 */

@XmlAccessorType(XmlAccessType.PROPERTY)

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

	"kindOf",

	"generalizationOf",

	"partOf",

	"includes",

    "validPeriod",

    "shape",

    "pointApproximation",

    "waterbodiesOrCountries",

    "type",

    "level"

})

@XmlRootElement(name = "NamedArea")

@XmlSeeAlso({

	TdwgArea.class,

	Continent.class,

	WaterbodyOrCountry.class

})

@Entity

@Audited

public class NamedArea extends OrderedTermBase<NamedArea> {

	private static final long serialVersionUID = 6248434369557403036L;

	private static final Logger logger = Logger.getLogger(NamedArea.class);

	protected static Map<UUID, NamedArea> termMap = null;		

	//description of time valid context of this area. e.g. year range

	private TimePeriod validPeriod = TimePeriod.NewInstance();

	//Binary shape definition for user's defined area as polygon

	@ManyToOne(fetch = FetchType.LAZY)

	@Cascade(CascadeType.SAVE_UPDATE)

	private Media shape;

	private Point pointApproximation;

	@ManyToMany(fetch = FetchType.LAZY)

    @JoinTable(name="DefinedTermBase_WaterbodyOrCountry")

	private Set<WaterbodyOrCountry> waterbodiesOrCountries = new HashSet<WaterbodyOrCountry>();

	@ManyToOne(fetch = FetchType.LAZY)

	private NamedAreaType type;

	@ManyToOne(fetch = FetchType.LAZY)

	private NamedAreaLevel level;

	/**

	 * Factory method

	 * @return

	 */

	public static NamedArea NewInstance(){

		logger.debug("NewInstance");

		return new NamedArea();

	}

	/**

	 * Factory method

	 * @return

	 */

	public static NamedArea NewInstance(String term, String label, String labelAbbrev){

		return new NamedArea(term, label, labelAbbrev);

	}

	/**

	 * Constructor

	 */

	public NamedArea() {

	}

	public NamedArea(String term, String label, String labelAbbrev) {

		super(term, label, labelAbbrev);

	}

	@XmlElement(name = "NamedAreaType")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	public NamedAreaType getType(){

		return this.type;

	}

	public void setType(NamedAreaType type){

		this.type = type;

	}

	@XmlElement(name = "NamedAreaLevel")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	public NamedAreaLevel getLevel(){

		return this.level;

	}

	public void setLevel(NamedAreaLevel level){

		this.level = level;

	}

	@XmlElement(name = "ValidPeriod")

	public TimePeriod getValidPeriod(){

		return this.validPeriod;

	}

	public void setValidPeriod(TimePeriod validPeriod){

		this.validPeriod = validPeriod;

	}

	@XmlElement(name = "Shape")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	public Media getShape(){

		return this.shape;

	}

	public void setShape(Media shape){

		this.shape = shape;

	}

	@XmlElementWrapper(name = "WaterbodiesOrCountries")

	@XmlElement(name = "WaterbodiesOrCountry")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	public Set<WaterbodyOrCountry> getWaterbodiesOrCountries() {

		return waterbodiesOrCountries;

	}

	public void addWaterbodyOrCountry(WaterbodyOrCountry waterbodyOrCountry) {

		this.waterbodiesOrCountries.add(waterbodyOrCountry);

	}

	public void removeWaterbodyOrCountry(WaterbodyOrCountry waterbodyOrCountry) {

		this.waterbodiesOrCountries.remove(waterbodyOrCountry);

	}

	@XmlElement(name = "PointApproximation")

	public Point getPointApproximation() {

		return pointApproximation;

	}

	public void setPointApproximation(Point pointApproximation) {

		this.pointApproximation = pointApproximation;

	}

	@XmlElement(name = "KindOf", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

	public NamedArea getKindOf(){

		return super.getKindOf();

	}

	public void setKindOf(NamedArea kindOf){

		super.setKindOf(kindOf);

	}

	@XmlElement(name = "PartOf", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

	@XmlIDREF

    @XmlSchemaType(name = "IDREF")

	public NamedArea getPartOf(){

		return partOf;

	}

	/**

	 * FIXME this method is a workaround for a casting problem in the getPartOf implementation

	 * 

	 * the partOf instance variable is typically a proxy object of type DefinedTermBase, thus

	 * does not coincide with the return value of NamedArea and a ClassCastException is thrown.

	 * 

	 * It is not clear why this only occurs in the editor and not in the webservice where the same

	 * method gets called and should lead to the same results.

	 * 

	 * Seems to be a bigger problem although its origin is buggy behaviour of the javassist implementation.

	 */

	@Deprecated

	@Transient

	public NamedArea getPartOfWorkaround(){

		Object area = super.getPartOf();

		if(!(area instanceof NamedArea)){

			area = HibernateProxyHelper.deproxy(area, NamedArea.class);

		}

		return (NamedArea) area;

	}

	public void setPartOf(NamedArea partOf){

		this.partOf = partOf;

	}

	@XmlElementWrapper(name = "Generalizations", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

	@XmlElement(name = "GeneralizationOf", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

	public Set<NamedArea> getGeneralizationOf(){

		return super.getGeneralizationOf();

	}

	protected void setGeneralizationOf(Set<NamedArea> value){

		super.setGeneralizationOf(value);

	}

	@XmlElementWrapper(name = "Includes", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

	@XmlElement(name = "Include", namespace = "http://etaxonomy.eu/cdm/model/common/1.0")

	@XmlIDREF

    @XmlSchemaType(name = "IDREF")

	public Set<NamedArea> getIncludes(){

		return super.getIncludes();

	}

	protected void setIncludes(Set<NamedArea> includes) {

		super.setIncludes(includes);

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.cdm.model.common.DefinedTermBase#readCsvLine(java.util.List)

	 */

	@Override

	public NamedArea readCsvLine(Class<NamedArea> termClass, List<String> csvLine, Map<UUID,DefinedTermBase> terms) {

		NamedArea newInstance = super.readCsvLine(termClass, csvLine, terms);

		String levelString = (String)csvLine.get(6);

		if(levelString != null && levelString.length() != 0) {

			UUID levelUuid = UUID.fromString(levelString);

			NamedAreaLevel level = (NamedAreaLevel)terms.get(levelUuid);

			newInstance.setLevel(level);

		}

		String partOfString = (String)csvLine.get(7);

		if(partOfString != null && partOfString.length() != 0) {

			UUID partOfUuid = UUID.fromString(partOfString);

			NamedArea partOf = (NamedArea)terms.get(partOfUuid);

			partOf.addIncludes(newInstance);

		} 

		return newInstance;

	}

	@Override

	protected void setDefaultTerms(TermVocabulary<NamedArea> termVocabulary) {

		termMap = new HashMap<UUID, NamedArea>();

		for (NamedArea term : termVocabulary.getTerms()){

			termMap.put(term.getUuid(), term);

		}

	}

}