X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Freader%2Fui%2FGuiReaderBookInfo.java;h=23d4c3160169e0244a1070720d376fc0aba06ab6;hp=93763f941092c3fbb8a4e05133f05d3d2ec22163;hb=5bc9573be46f09ac92207e104915bd5babbd6d63;hpb=3d709626bd29ff75ee31cb42ac47774a639d514c

diff --git a/src/be/nikiroo/fanfix/reader/ui/GuiReaderBookInfo.java b/src/be/nikiroo/fanfix/reader/ui/GuiReaderBookInfo.java
index 93763f9..23d4c31 100644
--- a/src/be/nikiroo/fanfix/reader/ui/GuiReaderBookInfo.java
+++ b/src/be/nikiroo/fanfix/reader/ui/GuiReaderBookInfo.java
@@ -1,9 +1,18 @@
 package be.nikiroo.fanfix.reader.ui;
 
+import be.nikiroo.fanfix.bundles.StringIdGui;
 import be.nikiroo.fanfix.data.MetaData;
+import be.nikiroo.fanfix.data.Story;
 import be.nikiroo.fanfix.library.BasicLibrary;
 import be.nikiroo.utils.Image;
 
+/**
+ * Some meta information related to a "book" (which can either be a
+ * {@link Story}, a fake-story grouping some authors or a fake-story grouping
+ * some sources/types).
+ * 
+ * @author niki
+ */
 public class GuiReaderBookInfo {
 	public enum Type {
 		/** A normal story, which can be "read". */
@@ -24,13 +33,34 @@ public class GuiReaderBookInfo {
 
 	private MetaData meta;
 
-	// use the fromXXX methods
+	/**
+	 * For private use, see the "fromXXX" constructors instead for public use.
+	 * 
+	 * @param type
+	 *            the type of book
+	 * @param id
+	 *            the main id, which must uniquely identify this book and will
+	 *            be used as a unique ID later on
+	 * @param value
+	 *            the main value to show (see
+	 *            {@link GuiReaderBookInfo#getMainInfo()})
+	 */
 	private GuiReaderBookInfo(Type type, String id, String value) {
 		this.type = type;
 		this.id = id;
 		this.value = value;
 	}
 
+	/**
+	 * Get the main info to display for this book (a title, an author, a
+	 * source/type name...).
+	 * <p>
+	 * Note that when {@link MetaData} about the book are present, the title
+	 * inside is returned instead of the actual value (that way, we can update
+	 * the {@link MetaData} and see the changes here).
+	 * 
+	 * @return the main info, usually the title
+	 */
 	public String getMainInfo() {
 		if (meta != null) {
 			return meta.getTitle();
@@ -39,6 +69,14 @@ public class GuiReaderBookInfo {
 		return value;
 	}
 
+	/**
+	 * Get the secondary info, of the given type.
+	 * 
+	 * @param seeCount
+	 *            TRUE for word/image/story count, FALSE for author name
+	 * 
+	 * @return the secondary info
+	 */
 	public String getSecondaryInfo(boolean seeCount) {
 		String author = meta == null ? null : meta.getAuthor();
 		String secondaryInfo = seeCount ? count : author;
@@ -61,11 +99,30 @@ public class GuiReaderBookInfo {
 		return id;
 	}
 
-	// can return null for non-books
+	/**
+	 * The {@link MetaData} associated with this book, if this book is a
+	 * {@link Story}.
+	 * <p>
+	 * Can be NULL for non-story books (authors or sources/types).
+	 * 
+	 * @return the {@link MetaData} or NULL
+	 */
 	public MetaData getMeta() {
 		return meta;
 	}
 
+	/**
+	 * Get the base image to use to represent this book.
+	 * <p>
+	 * The image is <b>NOT</b> resized in any way, this is the original version.
+	 * <p>
+	 * It can be NULL if no image can be found for this book.
+	 * 
+	 * @param lib
+	 *            the {@link BasicLibrary} to use to fetch the image
+	 * 
+	 * @return the base image
+	 */
 	public Image getBaseImage(BasicLibrary lib) {
 		switch (type) {
 		case STORY:
@@ -79,6 +136,14 @@ public class GuiReaderBookInfo {
 		return null;
 	}
 
+	/**
+	 * Create a new book describing the given {@link Story}.
+	 * 
+	 * @param meta
+	 *            the {@link MetaData} representing the {@link Story}
+	 * 
+	 * @return the book
+	 */
 	static public GuiReaderBookInfo fromMeta(MetaData meta) {
 		String uid = meta.getUuid();
 		if (uid == null || uid.trim().isEmpty()) {
@@ -89,31 +154,74 @@ public class GuiReaderBookInfo {
 				meta.getTitle());
 
 		info.meta = meta;
-		info.count = formatNumber(meta.getWords(),
-				meta.isImageDocument() ? "images" : "words");
+		info.count = formatNumber(meta.getWords());
+		if (!info.count.isEmpty()) {
+			info.count = GuiReader.trans(
+					meta.isImageDocument() ? StringIdGui.BOOK_COUNT_IMAGES
+							: StringIdGui.BOOK_COUNT_WORDS, info.count);
+		}
 
 		return info;
 	}
 
+	/**
+	 * Create a new book describing the given source/type.
+	 * 
+	 * @param lib
+	 *            the {@link BasicLibrary} to use to retrieve some more
+	 *            information about the source
+	 * @param source
+	 *            the source name
+	 * 
+	 * @return the book
+	 */
 	static public GuiReaderBookInfo fromSource(BasicLibrary lib, String source) {
 		GuiReaderBookInfo info = new GuiReaderBookInfo(Type.SOURCE, "source_"
 				+ source, source);
 
-		info.count = formatNumber(lib.getListBySource(source).size(), "stories");
+		info.count = formatNumber(lib.getListBySource(source).size());
+		if (!info.count.isEmpty()) {
+			info.count = GuiReader.trans(StringIdGui.BOOK_COUNT_STORIES,
+					info.count);
+		}
 
 		return info;
 	}
 
+	/**
+	 * Create a new book describing the given author.
+	 * 
+	 * @param lib
+	 *            the {@link BasicLibrary} to use to retrieve some more
+	 *            information about the author
+	 * @param author
+	 *            the author name
+	 * 
+	 * @return the book
+	 */
 	static public GuiReaderBookInfo fromAuthor(BasicLibrary lib, String author) {
 		GuiReaderBookInfo info = new GuiReaderBookInfo(Type.AUTHOR, "author_"
 				+ author, author);
 
-		info.count = formatNumber(lib.getListByAuthor(author).size(), "stories");
+		info.count = formatNumber(lib.getListByAuthor(author).size());
+		if (!info.count.isEmpty()) {
+			info.count = GuiReader.trans(StringIdGui.BOOK_COUNT_STORIES,
+					info.count);
+		}
 
 		return info;
 	}
 
-	static private String formatNumber(long number, String ofWhat) {
+	/**
+	 * Format a number for display (use the "k" notation if higher or equal to
+	 * 4000).
+	 * 
+	 * @param number
+	 *            the number to parse
+	 * 
+	 * @return the displayable version of the number
+	 */
+	static private String formatNumber(long number) {
 		String displayNumber;
 		if (number >= 4000) {
 			displayNumber = "" + (number / 1000) + "k";
@@ -123,10 +231,6 @@ public class GuiReaderBookInfo {
 			displayNumber = "";
 		}
 
-		if (!displayNumber.isEmpty()) {
-			displayNumber += " " + ofWhat;
-		}
-
 		return displayNumber;
 	}
 }