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.persistence.FetchType;

import javax.persistence.ManyToOne;

import javax.xml.bind.annotation.XmlAccessorType;

import javax.xml.bind.annotation.XmlElement;

import javax.xml.bind.annotation.XmlSchemaType;

import org.hibernate.annotations.Cascade;

import org.hibernate.annotations.CascadeType;

import org.hibernate.envers.Audited;

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

import eu.etaxonomy.cdm.model.reference.ReferenceBase;

 * of a hybrid taxon name and the hybrid taxon name itself. A hybrid taxon name

 * is a {@link BotanicalName botanical taxon name} assigned to a hybrid plant following

 * the {@link NomenclaturalCode#ICBN() ICBN} (Appendix I). A hybrid taxon name must have one 

 * of the hybrid flags set. The hybrid relationship includes a {@link HybridRelationshipType hybrid relationship type}

 * (for instance "first parent" or "female parent") and the article of the ICBN

 * on which the hybrid taxon name relies.

 * This class corresponds partially to: <ul>

 * <li> Relationship according to the TDWG ontology

 * <li> TaxonRelationship according to the TCS

 * </ul>

 * 

 * @version 1.0

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

 */

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

	"relatedTo",

	"type",

})

	//the note property.

	@XmlElement(name = "RelatedFrom")

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

    @Cascade(CascadeType.SAVE_UPDATE)

	@XmlElement(name = "RelatedTo")

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

    @Cascade(CascadeType.SAVE_UPDATE)

    @XmlElement(name = "Type")

    @XmlIDREF

    @XmlSchemaType(name = "IDREF")

	private HybridRelationship(){

		super();

	 * reference and adds it to the respective

	 * {@link BotanicalName#getHybridRelationships() botanical taxon name relation sets} of both involved names.

	 * 

	 * @param toName			the taxon name to be set as target for the new hybrid relationship

	 * @param fromName			the taxon name to be set as source for the new hybrid relationship

	 * @param type				the relationship type to be assigned to the new hybrid relationship

	 * @param ruleConsidered	the string indicating the article of the ICBN for the hybrid taxon name

	 * @see						#HybridRelationship(BotanicalName, BotanicalName, HybridRelationshipType, ReferenceBase, String, String)

	 * @see						BotanicalName#addHybridRelationship(HybridRelationship)

	protected HybridRelationship(BotanicalName hybridName, BotanicalName parentName, HybridRelationshipType type, String ruleConsidered) {

	/**

	 * 

	 * @param toName				the taxon name to be set as target for the new hybrid relationship

	 * @param fromName				the taxon name to be set as source for the new hybrid relationship

	 * @param type					the relationship type to be assigned to the new hybrid relationship

	 * @param citation				the reference source for the new hybrid relationship

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

	 * @param ruleConsidered		the string indicating the article of the ICBN for the hybrid taxon name

	 * @see							#HybridRelationship(BotanicalName, BotanicalName, HybridRelationshipType, String)

	 * @see							BotanicalName#addHybridRelationship(HybridRelationship)

	protected HybridRelationship(BotanicalName  hybridName, BotanicalName parentName, HybridRelationshipType type, ReferenceBase citation, String citationMicroReference, String ruleConsidered) {

		super(parentName, hybridName, type, citation, citationMicroReference);

		this.setRuleConsidered(ruleConsidered);

	}	

	/** 

	 * Returns the {@link BotanicalName botanical taxon name} that plays the parent role

	 * @see   #getHybridName()

	 * @see  #getParentName()

	 */

	 * Returns the {@link BotanicalName botanical taxon name} that plays the child role

	 * @see   #getParentName()

	 * @see  #getHybridName()

	 */

	 * Returns the ICBN rule considered (that is the

	 * article/note/recommendation in the nomenclatural code) for building

	 * within <i>this</i> hybrid relationship.

		return this.ruleConsidered;

	}

	 * @see  #getRuleConsidered()

	 */

		this.ruleConsidered = ruleConsidered;

	}

		return relatedFrom;

	}

	protected BotanicalName getRelatedTo() {

		return relatedTo;

	}

	public HybridRelationshipType getType() {

		return type;

	}

	protected void setRelatedFrom(BotanicalName relatedFrom) {

		this.relatedFrom = relatedFrom;

	}

	protected void setRelatedTo(BotanicalName relatedTo) {

		this.relatedTo = relatedTo;

	}

	protected void setType(HybridRelationshipType type) {

		this.type = type;

	}