cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/OrderedTermBase.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 import javax.persistence.Entity;
  13 import javax.xml.bind.annotation.XmlAccessType;
  14 import javax.xml.bind.annotation.XmlAccessorType;
  15 import javax.xml.bind.annotation.XmlElement;
  16 import javax.xml.bind.annotation.XmlSeeAlso;
  17 import javax.xml.bind.annotation.XmlType;
  18
  19 import org.apache.log4j.Logger;
  20 import org.hibernate.envers.Audited;
  21 import org.hibernate.search.annotations.Indexed;
  22
  23 import eu.etaxonomy.cdm.model.description.Modifier;
  24 import eu.etaxonomy.cdm.model.description.PresenceAbsenceTermBase;
  25 import eu.etaxonomy.cdm.model.description.State;
  26 import eu.etaxonomy.cdm.model.location.NamedArea;
  27 import eu.etaxonomy.cdm.model.location.NamedAreaLevel;
  28 import eu.etaxonomy.cdm.model.name.NomenclaturalStatusType;
  29 import eu.etaxonomy.cdm.model.name.Rank;
  30
  31 /**
  32  * @author m.doering
  33  * @version 1.0
  34  * @created 08-Nov-2007 13:06:23
  35  */
  36 @XmlAccessorType(XmlAccessType.FIELD)
  37 @XmlType(name = "OrderedTermBase", propOrder = {
  38     "orderIndex"
  39 })
  40 @XmlSeeAlso({
  41         RelationshipTermBase.class,
  42         Modifier.class,
  43         PresenceAbsenceTermBase.class,
  44         State.class,
  45         NamedArea.class,
  46         NamedAreaLevel.class,
  47         NomenclaturalStatusType.class,
  48         Rank.class
  49 })
  50 @Entity
  51 @Indexed(index = "eu.etaxonomy.cdm.model.common.DefinedTermBase")
  52 @Audited
  53 public abstract class OrderedTermBase<T extends OrderedTermBase> extends DefinedTermBase<T> implements Comparable<T> {
  54         private static final long serialVersionUID = 8000797926720467399L;
  55         @SuppressWarnings("unused")
  56         private static final Logger logger = Logger.getLogger(OrderedTermBase.class);
  57
  58         //Order index, value < 1 means that this Term is not in order yet
  59         @XmlElement(name = "OrderIndex")
  60         protected int orderIndex;
  61
  62         /**
  63          * Higher ordered terms have a lower order index,
  64          * lower ordered terms have a higher order index:
  65          * <p>
  66          * <b>a.oderIndex &lt; b.oderIndex : a &gt; b</b>
  67          * @return the order index of a term
  68          */
  69         public int getOrderIndex() {
  70                 return orderIndex;
  71         }
  72
  73         public OrderedTermBase() {
  74                 super();
  75         }
  76         public OrderedTermBase(String term, String label, String labelAbbrev) {
  77                 super(term, label, labelAbbrev);
  78         }
  79
  80         /**
  81          * Compares this OrderedTermBase with the specified OrderedTermBase for
  82          * order. Returns a negative integer, zero, or a positive integer as the
  83          * orderId of this object is greater than, equal to, or less than the
  84          * specified object. This Integer compare logic of this method is the
  85          * <b>inverse logic</b> of the the one implemented in
  86          * {@link java.lang.Comparable#compareTo(java.lang.Object)}
  87          */
  88         public int compareTo(T orderedTerm) {
  89                 int orderThat;
  90                 int orderThis;
  91                 try {
  92                         orderThat = orderedTerm.orderIndex;//OLD: this.getVocabulary().getTerms().indexOf(orderedTerm);
  93                         orderThis = orderIndex; //OLD: this.getVocabulary().getTerms().indexOf(this);
  94                 } catch (RuntimeException e) {
  95                         throw e;
  96                 }
  97                 if (orderThis > orderThat){
  98                         return -1;
  99                 }else if (orderThis < orderThat){
 100                         return 1;
 101                 }else {
 102                         return 0;
 103                 }
 104         }
 105
 106 //      public int compareTo(IdentifiableEntity o) {
 107 //              if (o instanceof OrderedTermBase){
 108 //                      return compareTo((OrderedTermBase)o);
 109 //              }else{
 110 //                      return super.compareTo(o);
 111 //              }
 112 //      }
 113
 114         /**
 115          * If this term is lower than the parameter term, true is returned, else false.
 116          * If the parameter term is null, an Exception is thrown.
 117          * @param orderedTerm
 118          * @return boolean result of the comparison
 119          */
 120         public boolean isLower(T orderedTerm){
 121                 return (this.compareTo(orderedTerm) < 0 );
 122         }
 123
 124
 125         /**
 126          * If this term is higher than the parameter term, true is returned, else false.
 127          * If the parameter term is null, an Exception is thrown.
 128          * @param orderedTerm
 129          * @return boolean result of the comparison
 130          */
 131         public boolean isHigher(T orderedTerm){
 132                 return (this.compareTo(orderedTerm) > 0 );
 133         }
 134
 135
 136         /** To be used only by OrderedTermVocabulary*/
 137         @Deprecated
 138         protected boolean decreaseIndex(OrderedTermVocabulary<T> vocabulary){
 139                 if (vocabulary.indexChangeAllowed(this) == true){
 140                         orderIndex--;
 141                         return true;
 142                 }else{
 143                         return false;
 144                 }
 145         }
 146
 147         /** To be used only by OrderedTermVocabulary*/
 148         @Deprecated
 149         protected boolean incrementIndex(OrderedTermVocabulary<T> vocabulary){
 150                 if (vocabulary.indexChangeAllowed(this) == true){
 151                         orderIndex++;
 152                         return true;
 153                 }else{
 154                         return false;
 155                 }
 156         }
 157
 158         @Override
 159         public boolean equals(Object object){
 160                 if(this == object)
 161                         return true;
 162                 if((object == null) || (!OrderedTermBase.class.isAssignableFrom(object.getClass()))) {
 163                         return false;
 164                 }else{
 165                         OrderedTermBase orderedTermBase = (OrderedTermBase)object;
 166                         if (orderedTermBase.getUuid().equals(this.getUuid())){
 167                                 return true;
 168                         }else{
 169                                 return false;
 170                         }
 171                 }
 172         }
 173 }