X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Fdata%2FMetaData.java;h=5989604ce92f51edef0b631a45dcec1ff0200ab6;hb=50df0f093afbc78a1d120bbc7c1233fa704688b1;hp=53525fdc58726eee7bd274dc10b5e4adf7568516;hpb=9fe3f17729759e933d7687cc2838f7255f2c9283;p=fanfix.git diff --git a/src/be/nikiroo/fanfix/data/MetaData.java b/src/be/nikiroo/fanfix/data/MetaData.java index 53525fd..5989604 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
+ * 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
+ * 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 is not fetched until the story is.
*
* @return the cover
*/
@@ -135,7 +164,9 @@ public class MetaData implements Cloneable, Comparable
+ * 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
+ * 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
+ * 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 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 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
+ * It allows you to know where the {@link Story} comes from, and is not
+ * supposed to change, even when re-imported.
+ *
+ * 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
+ * It allows you to know where the {@link Story} comes from, and is not
+ * supposed to change, even when re-imported.
+ *
+ * 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
+ * It allows you to know where the {@link Story} comes from, and is supposed
+ * to only change when it is imported anew.
+ *
+ * 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
+ * It allows you to know where the {@link Story} comes from, and is supposed
+ * to only change when it is imported anew.
+ *
+ * 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
+ * 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
+ * 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
+ * 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);
+ }
}