X-Git-Url: http://git.nikiroo.be/?p=nikiroo-utils.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Fdata%2FMetaData.java;h=2e34ef98ad27bda10ff34a009fa3d3d314aaf6b2;hp=76a9c7ba97f43c687e932692ecd5eff44a4bcda0;hb=074a83257de30c3cd7409b0840ab6f27ed0e93b5;hpb=fe999aa400c2627291325558f1ae8c734da7900c diff --git a/src/be/nikiroo/fanfix/data/MetaData.java b/src/be/nikiroo/fanfix/data/MetaData.java index 76a9c7b..2e34ef9 100644 --- a/src/be/nikiroo/fanfix/data/MetaData.java +++ b/src/be/nikiroo/fanfix/data/MetaData.java @@ -1,29 +1,51 @@ package be.nikiroo.fanfix.data; -import java.awt.image.BufferedImage; +import java.io.Serializable; +import java.util.ArrayList; import java.util.List; +import be.nikiroo.utils.Image; +import be.nikiroo.utils.StringUtils; + /** * The meta data associated to a {@link Story} object. + *

+ * Note that some earlier version of the program did not save the resume as an + * external file; for those stories, the resume is not fetched until the story + * is. + *

+ * The cover is never fetched until the story is. * * @author niki */ -public class MetaData { +public class MetaData implements Cloneable, Comparable, Serializable { + private static final long serialVersionUID = 1L; + private String title; private String author; private String date; private Chapter resume; private List 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; + /** + * Create an empty {@link MetaData}. + */ + public MetaData() { + } + /** * The title of the story. * @@ -102,6 +124,12 @@ public class MetaData { /** * The story resume (a.k.a. description). + *

+ * This can be NULL if we don't have a resume for this {@link Story}. + *

+ * Note that some earlier version of the program did not save the resume as + * an external file; for those stories, the resume is not fetched until the + * story is. * * @return the resume */ @@ -111,6 +139,10 @@ public class MetaData { /** * The story resume (a.k.a. description). + *

+ * Note that some earlier version of the program did not save the resume as + * an external file; for those stories, the resume is not fetched until the + * story is. * * @param resume * the resume to set @@ -121,20 +153,24 @@ public class MetaData { /** * The cover image of the story if any (can be NULL). + *

+ * The cover is not fetched until the story is. * * @return the cover */ - public BufferedImage getCover() { + public Image getCover() { return cover; } /** * The cover image of the story if any (can be NULL). + *

+ * The cover is not fetched until the story is. * * @param cover * the cover to set */ - public void setCover(BufferedImage cover) { + public void setCover(Image cover) { this.cover = cover; } @@ -162,7 +198,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 +207,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 +217,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 +245,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 +266,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 +348,164 @@ 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 = (getTitle() == null ? "" : getTitle()) + + (getUuid() == null ? "" : getUuid()) + + (getLuid() == null ? "" : getLuid()); + String oId = (getTitle() == null ? "" : o.getTitle()) + + (getUuid() == null ? "" : o.getUuid()) + + (o.getLuid() == null ? "" : o.getLuid()); + + return id.compareToIgnoreCase(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(tags); + } + + if (resume != null) { + meta.resume = resume.clone(); + } + + return meta; + } + + /** + * Display a DEBUG {@link String} representation of this object. + *

+ * This is not efficient, nor intended to be. + */ + @Override + public String toString() { + String title = ""; + if (getTitle() != null) { + title = getTitle(); + } + + StringBuilder tags = new StringBuilder(); + if (getTags() != null) { + for (String tag : getTags()) { + if (tags.length() > 0) { + tags.append(", "); + } + tags.append(tag); + } + } + + String resume = ""; + if (getResume() != null) { + for (Paragraph para : getResume()) { + resume += "\n\t"; + resume += para.toString().substring(0, + Math.min(para.toString().length(), 120)); + } + resume += "\n"; + } + + String cover = "none"; + if (getCover() != null) { + cover = StringUtils.formatNumber(getCover().getSize()) + + "bytes"; + } + + return String.format( + "Meta %s:\n\tTitle: [%s]\n\tAuthor: [%s]\n\tDate: [%s]\n\tTags: [%s]\n\tWord count: [%s]" + + "\n\tResume: [%s]\n\tCover: [%s]", + luid, title, getAuthor(), getDate(), tags.toString(), + "" + words, resume, cover); + } }