changed strategy for media with no title a bit
[cdmlib.git] / cdmlib-model / src / main / java / eu / etaxonomy / cdm / model / media / Media.java
index 47836e54035e47018dc15fd7f49889aefc604e0f..254ceeaef1a9498cd42dcf0f4e4d169fb2e25511 100644 (file)
@@ -9,10 +9,17 @@
 
 package eu.etaxonomy.cdm.model.media;
 
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.SortedMap;
+import java.util.TreeMap;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 import javax.persistence.Basic;
 import javax.persistence.Entity;
@@ -22,6 +29,8 @@ import javax.persistence.InheritanceType;
 import javax.persistence.JoinTable;
 import javax.persistence.ManyToOne;
 import javax.persistence.OneToMany;
+import javax.persistence.Transient;
+import javax.validation.constraints.NotNull;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
@@ -39,6 +48,7 @@ import org.hibernate.annotations.Type;
 import org.hibernate.envers.Audited;
 import org.hibernate.search.annotations.Indexed;
 import org.hibernate.search.annotations.IndexedEmbedded;
+import org.hibernate.validator.constraints.NotEmpty;
 import org.joda.time.DateTime;
 
 import eu.etaxonomy.cdm.jaxb.DateTimeAdapter;
@@ -47,6 +57,9 @@ import eu.etaxonomy.cdm.model.agent.AgentBase;
 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
 import eu.etaxonomy.cdm.model.common.Language;
 import eu.etaxonomy.cdm.model.common.LanguageString;
+import eu.etaxonomy.cdm.model.common.MultilanguageTextHelper;
+import eu.etaxonomy.cdm.strategy.cache.media.MediaDefaultCacheStrategy;
+import eu.etaxonomy.cdm.validation.Level2;
 
 /**
  * A {@link Media media} is any kind of media that represents a media object. 
@@ -65,7 +78,6 @@ import eu.etaxonomy.cdm.model.common.LanguageString;
     "mediaCreated",
     "description",
     "representations",
-    "rights",
     "artist"
 })
 @XmlRootElement(name = "Media")
@@ -83,7 +95,9 @@ public class Media extends IdentifiableEntity implements Cloneable {
     @XmlJavaTypeAdapter(MultilanguageTextAdapter.class)
     @OneToMany(fetch = FetchType.LAZY)
     @IndexedEmbedded
-    @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE,CascadeType.DELETE})
+    @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE,CascadeType.DELETE, CascadeType.DELETE_ORPHAN, CascadeType.REFRESH})
+    @NotNull
+    @NotEmpty(groups = Level2.class)
        private Map<Language,LanguageString> title = new HashMap<Language,LanguageString>();
        
        //creation date of the media (not of the record) 
@@ -100,7 +114,8 @@ public class Media extends IdentifiableEntity implements Cloneable {
     @OneToMany(fetch = FetchType.LAZY)
     @IndexedEmbedded
     @JoinTable(name = "Media_Description")
-    @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE,CascadeType.DELETE})
+    @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE,CascadeType.DELETE,CascadeType.DELETE_ORPHAN, CascadeType.REFRESH})
+    @NotNull
        private Map<Language,LanguageString> description = new HashMap<Language,LanguageString>();
        
        //A single medium such as a picture can have multiple representations in files. 
@@ -108,7 +123,9 @@ public class Media extends IdentifiableEntity implements Cloneable {
        @XmlElementWrapper(name = "MediaRepresentations")
        @XmlElement(name = "MediaRepresentation")
        @OneToMany(mappedBy="media",fetch = FetchType.LAZY)
-       @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE, CascadeType.DELETE})
+       @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE, CascadeType.DELETE, CascadeType.DELETE_ORPHAN, CascadeType.REFRESH})
+       @NotNull
+       @NotEmpty(groups = Level2.class)
        private Set<MediaRepresentation> representations = new HashSet<MediaRepresentation>();
        
        @XmlElement(name = "Artist")
@@ -119,23 +136,52 @@ public class Media extends IdentifiableEntity implements Cloneable {
        @Cascade(CascadeType.SAVE_UPDATE)
        private AgentBase artist;
 
+
        /**
         * Factory method
         * @return
         */
        public static Media NewInstance(){
-               logger.debug("NewInstance");
                return new Media();
        }
        
+
+       /**
+        * Factory method which creates a new media, adds a reprsentation including mime type and suffix information
+        * and adds to the later a representation part for a given uri and size
+        * Returns <code>null</code> if uri is empty
+        * @return Media
+        */
+       public static Media NewInstance(String uri, Integer size, String mimeType, String suffix){
+               MediaRepresentation representation = MediaRepresentation.NewInstance(mimeType, suffix, uri, size);
+               if (representation == null){
+                       return null;
+               }
+               Media media = new Media();
+               media.addRepresentation(representation);
+               return media;
+       }
+       
        /**
         * Constructor
         */
        protected Media() {
                super();
+               setMediaCacheStrategy();
+       }
+
+       private void setMediaCacheStrategy() {
+               if (getClass() == Media.class){
+                       this.cacheStrategy = MediaDefaultCacheStrategy.NewInstance();
+               }
+               
        }
 
+
        public Set<MediaRepresentation> getRepresentations(){
+               if(representations == null) {
+                       this.representations = new HashSet<MediaRepresentation>();
+               }
                return this.representations;
        }
 
@@ -164,17 +210,79 @@ public class Media extends IdentifiableEntity implements Cloneable {
                this.artist = artist;
        }
 
-       public Map<Language,LanguageString> getTitle(){
+//************************ title / title cache *********************************
+       
+       public LanguageString getTitle(){
+               return getTitle(Language.DEFAULT());
+       }
+       
+       public LanguageString getTitle(Language language){
+               return title.get(language);
+       }
+       
+       @Transient
+       public Map<Language,LanguageString> getAllTitles(){
+               if(title == null) {
+                       this.title = new HashMap<Language,LanguageString>();
+               }
                return this.title;
        }
        
        public void addTitle(LanguageString title){
                this.title.put(title.getLanguage(), title);
        }
+       public void addTitle(String title, Language language){
+               this.title.put(language, LanguageString.NewInstance(title, language));
+       }
        
        public void removeTitle(Language language){
                this.title.remove(language);
        }
+       
+
+       @Transient 
+       public String getTitleCacheByLanguage(Language lang){
+               if (cacheStrategy != null){
+                       return ((MediaDefaultCacheStrategy)cacheStrategy).getTitleCacheByLanguage(this, lang);
+               }else{
+                       return null;
+               }
+                       
+       }
+       
+       
+       /*
+        * (non-Javadoc)
+        * @see eu.etaxonomy.cdm.model.common.IdentifiableEntity#setTitleCache(java.lang.String)
+        */
+       @Override
+       public void setTitleCache(String titleCache) {
+               addTitle(LanguageString.NewInstance(titleCache, Language.DEFAULT()));
+       }
+       
+       /* (non-Javadoc)
+        * @see eu.etaxonomy.cdm.model.common.IIdentifiableEntity#getTitleCache()
+        */
+       @Override
+       public String getTitleCache(){
+               if (protectedTitleCache){
+                       return this.titleCache;                 
+               }
+               // is title dirty, i.e. equal NULL?
+               if (titleCache == null){
+                       this.titleCache = generateTitle();
+                       this.titleCache = getTruncatedCache(this.titleCache) ;
+               }else{
+                       //do the same as listeners on dependend objects like representations parts
+                       //are not yet installed
+                       this.titleCache = generateTitle();
+                       this.titleCache = getTruncatedCache(this.titleCache) ;
+               }
+               return titleCache;
+       }
+       
+       
+       
 
        public DateTime getMediaCreated(){
                return this.mediaCreated;
@@ -184,12 +292,26 @@ public class Media extends IdentifiableEntity implements Cloneable {
                this.mediaCreated = mediaCreated;
        }
 
+       //************* Descriptions
+       
+       @Deprecated // will be removed in next release; use getAllDescriptions instead
        public Map<Language,LanguageString> getDescription(){
+               return getAllDescriptions();
+       }
+       
+       public Map<Language,LanguageString> getAllDescriptions(){
+               if(this.description == null) {
+                       this.description = new HashMap<Language,LanguageString>();
+               }
                return this.description;
        }
        
+       public LanguageString getDescription(Language language){
+               return getAllDescriptions().get(language);
+       }
+       
        public void addDescription(LanguageString description){
-               this.description.put(description.getLanguage(),description);
+               this.description.put(description.getLanguage(), description);
        }
        
        public void addDescription(String text, Language language){
@@ -232,4 +354,6 @@ public class Media extends IdentifiableEntity implements Cloneable {
                return 0;
        }
        
+       
+       
 }
\ No newline at end of file