code cleanup / jdoc
authorNiki Roo <niki@nikiroo.be>
Wed, 20 May 2020 12:12:34 +0000 (14:12 +0200)
committerNiki Roo <niki@nikiroo.be>
Wed, 20 May 2020 12:12:34 +0000 (14:12 +0200)
13 files changed:
src/be/nikiroo/fanfix/data/MetaData.java
src/be/nikiroo/fanfix/library/Template.java
src/be/nikiroo/fanfix/supported/BasicSupport.java
src/be/nikiroo/fanfix/supported/BasicSupport_Deprecated.java
src/be/nikiroo/fanfix/supported/E621.java
src/be/nikiroo/fanfix/supported/EHentai.java
src/be/nikiroo/fanfix/supported/Fanfiction.java
src/be/nikiroo/fanfix/supported/Fimfiction.java
src/be/nikiroo/fanfix/supported/FimfictionApi.java
src/be/nikiroo/fanfix/supported/MangaHub.java
src/be/nikiroo/fanfix/supported/MangaLel.java
src/be/nikiroo/fanfix/supported/Text.java
src/be/nikiroo/fanfix/supported/YiffStar.java

index 2e34ef98ad27bda10ff34a009fa3d3d314aaf6b2..1c6ad42838d5541dbd69533b9fb1e2d21d52dd60 100644 (file)
@@ -4,6 +4,7 @@ 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;
 
@@ -85,7 +86,7 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * The story publication date.
+        * The story publication date, we try to use "YYYY-mm-dd" when possible.
         * 
         * @return the date
         */
@@ -94,7 +95,7 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * The story publication date.
+        * The story publication date, we try to use "YYYY-mm-dd" when possible.
         * 
         * @param date
         *            the date to set
@@ -152,7 +153,7 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * The cover image of the story if any (can be NULL).
+        * The cover image of the story, if any (can be NULL).
         * <p>
         * The cover is not fetched until the story is.
         * 
@@ -163,7 +164,7 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * The cover image of the story if any (can be NULL).
+        * The cover image of the story, if any (can be NULL).
         * <p>
         * The cover is not fetched until the story is.
         * 
@@ -175,7 +176,7 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * 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...).
         * 
@@ -198,7 +199,11 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * The source of this story (which online library it was downloaded from).
+        * The source of this story -- a very user-visible piece of data.
+        * <p>
+        * 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
         */
@@ -207,7 +212,11 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * The source of this story (which online library it was downloaded from).
+        * The source of this story -- a very user-visible piece of data.
+        * <p>
+        * 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
@@ -255,7 +264,14 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * 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 --
+        * <strong>a luid may potentially be anything else, including non-numeric
+        * characters</strong>).
+        * <p>
+        * A NULL or empty luid represents an incomplete, corrupted or fake
+        * {@link Story}.
         * 
         * @return the luid
         */
@@ -264,7 +280,14 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * 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 --
+        * <strong>a luid may potentially be anything else, including non-numeric
+        * characters</strong>).
+        * <p>
+        * A NULL or empty luid represents an incomplete, corrupted or fake
+        * {@link Story}.
         * 
         * @param luid
         *            the luid to set
@@ -293,7 +316,15 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * 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}).
+        * <p>
+        * It allows you to know where the {@link Story} comes from, and is not
+        * supposed to change.
+        * <p>
+        * It's the user representation of the enum
+        * ({@link SupportType#getSourceName()}, not
+        * {@link SupportType#toString()}).
         * 
         * @return the publisher
         */
@@ -302,7 +333,15 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * 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}).
+        * <p>
+        * It allows you to know where the {@link Story} comes from, and is not
+        * supposed to change.
+        * <p>
+        * It's the user representation of the enum
+        * ({@link SupportType#getSourceName()}, not
+        * {@link SupportType#toString()}).
         * 
         * @param publisher
         *            the publisher to set
@@ -312,7 +351,14 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * The output type this {@link Story} is in.
+        * The output type this {@link Story} is in (see {@link SupportType}).
+        * <p>
+        * It allows you to know where the {@link Story} comes from, and is not
+        * supposed to change.
+        * <p>
+        * It's the direct representation of the enum
+        * ({@link SupportType#toString()}, not
+        * {@link SupportType#getSourceName()}).
         * 
         * @return the type the type
         */
@@ -321,7 +367,14 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * The output type this {@link Story} is in.
+        * The output type this {@link Story} is in (see {@link SupportType}).
+        * <p>
+        * It allows you to know where the {@link Story} comes from, and is not
+        * supposed to change.
+        * <p>
+        * It's the direct representation of the enum
+        * ({@link SupportType#toString()}, not
+        * {@link SupportType#getSourceName()}).
         * 
         * @param type
         *            the new type to set
@@ -332,6 +385,10 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
 
        /**
         * Document catering mostly to image files.
+        * <p>
+        * I.E., this is a comics or a manga, not a textual story with actual words.
+        * <p>
+        * In image documents, all the paragraphs are supposed to be images.
         * 
         * @return the imageDocument state
         */
@@ -341,6 +398,10 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
 
        /**
         * Document catering mostly to image files.
+        * <p>
+        * I.E., this is a comics or a manga, not a textual story with actual words.
+        * <p>
+        * In image documents, all the paragraphs are supposed to be images.
         * 
         * @param imageDocument
         *            the imageDocument state to set
@@ -350,45 +411,49 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * 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
@@ -398,7 +463,7 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        }
 
        /**
-        * 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
index 2dfbacfeb1092780f81686762eb6bf10bb6ee37f..3536d5f12efccf7da066ce4b1d140553c633e631 100644 (file)
@@ -66,15 +66,6 @@ public class Template {
                }
                
                InputStream in = IOUtils.openResource(location, name);
-               
-               InputStream stream;
-               
-               stream = IOUtils.openResource(location, name);
-               System.out.println("SOURCE = (("  + IOUtils.readSmallStream(stream) + "))");
-               stream=new ReplaceInputStream(IOUtils.openResource(location, name), from, to);
-               System.out.println("RESULT = (("  + IOUtils.readSmallStream(stream) + "))");
-               
-               
                return new ReplaceInputStream(in, from, to);
        }
 
index 56a3bb80cb6d51fe40a9c4d830e12cb275102d76..bcfcca1bdbb16cfd3bd8849e8fdb2bfb55a22de0 100644 (file)
@@ -272,7 +272,12 @@ public abstract class BasicSupport {
                pg.setProgress(30);
 
                Story story = new Story();
+               
                MetaData meta = getMeta();
+               meta.setType(getType().toString());
+               meta.setSource(getType().getSourceName());
+               meta.setPublisher(getType().getSourceName());
+               
                if (meta.getCreationDate() == null
                                || meta.getCreationDate().trim().isEmpty()) {
                        meta.setCreationDate(bsHelper
index 40ff3fc027c7e52beca3426017e1a6a58972fbbe..9aac6d5c61b713a4641fc251796b981e48d3a2ec 100644 (file)
@@ -203,7 +203,12 @@ public abstract class BasicSupport_Deprecated extends BasicSupport {
                        pg.setProgress(30);
 
                        Story story = new Story();
+                       
                        MetaData meta = getMeta(url, getInput());
+                       meta.setType(getType().toString());
+                       meta.setSource(getType().getSourceName());
+                       meta.setPublisher(getType().getSourceName());
+                       
                        if (meta.getCreationDate() == null
                                        || meta.getCreationDate().trim().isEmpty()) {
                                meta.setCreationDate(bsHelper.formatDate(
index a566017904cf75fc7c532bcb0539068797cbd002..f3a7238e534e7bf74ca0c1471da3cba6aca28b5e 100644 (file)
@@ -62,14 +62,11 @@ class E621 extends BasicSupport {
                meta.setAuthor(getAuthor());
                meta.setDate(bsHelper.formatDate(getDate()));
                meta.setTags(getTags());
-               meta.setSource(getType().getSourceName());
                meta.setUrl(getSource().toString());
-               meta.setPublisher(getType().getSourceName());
                meta.setUuid(getSource().toString());
                meta.setLuid("");
                meta.setLang("en");
                meta.setSubject("Furry");
-               meta.setType(getType().toString());
                meta.setImageDocument(true);
                meta.setCover(getCover());
                meta.setFakeCover(true);
index 3c734329e3bac03e456665958b6699cc623b3ff8..399ce913055cdb66934a287153a768fd6223f5e3 100644 (file)
@@ -34,14 +34,11 @@ class EHentai extends BasicSupport_Deprecated {
                meta.setAuthor(getAuthor(reset(in)));
                meta.setDate(getDate(reset(in)));
                meta.setTags(getTags(reset(in)));
-               meta.setSource(getType().getSourceName());
                meta.setUrl(source.toString());
-               meta.setPublisher(getType().getSourceName());
                meta.setUuid(source.toString());
                meta.setLuid("");
                meta.setLang(getLang(reset(in)));
                meta.setSubject("Hentai");
-               meta.setType(getType().toString());
                meta.setImageDocument(true);
                meta.setCover(getCover(source, reset(in)));
                meta.setFakeCover(true);
index 16b44f806de8b1df604a0f5e0637a017f39d8ce2..060705cadd09ea0867c1152245a0bd90697fac6f 100644 (file)
@@ -40,14 +40,11 @@ class Fanfiction extends BasicSupport_Deprecated {
                meta.setAuthor(getAuthor(reset(in)));
                meta.setDate(getDate(reset(in)));
                meta.setTags(getTags(reset(in)));
-               meta.setSource(getType().getSourceName());
                meta.setUrl(source.toString());
-               meta.setPublisher(getType().getSourceName());
                meta.setUuid(source.toString());
                meta.setLuid("");
                meta.setLang("en"); // TODO find language of book
                meta.setSubject(getSubject(reset(in)));
-               meta.setType(getType().toString());
                meta.setImageDocument(false);
                meta.setCover(getCover(source, reset(in)));
 
index 77267c1188a24438bec7f46c1097219f0d20e58c..b5df2618ce671ddaf04d7f5b644c3110c721339b 100644 (file)
@@ -38,14 +38,11 @@ class Fimfiction extends BasicSupport_Deprecated {
                meta.setAuthor(getAuthor(reset(in)));
                meta.setDate(getDate(reset(in)));
                meta.setTags(getTags(reset(in)));
-               meta.setSource(getType().getSourceName());
                meta.setUrl(source.toString());
-               meta.setPublisher(getType().getSourceName());
                meta.setUuid(source.toString());
                meta.setLuid("");
                meta.setLang("en");
                meta.setSubject("MLP");
-               meta.setType(getType().toString());
                meta.setImageDocument(false);
                meta.setCover(getCover(reset(in)));
 
index e6dd6118721b93aec36c0d7c734faad1c6d9a95b..cdb132147679b3a912e662a112cd988273382cc0 100644 (file)
@@ -127,14 +127,11 @@ class FimfictionApi extends BasicSupport {
                meta.setDate(bsHelper.formatDate(
                                getKeyJson(json, 0, "type", "story", "date_published")));
                meta.setTags(getTags());
-               meta.setSource(getType().getSourceName());
                meta.setUrl(getSource().toString());
-               meta.setPublisher(getType().getSourceName());
                meta.setUuid(getSource().toString());
                meta.setLuid("");
                meta.setLang("en");
                meta.setSubject("MLP");
-               meta.setType(getType().toString());
                meta.setImageDocument(false);
 
                String coverImageLink = getKeyJson(json, 0, "type", "story",
index 706a59114adf62949044cf1eb52b8347d38749dc..7ba12b979e9e93ac7f2426c4a588aa99369d6fd6 100644 (file)
@@ -39,14 +39,11 @@ class MangaHub extends BasicSupport {
                meta.setDate("");
                meta.setAuthor(getAuthor());
                meta.setTags(getTags());
-               meta.setSource(getType().getSourceName());
                meta.setUrl(getSource().toString());
-               meta.setPublisher(getType().getSourceName());
                meta.setUuid(getSource().toString());
                meta.setLuid("");
                meta.setLang("en");
                meta.setSubject("manga");
-               meta.setType(getType().toString());
                meta.setImageDocument(true);
                meta.setCover(getCover());
 
index 5910a371aedf7272e546ec7170b508516879ced1..47efad8594a71830a33e5de698e47256c3d87616 100644 (file)
@@ -34,14 +34,11 @@ class MangaLel extends BasicSupport {
                meta.setAuthor(getAuthor());
                meta.setDate(bsHelper.formatDate(getDate()));
                meta.setTags(getTags());
-               meta.setSource(getType().getSourceName());
                meta.setUrl(getSource().toString());
-               meta.setPublisher(getType().getSourceName());
                meta.setUuid(getSource().toString());
                meta.setLuid("");
                meta.setLang("fr");
                meta.setSubject("manga");
-               meta.setType(getType().toString());
                meta.setImageDocument(true);
                meta.setCover(getCover());
 
index 71e30c3252220c76f6ae5724e9632d33e67878cf..252aca0443fbfe0f71db294c0c8c1d3a816deb72 100644 (file)
@@ -85,14 +85,11 @@ class Text extends BasicSupport {
                meta.setAuthor(getAuthor());
                meta.setDate(bsHelper.formatDate(getDate()));
                meta.setTags(new ArrayList<String>());
-               meta.setSource(getType().getSourceName());
                meta.setUrl(getSourceFile().toURI().toURL().toString());
-               meta.setPublisher("");
                meta.setUuid(getSourceFile().toString());
                meta.setLuid("");
                meta.setLang(getLang()); // default is EN
                meta.setSubject(getSourceFile().getParentFile().getName());
-               meta.setType(getType().toString());
                meta.setImageDocument(false);
                meta.setCover(getCover(getSourceFile()));
                
index 6974e9ae98a52bfde44f703cb585a63a26810033..498b7d9a611db6417b153e4b5689dc786b70d513 100644 (file)
@@ -34,14 +34,11 @@ class YiffStar extends BasicSupport_Deprecated {
                meta.setAuthor(getAuthor(reset(in)));
                meta.setDate("");
                meta.setTags(getTags(reset(in)));
-               meta.setSource(getType().getSourceName());
                meta.setUrl(source.toString());
-               meta.setPublisher(getType().getSourceName());
                meta.setUuid(source.toString());
                meta.setLuid("");
                meta.setLang("en");
                meta.setSubject("Furry");
-               meta.setType(getType().toString());
                meta.setImageDocument(false);
                meta.setCover(getCover(source, reset(in)));