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

import javax.xml.bind.annotation.XmlAccessorType;

import javax.xml.bind.annotation.XmlIDREF;

import org.apache.log4j.Logger;

import org.hibernate.annotations.Cascade;

import org.hibernate.annotations.CascadeType;

/**

 * above "species aggregate" by another taxon name.<BR>

 * genus can only be a species name. A type of a family name or of any

 * Moreover the designation of a particular taxon name as a type might be

 * nomenclaturally rejected or conserved. Depending on the date of publication,

 * the same typification could be rejected according to one reference and later

 * be conserved according to another reference, but a name type designation

 * Name type designations are treated as {@link TypeDesignationBase type designations}

 * and not as {@link NameRelationship name relationships}.

 * @author	m.doering

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

 */

@XmlAccessorType(XmlAccessType.FIELD)

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

    "conservedType",

})

	@XmlElement(name = "IsRejectedType")

	@XmlElement(name = "IsConservedType")

	@XmlElement(name = "TypeName")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	public static NameTypeDesignation NewInstance() {

		return new NameTypeDesignation();

	}

	/** 

	 * Class constructor: creates a new empty name type designation.

	 * 

	 * Class constructor: creates a new name type designation instance

	 * @param citationMicroReference	the string with the details describing the exact localisation within the reference

	 * @param originalNameString	the taxon name string used originally in the reference source for the new designation

	 * @param isRejectedType		the boolean flag indicating whether the competent authorities rejected

	 * @param isNotDesignated		the boolean flag indicating whether there is no name type at all for 

	 * 								<i>this</i> name type designation

	 * @see							#NameTypeDesignation()

	 * @see							TypeDesignationBase#isNotDesignated()

	protected NameTypeDesignation(TaxonNameBase typeName, NameTypeDesignationStatus status,

		this.setTypeName(typeName);

		this.setTypeStatus(status);

	}

	/**

	 * Class constructor: creates a new name type designation instance

	 * the former designation).

	 * 

	 * @param typeName				the taxon name used as a type 

	 * @param citation				the reference source for the new designation

	 * @param citationMicroReference	the string with the details describing the exact localisation within the reference

	 * @param originalNameString	the taxon name string used originally in the reference source for the new designation

	 * @param isRejectedType		the boolean flag indicating whether the competent authorities rejected

	 * 								<i>this</i> name type designation

	 * @param isConservedType		the boolean flag indicating whether the competent authorities conserved

									String originalNameString, 

									NameTypeDesignationStatus status, 

									boolean rejectedType, 

									boolean conservedType, 

									boolean isNotDesignated

								) {

		this(typeName, status, citation, citationMicroReference, originalNameString);

		this.setNotDesignated(isNotDesignated);

		this.conservedType = conservedType;

	 * @see eu.etaxonomy.cdm.model.name.TypeDesignationBase#removeType()

	 */

	@Override

	public void removeType() {

		this.typeName = null;	

	}

	 * Returns the {@link TaxonNameBase taxon name} that plays the role of the

		return this.typeName;

	 * Returns the boolean value "true" if the competent authorities decided to

	 * name type designation.

	 * @see   #isConservedType()

	 */

	 * @see  #isRejectedType()

	 */

		this.rejectedType = rejectedType;

	 * Returns the boolean value "true" if the competent authorities decided to

	 * name type designation.

	 * @see  #isConservedType()

	 */

		this.conservedType = conservedType;

	public boolean isLectoType() {

		}

	 * as the type for <i>this</i> taxon name type designation was posterior to the

	 * publication of the typified taxon name. In this case the taxon name type

//	 * @see eu.etaxonomy.cdm.model.name.ITypeDesignation#isLectoType()

//	 */

//	public boolean isLectoType() {

//		return lectoType;

//	}

//

//	/**

//	 * @see   #isLectoType()

//	 */

//	public void setLectoType(boolean lectoType) {

//		this.lectoType = lectoType;

//	}

//*********************** CLONE ********************************************************/

	/** 

	 * Clones <i>this</i> name type. This is a shortcut that enables to create

	 * a new instance that differs only slightly from <i>this</i> name type by

	 * modifying only some of the attributes.

	 * 

	 * @see eu.etaxonomy.cdm.model.name.TypeDesignationBase#clone()

	 * @see java.lang.Object#clone()

	 */

	@Override

	public Object clone() {

		NameTypeDesignation result;

		try {

			result = (NameTypeDesignation)super.clone();

			//no changes to: rejectedType, conservedType, typeName

			return result;

		} catch (CloneNotSupportedException e) {

			logger.warn("Object does not implement cloneable");

			e.printStackTrace();

			return null;

		}