root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/Representation.java

/**
* 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 org.apache.log4j.Logger;
import org.hibernate.envers.Audited;
import org.hibernate.search.annotations.Field;
import org.hibernate.search.annotations.Index;
import org.hibernate.search.annotations.Indexed;

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.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

/**
 * workaround for enumerations
 * @author m.doering
 * @version 1.0
 * @created 08-Nov-2007 13:06:49
 */

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Representation", propOrder = {
    "label",
    "abbreviatedLabel"
})
@XmlRootElement(name = "Representation")
@Entity
@Indexed(index = "eu.etaxonomy.cdm.model.common.Representation")
@Audited
public class Representation extends LanguageStringBase {
        private static final long serialVersionUID = -4202420199587324532L;
        private static final Logger logger = Logger.getLogger(Representation.class);

    @XmlElement(name = "Label")
    @Field(index=Index.TOKENIZED)
        private String label;
    
    @XmlElement(name = "AbbreviatedLabel")
    @Field(index=Index.TOKENIZED)
        private String abbreviatedLabel;

        /**
         * @param text
         * @param label
         * @param lang
         * @return
         */
        public static Representation NewInstance(String text, String label, String abbreviatedLabel, Language lang){
                return new Representation(text, label, abbreviatedLabel, lang);
        }
        
        public Representation() {
                super();
        }       

        /**
         * text represents an explanation/declaration ('The name is illegitimate according to ICBN'); label a string identifier ('illegitimate name');
         * abbreviatedLabel a shortened string for the label ('nom. illeg.') 
         */
        public Representation(String text, String label, String abbreviatedLabel, Language language) {
                super(text, language);
                this.label = label;
                this.abbreviatedLabel = abbreviatedLabel;
        }

        
        public String getLabel(){
                return this.label;
        }
        public void setLabel(String label){
                this.label = label;
        }

        public String getAbbreviatedLabel(){
                return this.abbreviatedLabel;
        }
        public void setAbbreviatedLabel(String abbreviatedLabel){
                this.abbreviatedLabel = abbreviatedLabel;
        }
        
        /**
         * Returns the description of this representation
         * see {@link #getText()}
         * @return
         */
        @Transient
        public String getDescription(){
                return getText();
        }
        
        protected void setDescription(String text) {
                super.setText(text);
        }
        
        
        /* 
         * Overrides super.getText() only to document that here the Text attribute
         * should be used for a larger description of the label.
         */
        /**
         * Returns the description of this representation.
         * @see #getDescription()
         */
        @Transient
        @Override
        public String getText(){
                return super.getText();
        }
        
        
        @Override
        public String toString(){
                // we dont need the language returned too, do we? 
                return getLabel();
//              if(getLanguage()==null || getLanguage().getLabel()==null){
//                      return getLabel();
//              }else{
//                      return getLabel()+"("+ getLanguage().getLabel()+")";
//              }
        }
        
//*********************** CLONE ********************************************************/
        
        /** 
         * Clones <i>this</i> Representation. This is a shortcut that enables to create
         * a new instance that differs only slightly from <i>this</i> Representation by
         * modifying only some of the attributes.
         * 
         * @see eu.etaxonomy.cdm.model.common.LanguageStringBase#clone()
         * @see java.lang.Object#clone()
         */
        @Override
        public Object clone() {
                try{
                        Representation result = (Representation) super.clone();
                        //no changes to abbreviatedLabel and label
                        return result;
                }catch (CloneNotSupportedException e) {
                        logger.warn("Object does not implement cloneable");
                        e.printStackTrace();
                        return null;
                }
                
        }
}