+ * 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
+ * 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
*/
@@ -112,6 +140,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,26 +153,30 @@ public class MetaData {
}
/**
- * 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
*/
- public BufferedImage getCover() {
+ public Image getCover() {
return cover;
}
/**
- * 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
*/
- public void setCover(BufferedImage cover) {
+ public void setCover(Image cover) {
this.cover = cover;
}
/**
- * 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...).
*
@@ -163,7 +199,11 @@ public class MetaData {
}
/**
- * 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
*/
@@ -172,7 +212,11 @@ public class MetaData {
}
/**
- * 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
@@ -220,7 +264,14 @@ public class MetaData {
}
/**
- * 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
*/
@@ -229,9 +280,16 @@ public class MetaData {
}
/**
- * 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 uuid
+ * @param luid
* the luid to set
*/
public void setLuid(String luid) {
@@ -258,7 +316,15 @@ public class MetaData {
}
/**
- * 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
*/
@@ -267,7 +333,15 @@ public class MetaData {
}
/**
- * 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
@@ -277,7 +351,14 @@ public class MetaData {
}
/**
- * 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
*/
@@ -286,7 +367,14 @@ public class MetaData {
}
/**
- * 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
@@ -297,6 +385,10 @@ public class MetaData {
/**
* 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
*/
@@ -306,6 +398,10 @@ public class MetaData {
/**
* 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
@@ -313,4 +409,168 @@ public class MetaData {
public void setImageDocument(boolean imageDocument) {
this.imageDocument = imageDocument;
}
+
+ /**
+ * 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/images
+ */
+ public long getWords() {
+ return words;
+ }
+
+ /**
+ * 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/images to set
+ */
+ public void setWords(long words) {
+ this.words = words;
+ }
+
+ /**
+ * The (Fanfix) {@link Story} creation date, i.e., when the {@link Story}
+ * was fetched via Fanfix.
+ *
+ * @return the creation date
+ */
+ public String getCreationDate() {
+ return creationDate;
+ }
+
+ /**
+ * The (Fanfix) {@link Story} creation date, i.e., when the {@link Story}
+ * was fetched via Fanfix.
+ *
+ * @param creationDate
+ * the creation date to set
+ */
+ public void setCreationDate(String creationDate) {
+ this.creationDate = creationDate;
+ }
+
+ /**
+ * 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
+ */
+ public boolean isFakeCover() {
+ return fakeCover;
+ }
+
+ /**
+ * The cover in this {@link MetaData} object is "fake", in the sense 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
+ * 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);
+ }
}