X-Git-Url: http://git.nikiroo.be/?p=nikiroo-utils.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Fdata%2FMetaData.java;h=1c6ad42838d5541dbd69533b9fb1e2d21d52dd60;hp=53525fdc58726eee7bd274dc10b5e4adf7568516;hb=cfdaf6052ddc5ca44cf19f1f6d9f154cc8443024;hpb=9fe3f17729759e933d7687cc2838f7255f2c9283
diff --git a/src/be/nikiroo/fanfix/data/MetaData.java b/src/be/nikiroo/fanfix/data/MetaData.java
index 53525fd..1c6ad42 100644
--- a/src/be/nikiroo/fanfix/data/MetaData.java
+++ b/src/be/nikiroo/fanfix/data/MetaData.java
@@ -1,16 +1,27 @@
package be.nikiroo.fanfix.data;
+import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
+import be.nikiroo.fanfix.supported.SupportType;
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 implements Cloneable, Comparable {
+public class MetaData implements Cloneable, Comparable, Serializable {
+ private static final long serialVersionUID = 1L;
+
private String title;
private String author;
private String date;
@@ -30,6 +41,12 @@ public class MetaData implements Cloneable, Comparable {
private String creationDate;
private boolean fakeCover;
+ /**
+ * Create an empty {@link MetaData}.
+ */
+ public MetaData() {
+ }
+
/**
* The title of the story.
*
@@ -69,7 +86,7 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The story publication date.
+ * The story publication date, we try to use "YYYY-mm-dd" when possible.
*
* @return the date
*/
@@ -78,7 +95,7 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The story publication date.
+ * The story publication date, we try to use "YYYY-mm-dd" when possible.
*
* @param date
* the date to set
@@ -108,6 +125,12 @@ public class MetaData implements Cloneable, Comparable {
/**
* 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
*/
@@ -117,6 +140,10 @@ public class MetaData implements Cloneable, Comparable {
/**
* 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
@@ -126,7 +153,9 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The cover image of the story if any (can be NULL).
+ * The cover image of the story, if any (can be NULL).
+ *
+ * The cover is not fetched until the story is.
*
* @return the cover
*/
@@ -135,7 +164,9 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The cover image of the story if any (can be NULL).
+ * 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
@@ -145,7 +176,7 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The subject of the story (or instance, if it is a fanfiction, what is the
+ * The subject of the story (for instance, if it is a fanfiction, what is the
* original work; if it is a technical text, what is the technical
* subject...).
*
@@ -168,7 +199,11 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The source of this story (which online library it was downloaded from).
+ * The source of this story -- a very user-visible piece of data.
+ *
+ * It is initialised with the same value as {@link MetaData#getPublisher()},
+ * but the user is allowed to change it into any value -- this is a sort of
+ * 'category'.
*
* @return the source
*/
@@ -177,7 +212,11 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The source of this story (which online library it was downloaded from).
+ * The source of this story -- a very user-visible piece of data.
+ *
+ * It is initialised with the same value as {@link MetaData#getPublisher()},
+ * but the user is allowed to change it into any value -- this is a sort of
+ * 'category'.
*
* @param source
* the source to set
@@ -225,7 +264,14 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * A unique value representing the story in the local library.
+ * A unique value representing the story in the local library (usually a
+ * numerical value 0-padded with a minimum size of 3; but this is subject to
+ * change and you can also obviously have more than 1000 stories --
+ * a luid may potentially be anything else, including non-numeric
+ * characters).
+ *
+ * A NULL or empty luid represents an incomplete, corrupted or fake
+ * {@link Story}.
*
* @return the luid
*/
@@ -234,7 +280,14 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * A unique value representing the story in the local library.
+ * A unique value representing the story in the local library (usually a
+ * numerical value 0-padded with a minimum size of 3; but this is subject to
+ * change and you can also obviously have more than 1000 stories --
+ * a luid may potentially be anything else, including non-numeric
+ * characters).
+ *
+ * A NULL or empty luid represents an incomplete, corrupted or fake
+ * {@link Story}.
*
* @param luid
* the luid to set
@@ -263,7 +316,15 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The story publisher (other the same as the source).
+ * The story publisher -- which is also the user representation of the
+ * output type this {@link Story} is in (see {@link SupportType}).
+ *
+ * It allows you to know where the {@link Story} comes from, and is not
+ * supposed to change.
+ *
+ * It's the user representation of the enum
+ * ({@link SupportType#getSourceName()}, not
+ * {@link SupportType#toString()}).
*
* @return the publisher
*/
@@ -272,7 +333,15 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The story publisher (other the same as the source).
+ * The story publisher -- which is also the user representation of the
+ * output type this {@link Story} is in (see {@link SupportType}).
+ *
+ * It allows you to know where the {@link Story} comes from, and is not
+ * supposed to change.
+ *
+ * It's the user representation of the enum
+ * ({@link SupportType#getSourceName()}, not
+ * {@link SupportType#toString()}).
*
* @param publisher
* the publisher to set
@@ -282,7 +351,14 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The output type this {@link Story} is in.
+ * The output type this {@link Story} is in (see {@link SupportType}).
+ *
+ * It allows you to know where the {@link Story} comes from, and is not
+ * supposed to change.
+ *
+ * It's the direct representation of the enum
+ * ({@link SupportType#toString()}, not
+ * {@link SupportType#getSourceName()}).
*
* @return the type the type
*/
@@ -291,7 +367,14 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The output type this {@link Story} is in.
+ * The output type this {@link Story} is in (see {@link SupportType}).
+ *
+ * It allows you to know where the {@link Story} comes from, and is not
+ * supposed to change.
+ *
+ * It's the direct representation of the enum
+ * ({@link SupportType#toString()}, not
+ * {@link SupportType#getSourceName()}).
*
* @param type
* the new type to set
@@ -302,6 +385,10 @@ public class MetaData implements Cloneable, Comparable {
/**
* Document catering mostly to image files.
+ *
+ * I.E., this is a comics or a manga, not a textual story with actual words.
+ *
+ * In image documents, all the paragraphs are supposed to be images.
*
* @return the imageDocument state
*/
@@ -311,6 +398,10 @@ public class MetaData implements Cloneable, Comparable {
/**
* Document catering mostly to image files.
+ *
+ * I.E., this is a comics or a manga, not a textual story with actual words.
+ *
+ * In image documents, all the paragraphs are supposed to be images.
*
* @param imageDocument
* the imageDocument state to set
@@ -320,45 +411,49 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The number of words in the related {@link Story}.
+ * The number of words (or images if this is an image document -- see
+ * {@link MetaData#isImageDocument()}) in the related {@link Story}.
*
- * @return the number of words
+ * @return the number of words/images
*/
public long getWords() {
return words;
}
/**
- * The number of words in the related {@link Story}.
+ * The number of words (or images if this is an image document -- see
+ * {@link MetaData#isImageDocument()}) in the related {@link Story}.
*
* @param words
- * the number of words to set
+ * the number of words/images to set
*/
public void setWords(long words) {
this.words = words;
}
/**
- * The (Fanfix) {@link Story} creation date.
+ * The (Fanfix) {@link Story} creation date, i.e., when the {@link Story}
+ * was fetched via Fanfix.
*
- * @return the creationDate
+ * @return the creation date
*/
public String getCreationDate() {
return creationDate;
}
/**
- * The (Fanfix) {@link Story} creation date.
+ * The (Fanfix) {@link Story} creation date, i.e., when the {@link Story}
+ * was fetched via Fanfix.
*
* @param creationDate
- * the creationDate to set
+ * the creation date to set
*/
public void setCreationDate(String creationDate) {
this.creationDate = creationDate;
}
/**
- * The cover in this {@link MetaData} object is "fake", in the sens that it
+ * The cover in this {@link MetaData} object is "fake", in the sense that it
* comes from the actual content images.
*
* @return TRUE for a fake cover
@@ -368,7 +463,7 @@ public class MetaData implements Cloneable, Comparable {
}
/**
- * The cover in this {@link MetaData} object is "fake", in the sens that it
+ * The cover in this {@link MetaData} object is "fake", in the sense that it
* comes from the actual content images
*
* @param fakeCover
@@ -384,18 +479,14 @@ public class MetaData implements Cloneable, Comparable {
return 1;
}
- String uuid = getUuid();
- String oUuid = o.getUuid();
-
- if (uuid == null) {
- uuid = "";
- }
-
- if (oUuid == null) {
- oUuid = "";
- }
+ 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 uuid.compareTo(oUuid);
+ return id.compareToIgnoreCase(oId);
}
@Override
@@ -437,4 +528,49 @@ public class MetaData implements Cloneable, Comparable {
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);
+ }
}