cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/ReferencedEntityBase.java

   1 /**
   2 * Copyright (C) 2007 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9
  10 package eu.etaxonomy.cdm.model.common;
  11
  12
  13 import javax.persistence.FetchType;
  14 import javax.persistence.ManyToOne;
  15 import javax.persistence.MappedSuperclass;
  16 import javax.xml.bind.annotation.XmlAccessType;
  17 import javax.xml.bind.annotation.XmlAccessorType;
  18 import javax.xml.bind.annotation.XmlElement;
  19 import javax.xml.bind.annotation.XmlIDREF;
  20 import javax.xml.bind.annotation.XmlRootElement;
  21 import javax.xml.bind.annotation.XmlSchemaType;
  22 import javax.xml.bind.annotation.XmlType;
  23
  24 import org.apache.log4j.Logger;
  25 import org.hibernate.annotations.Cascade;
  26 import org.hibernate.annotations.CascadeType;
  27 import org.hibernate.envers.Audited;
  28
  29 import eu.etaxonomy.cdm.model.reference.Reference;
  30
  31 /**
  32  * abstract class for all objects that may have a reference
  33  * @author m.doering
  34  * @version 1.0
  35  * @created 08-Nov-2007 13:06:47
  36  */
  37 @XmlAccessorType(XmlAccessType.FIELD)
  38 @XmlType(name = "ReferencedEntityBase", propOrder = {
  39     "citationMicroReference",
  40     "originalNameString",
  41     "citation"
  42 })
  43 @XmlRootElement(name = "ReferencedEntityBase")
  44 @MappedSuperclass
  45 @Audited
  46 public abstract class ReferencedEntityBase extends AnnotatableEntity implements IReferencedEntity {
  47         private static final long serialVersionUID = -5614669050360359126L;
  48         @SuppressWarnings("unused")
  49         private static final Logger logger = Logger.getLogger(ReferencedEntityBase.class);
  50
  51         //Details of the reference. These are mostly (implicitly) pages but can also be tables or any other element of a
  52         //publication. {if the citationMicroReference exists then there must be also a reference}
  53     @XmlElement(name = "Citation")
  54     @XmlIDREF
  55     @XmlSchemaType(name = "IDREF")
  56     @ManyToOne(fetch = FetchType.LAZY)
  57     @Cascade({CascadeType.SAVE_UPDATE,CascadeType.MERGE})
  58         private Reference<?> citation;
  59
  60     @XmlElement(name = "CitationMicroReference")
  61         private String citationMicroReference;
  62
  63     @XmlElement(name = "OriginalNameString")
  64         private String originalNameString;
  65
  66         public ReferencedEntityBase() {
  67                 super();
  68         }
  69
  70
  71         public ReferencedEntityBase(Reference citation, String citationMicroReference,
  72                         String originalNameString) {
  73                 super();
  74                 this.citationMicroReference = citationMicroReference;
  75                 this.originalNameString = originalNameString;
  76                 this.citation = citation;
  77         }
  78
  79         public String getCitationMicroReference(){
  80                 return this.citationMicroReference;
  81         }
  82         public void setCitationMicroReference(String citationMicroReference){
  83                 this.citationMicroReference = citationMicroReference;
  84         }
  85
  86
  87         public String getOriginalNameString(){
  88                 return this.originalNameString;
  89         }
  90         public void setOriginalNameString(String originalNameString){
  91                 this.originalNameString = originalNameString;
  92         }
  93
  94         public Reference getCitation(){
  95                 return this.citation;
  96         }
  97         public void setCitation(Reference citation) {
  98                 this.citation = citation;
  99         }
 100
 101 //****************** CLONE ************************************************/
 102
 103         /* (non-Javadoc)
 104          * @see java.lang.Object#clone()
 105          */
 106         @Override
 107         public Object clone() throws CloneNotSupportedException{
 108                 ReferencedEntityBase result = (ReferencedEntityBase)super.clone();
 109
 110                 //no changes to: citation, citationMicroReference, originalNameString
 111                 return result;
 112         }
 113
 114 }