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

import javax.persistence.Entity;

import javax.persistence.FetchType;

import javax.persistence.ManyToOne;

import javax.xml.bind.annotation.XmlAccessType;

import javax.xml.bind.annotation.XmlAccessorType;

import javax.xml.bind.annotation.XmlElement;

import javax.xml.bind.annotation.XmlIDREF;

import javax.xml.bind.annotation.XmlSchemaType;

import javax.xml.bind.annotation.XmlType;

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

import org.hibernate.annotations.Cascade;

import org.hibernate.annotations.CascadeType;

import org.hibernate.envers.Audited;

import eu.etaxonomy.cdm.model.agent.AgentBase;

/**

 * @author a.mueller

 * @since 23.03.2009

 */

@XmlAccessorType(XmlAccessType.FIELD)

@XmlType(name = "Credit")

@Entity

@Audited

public class Credit extends LanguageStringBase {

	private static final long serialVersionUID = 5763391127298427701L;

	@SuppressWarnings("unused")

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

// ********************** FACTORY **********************************************/

    public static Credit NewInstance(AgentBase agent, TimePeriod timePeriod, String text){

        return NewInstance(agent, timePeriod, text, null, Language.DEFAULT());

    }

    public static Credit NewInstance(AgentBase agent, TimePeriod timePeriod, String text, String abbreviatedText, Language language){

        Credit result = new Credit(text, language);

        result.setAgent(agent);

        result.setAbbreviatedText(abbreviatedText);

        result.setTimePeriod(timePeriod);

        return result;

    }

// ********************** FACTORY **********************************************/

	// owner etc as defined by the rightstype

	@XmlElement(name = "Agent")

	@XmlIDREF

	@XmlSchemaType(name = "IDREF")

	@ManyToOne(fetch = FetchType.LAZY)

	@Cascade({CascadeType.SAVE_UPDATE,CascadeType.MERGE})

	private AgentBase<?> agent;

    @XmlElement(name = "TimePeriod", type= String.class)

    private TimePeriod timePeriod = TimePeriod.NewInstance();

	@XmlElement(name = "AbbreviatedText")

	private String abbreviatedText;

// ********************** CONSTRUCTOR **********************************************/

	protected Credit(){

		super();

	}

	protected Credit(String text, Language language){

		super(text, language);

	}

//*********************** GETTER /SETTER *****************************/

	public AgentBase getAgent() {

		return agent;

	}

	public void setAgent(AgentBase agent) {

		this.agent = agent;

	}

    public TimePeriod getTimePeriod() {

        return timePeriod;

    }

    public void setTimePeriod(TimePeriod timePeriod) {

        this.timePeriod = timePeriod;

    }

    public String getAbbreviatedText() {

		return abbreviatedText;

	}

	public void setAbbreviatedText(String abbreviatedText) {

		this.abbreviatedText = abbreviatedText;

	}

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

	@Override

	public Credit clone() throws CloneNotSupportedException{

	    Credit result = (Credit)super.clone();

	    if (this.timePeriod != null) {

	        result.timePeriod = this.timePeriod.clone();

	    }

		//no changes to: agent

		return result;

	}

// ************************ STRING ****************************/

    @Override

    public String toString() {

        if (isNotBlank(this.abbreviatedText)){

            return this.abbreviatedText;

        }else if (isNotBlank(this.text)){

            return this.text;

        }else{

            return super.toString();

        }

    }

}