From: Niki Roo Date: Wed, 20 May 2020 12:18:46 +0000 (+0200) Subject: Merge branch 'master' into subtree X-Git-Url: http://git.nikiroo.be/?p=nikiroo-utils.git;a=commitdiff_plain;h=258e065f81071a861711ef935dca3ec5563f4360;hp=-c Merge branch 'master' into subtree --- 258e065f81071a861711ef935dca3ec5563f4360 diff --combined data/MetaData.java index 2e34ef9,1c6ad42..1c6ad42 --- a/data/MetaData.java +++ b/data/MetaData.java @@@ -4,6 -4,7 +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 +86,7 @@@ public class MetaData implements Clonea } /** - * The story publication date. + * The story publication date, we try to use "YYYY-mm-dd" when possible. * * @return the date */ @@@ -94,7 -95,7 +95,7 @@@ } /** - * 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 +153,7 @@@ } /** - * 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. * @@@ -163,7 -164,7 +164,7 @@@ } /** - * 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. * @@@ -175,7 -176,7 +176,7 @@@ } /** - * 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 +199,11 @@@ } /** - * 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 */ @@@ -207,7 -212,11 +212,11 @@@ } /** - * 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 @@@ -255,7 -264,14 +264,14 @@@ } /** - * 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 */ @@@ -264,7 -280,14 +280,14 @@@ } /** - * 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 @@@ -293,7 -316,15 +316,15 @@@ } /** - * 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 */ @@@ -302,7 -333,15 +333,15 @@@ } /** - * 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 @@@ -312,7 -351,14 +351,14 @@@ } /** - * 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 */ @@@ -321,7 -367,14 +367,14 @@@ } /** - * 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 @@@ -332,6 -385,10 +385,10 @@@ /** * 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 */ @@@ -341,6 -398,10 +398,10 @@@ /** * 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 @@@ -350,45 -411,49 +411,49 @@@ } /** - * 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 +463,7 @@@ } /** - * 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 diff --combined library/Template.java index 0000000,3536d5f..3536d5f mode 000000,100644..100644 --- a/library/Template.java +++ b/library/Template.java @@@ -1,0 -1,100 +1,100 @@@ + package be.nikiroo.fanfix.library; + + import java.io.IOException; + import java.io.InputStream; + import java.util.HashMap; + import java.util.List; + import java.util.Map; + + import be.nikiroo.utils.IOUtils; + import be.nikiroo.utils.streams.ReplaceInputStream; + + public class Template { + private Class location; + private String name; + + private Map values = new HashMap(); + private Map valuesTemplate = new HashMap(); + private Map> valuesTemplateList = new HashMap>(); + + public Template(Class location, String name) { + this.location = location; + this.name = name; + } + + public synchronized InputStream read() throws IOException { + + String from[] = new String[values.size() + valuesTemplate.size() + + valuesTemplateList.size()]; + String to[] = new String[from.length]; + + int i = 0; + + for (String key : values.keySet()) { + from[i] = "${" + key + "}"; + to[i] = values.get(key); + + i++; + } + for (String key : valuesTemplate.keySet()) { + InputStream value = valuesTemplate.get(key).read(); + try { + from[i] = "${" + key + "}"; + to[i] = IOUtils.readSmallStream(value); + } finally { + value.close(); + } + + i++; + } + for (String key : valuesTemplateList.keySet()) { + List