Add more warnings source to 1.6) and fix warnings
[nikiroo-utils.git] / src / be / nikiroo / fanfix / reader / BasicReader.java
index baf3c7dede9ebab876d7a4b3158d369e8224331d..a261c04b4db36c2bd9a7c366b24b25ff0b09e2eb 100644 (file)
@@ -6,13 +6,13 @@ import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URL;
 
-import be.nikiroo.fanfix.BasicLibrary;
 import be.nikiroo.fanfix.Instance;
-import be.nikiroo.fanfix.LocalLibrary;
 import be.nikiroo.fanfix.bundles.Config;
 import be.nikiroo.fanfix.bundles.UiConfig;
 import be.nikiroo.fanfix.data.MetaData;
 import be.nikiroo.fanfix.data.Story;
+import be.nikiroo.fanfix.library.BasicLibrary;
+import be.nikiroo.fanfix.library.LocalLibrary;
 import be.nikiroo.fanfix.supported.BasicSupport;
 import be.nikiroo.utils.Progress;
 import be.nikiroo.utils.serial.SerialUtils;
@@ -24,49 +24,14 @@ import be.nikiroo.utils.serial.SerialUtils;
  * 
  * @author niki
  */
-public abstract class BasicReader {
-       /**
-        * A type of {@link BasicReader}.
-        * 
-        * @author niki
-        */
-       public enum ReaderType {
-               /** Simple reader that outputs everything on the console */
-               CLI,
-               /** Reader that starts local programs to handle the stories */
-               GUI,
-               /** A text (UTF-8) reader with menu and text windows */
-               TUI,
-
-               ;
-
-               /**
-                * Return the full class name of a type that implements said
-                * {@link ReaderType}.
-                * 
-                * @return the class name
-                */
-               public String getTypeName() {
-                       String pkg = "be.nikiroo.fanfix.reader.";
-                       switch (this) {
-                       case CLI:
-                               return pkg + "CliReader";
-                       case TUI:
-                               return pkg + "TuiReader";
-                       case GUI:
-                               return pkg + "GuiReader";
-                       }
-
-                       return null;
-               }
-       }
-
+public abstract class BasicReader implements Reader {
        private static BasicLibrary defaultLibrary = Instance.getLibrary();
        private static ReaderType defaultType = ReaderType.GUI;
 
        private BasicLibrary lib;
+       private MetaData meta;
        private Story story;
-       private ReaderType type;
+       private int chapter;
 
        /**
         * Take the default reader type configuration from the config file.
@@ -83,43 +48,16 @@ public abstract class BasicReader {
                }
        }
 
-       /**
-        * The type of this reader.
-        * 
-        * @return the type
-        */
-       public ReaderType getType() {
-               return type;
-       }
-
-       /**
-        * The type of this reader.
-        * 
-        * @param type
-        *            the new type
-        * 
-        * @return the type
-        */
-       protected BasicReader setType(ReaderType type) {
-               this.type = type;
-               return this;
-       }
+       @Override
+       public synchronized Story getStory(Progress pg) {
+               if (story == null) {
+                       story = getLibrary().getStory(meta.getLuid(), pg);
+               }
 
-       /**
-        * Return the current {@link Story}.
-        * 
-        * @return the {@link Story}
-        */
-       public Story getStory() {
                return story;
        }
 
-       /**
-        * The {@link LocalLibrary} to load the stories from (by default, takes the
-        * default {@link LocalLibrary}).
-        * 
-        * @return the {@link LocalLibrary}
-        */
+       @Override
        public BasicLibrary getLibrary() {
                if (lib == null) {
                        lib = defaultLibrary;
@@ -128,48 +66,34 @@ public abstract class BasicReader {
                return lib;
        }
 
-       /**
-        * Change the {@link LocalLibrary} that will be managed by this
-        * {@link BasicReader}.
-        * 
-        * @param lib
-        *            the new {@link LocalLibrary}
-        */
-       public void setLibrary(LocalLibrary lib) {
+       @Override
+       public void setLibrary(BasicLibrary lib) {
                this.lib = lib;
        }
 
-       /**
-        * Create a new {@link BasicReader} for a {@link Story} in the
-        * {@link LocalLibrary}.
-        * 
-        * @param luid
-        *            the {@link Story} ID
-        * @param pg
-        *            the optional progress reporter
-        * 
-        * @throws IOException
-        *             in case of I/O error
-        */
-       public void setStory(String luid, Progress pg) throws IOException {
-               story = lib.getStory(luid, pg);
-               if (story == null) {
+       @Override
+       public MetaData getMeta() {
+               return meta;
+       }
+
+       @Override
+       public synchronized void setMeta(MetaData meta) throws IOException {
+               setMeta(meta == null ? null : meta.getLuid()); // must check the library
+       }
+
+       @Override
+       public synchronized void setMeta(String luid) throws IOException {
+               story = null;
+               meta = getLibrary().getInfo(luid);
+
+               if (meta == null) {
                        throw new IOException("Cannot retrieve story from library: " + luid);
                }
        }
 
-       /**
-        * Create a new {@link BasicReader} for an external {@link Story}.
-        * 
-        * @param source
-        *            the {@link Story} {@link URL}
-        * @param pg
-        *            the optional progress reporter
-        * 
-        * @throws IOException
-        *             in case of I/O error
-        */
-       public void setStory(URL source, Progress pg) throws IOException {
+       @Override
+       public synchronized void setMeta(URL source, Progress pg)
+                       throws IOException {
                BasicSupport support = BasicSupport.getSupport(source);
                if (support == null) {
                        throw new IOException("URL not supported: " + source.toString());
@@ -180,40 +104,20 @@ public abstract class BasicReader {
                        throw new IOException(
                                        "Cannot retrieve story from external source: "
                                                        + source.toString());
-
                }
-       }
 
-       /**
-        * Start the {@link Story} Reading.
-        * 
-        * @throws IOException
-        *             in case of I/O error or if the {@link Story} was not
-        *             previously set
-        */
-       public abstract void read() throws IOException;
+               meta = story.getMeta();
+       }
 
-       /**
-        * Read the selected chapter (starting at 1).
-        * 
-        * @param chapter
-        *            the chapter
-        * 
-        * @throws IOException
-        *             in case of I/O error or if the {@link Story} was not
-        *             previously set
-        */
-       public abstract void read(int chapter) throws IOException;
+       @Override
+       public int getChapter() {
+               return chapter;
+       }
 
-       /**
-        * Start the reader in browse mode for the given source (or pass NULL for
-        * all sources).
-        * 
-        * @param source
-        *            the type of {@link Story} to take into account, or NULL for
-        *            all
-        */
-       public abstract void browse(String source);
+       @Override
+       public void setChapter(int chapter) {
+               this.chapter = chapter;
+       }
 
        /**
         * Return a new {@link BasicReader} ready for use if one is configured.
@@ -222,11 +126,11 @@ public abstract class BasicReader {
         * 
         * @return a {@link BasicReader}, or NULL if none configured
         */
-       public static BasicReader getReader() {
+       public static Reader getReader() {
                try {
                        if (defaultType != null) {
-                               return ((BasicReader) SerialUtils.createObject(defaultType
-                                               .getTypeName())).setType(defaultType);
+                               return (Reader) SerialUtils.createObject(defaultType
+                                               .getTypeName());
                        }
                } catch (Exception e) {
                        Instance.syserr(new Exception("Cannot create a reader of type: "
@@ -237,7 +141,7 @@ public abstract class BasicReader {
        }
 
        /**
-        * The default {@link ReaderType} used when calling
+        * The default {@link Reader.ReaderType} used when calling
         * {@link BasicReader#getReader()}.
         * 
         * @return the default type
@@ -247,7 +151,7 @@ public abstract class BasicReader {
        }
 
        /**
-        * The default {@link ReaderType} used when calling
+        * The default {@link Reader.ReaderType} used when calling
         * {@link BasicReader#getReader()}.
         * 
         * @param defaultType
@@ -308,11 +212,12 @@ public abstract class BasicReader {
         * @throws IOException
         *             in case of I/O error
         */
-       public static void open(BasicLibrary lib, String luid) throws IOException {
+       public static void openExternal(BasicLibrary lib, String luid)
+                       throws IOException {
                MetaData meta = lib.getInfo(luid);
                File target = lib.getFile(luid);
 
-               open(meta, target);
+               openExternal(meta, target);
        }
 
        /**
@@ -327,7 +232,8 @@ public abstract class BasicReader {
         * @throws IOException
         *             in case of I/O error
         */
-       protected static void open(MetaData meta, File target) throws IOException {
+       protected static void openExternal(MetaData meta, File target)
+                       throws IOException {
                String program = null;
                if (meta.isImageDocument()) {
                        program = Instance.getUiConfig().getString(