Update changelog
[nikiroo-utils.git] / src / be / nikiroo / fanfix / data / MetaData.java
index 76a9c7ba97f43c687e932692ecd5eff44a4bcda0..b2217ae3f4b721d235d7ee830c611514b68c9b90 100644 (file)
@@ -1,28 +1,34 @@
 package be.nikiroo.fanfix.data;
 
-import java.awt.image.BufferedImage;
+import java.util.ArrayList;
 import java.util.List;
 
+import be.nikiroo.utils.Image;
+
 /**
  * The meta data associated to a {@link Story} object.
  * 
  * @author niki
  */
-public class MetaData {
+public class MetaData implements Cloneable, Comparable<MetaData> {
        private String title;
        private String author;
        private String date;
        private Chapter resume;
        private List<String> tags;
-       private BufferedImage cover;
+       private Image cover;
        private String subject;
        private String source;
+       private String url;
        private String uuid;
        private String luid;
        private String lang;
        private String publisher;
        private String type;
        private boolean imageDocument;
+       private long words;
+       private String creationDate;
+       private boolean fakeCover;
 
        /**
         * The title of the story.
@@ -124,7 +130,7 @@ public class MetaData {
         * 
         * @return the cover
         */
-       public BufferedImage getCover() {
+       public Image getCover() {
                return cover;
        }
 
@@ -134,7 +140,7 @@ public class MetaData {
         * @param cover
         *            the cover to set
         */
-       public void setCover(BufferedImage cover) {
+       public void setCover(Image cover) {
                this.cover = cover;
        }
 
@@ -162,7 +168,7 @@ public class MetaData {
        }
 
        /**
-        * The source of this story (where it was downloaded from).
+        * The source of this story (which online library it was downloaded from).
         * 
         * @return the source
         */
@@ -171,7 +177,7 @@ public class MetaData {
        }
 
        /**
-        * The source of this story (where it was downloaded from).
+        * The source of this story (which online library it was downloaded from).
         * 
         * @param source
         *            the source to set
@@ -181,7 +187,26 @@ public class MetaData {
        }
 
        /**
-        * A unique value representing the story (it is often an URL).
+        * The original URL from which this {@link Story} was imported.
+        * 
+        * @return the url
+        */
+       public String getUrl() {
+               return url;
+       }
+
+       /**
+        * The original URL from which this {@link Story} was imported.
+        * 
+        * @param url
+        *            the new url to set
+        */
+       public void setUrl(String url) {
+               this.url = url;
+       }
+
+       /**
+        * A unique value representing the story (it is often a URL).
         * 
         * @return the uuid
         */
@@ -190,7 +215,7 @@ public class MetaData {
        }
 
        /**
-        * A unique value representing the story (it is often an URL).
+        * A unique value representing the story (it is often a URL).
         * 
         * @param uuid
         *            the uuid to set
@@ -211,7 +236,7 @@ public class MetaData {
        /**
         * A unique value representing the story in the local library.
         * 
-        * @param uuid
+        * @param luid
         *            the luid to set
         */
        public void setLuid(String luid) {
@@ -293,4 +318,117 @@ public class MetaData {
        public void setImageDocument(boolean imageDocument) {
                this.imageDocument = imageDocument;
        }
+
+       /**
+        * The number of words in the related {@link Story}.
+        * 
+        * @return the number of words
+        */
+       public long getWords() {
+               return words;
+       }
+
+       /**
+        * The number of words in the related {@link Story}.
+        * 
+        * @param words
+        *            the number of words to set
+        */
+       public void setWords(long words) {
+               this.words = words;
+       }
+
+       /**
+        * The (Fanfix) {@link Story} creation date.
+        * 
+        * @return the creationDate
+        */
+       public String getCreationDate() {
+               return creationDate;
+       }
+
+       /**
+        * The (Fanfix) {@link Story} creation date.
+        * 
+        * @param creationDate
+        *            the creationDate to set
+        */
+       public void setCreationDate(String creationDate) {
+               this.creationDate = creationDate;
+       }
+
+       /**
+        * The cover in this {@link MetaData} object is "fake", in the sens that it
+        * comes from the actual content images.
+        * 
+        * @return TRUE for a fake cover
+        */
+       public boolean isFakeCover() {
+               return fakeCover;
+       }
+
+       /**
+        * The cover in this {@link MetaData} object is "fake", in the sens that it
+        * comes from the actual content images
+        * 
+        * @param fakeCover
+        *            TRUE for a fake cover
+        */
+       public void setFakeCover(boolean fakeCover) {
+               this.fakeCover = fakeCover;
+       }
+
+       @Override
+       public int compareTo(MetaData o) {
+               if (o == null) {
+                       return 1;
+               }
+
+               String id = (getUuid() == null ? "" : getUuid())
+                               + (getLuid() == null ? "" : getLuid());
+               String oId = (getUuid() == null ? "" : o.getUuid())
+                               + (o.getLuid() == null ? "" : o.getLuid());
+
+               return id.compareTo(oId);
+       }
+
+       @Override
+       public boolean equals(Object obj) {
+               if (!(obj instanceof MetaData)) {
+                       return false;
+               }
+
+               return compareTo((MetaData) obj) == 0;
+       }
+
+       @Override
+       public int hashCode() {
+               String uuid = getUuid();
+               if (uuid == null) {
+                       uuid = "" + title + author + source;
+               }
+
+               return uuid.hashCode();
+       }
+
+       @Override
+       public MetaData clone() {
+               MetaData meta = null;
+               try {
+                       meta = (MetaData) super.clone();
+               } catch (CloneNotSupportedException e) {
+                       // Did the clones rebel?
+                       System.err.println(e);
+               }
+
+               if (tags != null) {
+                       meta.tags = new ArrayList<String>(tags);
+               }
+
+               if (resume != null) {
+                       meta.resume = resume.clone();
+               }
+
+               return meta;
+       }
 }