cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/metadata/CdmMetaData.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10
  11 package eu.etaxonomy.cdm.model.metadata;
  12
  13 import java.util.ArrayList;
  14 import java.util.Comparator;
  15 import java.util.List;
  16
  17 import javax.persistence.Entity;
  18
  19 import org.apache.log4j.Logger;
  20 import org.joda.time.DateTime;
  21
  22 import eu.etaxonomy.cdm.common.monitor.IProgressMonitor;
  23 import eu.etaxonomy.cdm.model.common.CdmBase;
  24
  25 /**
  26  * @author a.mueller
  27  * @created 07.09.2009
  28  */
  29 @Entity
  30 public class CdmMetaData extends CdmBase{
  31         private static final long serialVersionUID = -3033376680593279078L;
  32         @SuppressWarnings("unused")
  33         private static final Logger logger = Logger.getLogger(CdmMetaData.class);
  34
  35         /* It is a little bit confusing that this specific information is located in
  36          * a generic class for metadata. Think about moving the schema version
  37          *
  38          */
  39         /**
  40          * The database schema version number.
  41          * It is recommended to have the first two numbers equal to the CDM Library version number.
  42          * But it is not obligatory as there may be cases when the library number changes but the
  43          * schema version is not changing.
  44          * The third should be incremented if the schema changes in a way that SCHEMA_VALIDATION.UPDATE
  45          * will probably not work or will not be enough to transform old data into new data.
  46          * The fourth number should be incremented when minor schema changes take place that can
  47          * be handled by SCHEMA_VALIDATION.UPDATE
  48          * The last number represents the date of change.
  49          */
  50 //      private static final String dbSchemaVersion = "3.0.1.0.201104190000";
  51 //      private static final String dbSchemaVersion = "3.3.0.0.201309240000";
  52         private static final String dbSchemaVersion = "3.3.1.0.201401140000";
  53
  54
  55
  56         /**
  57          * @return a list of default metadata objects
  58          */
  59         public static final List<CdmMetaData> defaultMetaData(){
  60                 List<CdmMetaData> result = new ArrayList<CdmMetaData>();
  61                 // schema version
  62                 result.add(new CdmMetaData(MetaDataPropertyName.DB_SCHEMA_VERSION, dbSchemaVersion));
  63                 //term version
  64                 result.add(new CdmMetaData(MetaDataPropertyName.TERMS_VERSION, termsVersion));
  65                 // database create time
  66                 result.add(new CdmMetaData(MetaDataPropertyName.DB_CREATE_DATE, new DateTime().toString()));
  67                 return result;
  68         }
  69
  70         /**
  71          * The version number for the terms loaded by the termloader (csv-files)
  72          * It is recommended to have the first two numbers equal to the CDM Library version number.
  73          *
  74          * But it is not obligatory as there may be cases when the library number changes but the
  75          * schema version is not changing.
  76          *
  77          * The third should be incremented if the terms change in a way that is not compatible
  78          * to the previous version (e.g. by changing the type of a term)
  79          *
  80          * The fourth number should be incremented when compatible term changes take place
  81          * (e.g. when new terms were added)
  82          *
  83          * The last number represents the date of change.
  84          */
  85         private static final String termsVersion = "3.3.0.0.201309010000";
  86
  87
  88         public enum MetaDataPropertyName{
  89                 DB_SCHEMA_VERSION,
  90                 TERMS_VERSION,
  91                 DB_CREATE_DATE,
  92                 DB_CREATE_NOTE;
  93
  94                 public String getSqlQuery(){
  95                         return "SELECT value FROM CdmMetaData WHERE propertyname=" + this.ordinal();
  96                 }
  97         }
  98
  99         /* END OF CONFUSION */
 100         private MetaDataPropertyName propertyName;
 101         private String value;
 102
 103
 104         /**
 105          * Method to retrieve a CDM Libraries meta data
 106          * @return
 107          */
 108         public static final List<CdmMetaData> propertyList(){
 109                 List<CdmMetaData> result = new ArrayList<CdmMetaData>();
 110                 result.add(new CdmMetaData(MetaDataPropertyName.DB_SCHEMA_VERSION, dbSchemaVersion));
 111                 result.add(new CdmMetaData(MetaDataPropertyName.TERMS_VERSION, termsVersion));
 112                 result.add(new CdmMetaData(MetaDataPropertyName.DB_CREATE_DATE, new DateTime().toString()));
 113                 return result;
 114         }
 115
 116 //********************* Constructor *********************************************/
 117
 118         /**
 119          * Simple constructor to be used by Spring
 120          */
 121         protected CdmMetaData(){
 122                 super();
 123         }
 124
 125         public CdmMetaData(MetaDataPropertyName propertyName, String value) {
 126                 super();
 127                 this.propertyName = propertyName;
 128                 this.value = value;
 129         }
 130
 131 //****************** instance methods ****************************************/
 132
 133         /**
 134          * @return the propertyName
 135          */
 136         public MetaDataPropertyName getPropertyName() {
 137                 return propertyName;
 138         }
 139
 140         /**
 141          * @param propertyName the propertyName to set
 142          */
 143         public void setPropertyName(MetaDataPropertyName propertyName) {
 144                 this.propertyName = propertyName;
 145         }
 146
 147         /**
 148          * @return the value
 149          */
 150         public String getValue() {
 151                 return value;
 152         }
 153
 154         /**
 155          * @param value the value to set
 156          */
 157         public void setValue(String value) {
 158                 this.value = value;
 159         }
 160
 161 //******************** Version comparator **********************************/
 162
 163         public static class VersionComparator implements Comparator<String>{
 164                 Integer depth;
 165                 IProgressMonitor monitor;
 166
 167                 public VersionComparator(Integer depth, IProgressMonitor monitor){
 168                         this.depth = depth;
 169                         this.monitor = monitor;
 170                 }
 171
 172                 /* (non-Javadoc)
 173                  * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
 174                  */
 175                 public int compare(String version1, String version2) {
 176                         int result = 0;
 177                         String[] version1Split = version1.split("\\.");
 178                         String[] version2Split = version2.split("\\.");
 179
 180                         if(version1Split.length == 1 || version2Split.length == 1){
 181                                 throwException("Tried to compare version but given Strings don't seem to " +
 182                                                 "contain version numbers. version1: " + version1 + ", version2:" + version2);
 183                         }
 184
 185                         if(depth != null && (version1Split.length < depth || version2Split.length < depth )){
 186                                 throwException("Desired depth can not be achieved with the given strings. depth: " + depth  + ", version1: " + version1 + ", version2:" + version2);
 187                         }
 188
 189                         int length = (depth == null ||version1Split.length < depth) ? version1Split.length : depth;
 190                         for (int i = 0; i < length; i++){
 191                                 Long version1Part = Long.valueOf(version1Split[i]);
 192                                 Long version2Part = Long.valueOf(version2Split[i]);
 193                                 int partCompare = version1Part.compareTo(version2Part);
 194                                 if (partCompare != 0){
 195                                         return partCompare;
 196                                 }
 197                         }
 198                         return result;
 199                 }
 200
 201                 private Throwable throwException(String message){
 202                         RuntimeException exception =  new RuntimeException(message);
 203                         if (monitor != null){
 204                                 monitor.warning(message, exception);
 205                         }
 206                         throw exception;
 207                 }
 208
 209         }
 210
 211         /**
 212          * Compares two version string. If version1 is higher than version2 a positive result is returned.
 213          * If both are equal 0 is returned, otherwise -1 is returned.
 214          * @see Comparator#compare(Object, Object)
 215          * @param version1
 216          * @param version2
 217          * @param depth
 218          * @param monitor
 219          * @return
 220          */
 221         public static int compareVersion(String version1, String version2, Integer depth, IProgressMonitor monitor){
 222                 VersionComparator versionComparator = new VersionComparator(depth, monitor);
 223                 return versionComparator.compare(version1, version2);
 224         }
 225
 226         public static boolean isDbSchemaVersionCompatible(String version){
 227                 return compareVersion(dbSchemaVersion, version, 3, null) == 0;
 228         }
 229
 230         public static String getDbSchemaVersion() {
 231                 return dbSchemaVersion;
 232         }
 233
 234         public static String getTermsVersion() {
 235                 return termsVersion;
 236         }
 237
 238         public static boolean isTermsVersionCompatible(String version){
 239                 return compareVersion(termsVersion, version, 3, null) == 0;
 240         }
 241
 242 }