X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Freader%2FBasicReader.java;h=baf3c7dede9ebab876d7a4b3158d369e8224331d;hb=062ee296d56e273fa30fd3a078e5b18a02f2e00d;hp=7b9c98c2a6c1f0239bb460fc2fc8b7938a36a9fb;hpb=9119671d3774c0b74ce8661b5262ff14e6bfb010;p=fanfix.git diff --git a/src/be/nikiroo/fanfix/reader/BasicReader.java b/src/be/nikiroo/fanfix/reader/BasicReader.java index 7b9c98c..baf3c7d 100644 --- a/src/be/nikiroo/fanfix/reader/BasicReader.java +++ b/src/be/nikiroo/fanfix/reader/BasicReader.java @@ -6,15 +6,15 @@ 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.Library; +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.supported.BasicSupport; import be.nikiroo.utils.Progress; -import be.nikiroo.utils.ui.UIUtils; import be.nikiroo.utils.serial.SerialUtils; /** @@ -25,6 +25,11 @@ 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, @@ -32,22 +37,34 @@ public abstract class BasicReader { 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 + "LocalReader"; + case CLI: + return pkg + "CliReader"; + case TUI: + return pkg + "TuiReader"; + case GUI: + return pkg + "GuiReader"; } - + return null; } } + private static BasicLibrary defaultLibrary = Instance.getLibrary(); private static ReaderType defaultType = ReaderType.GUI; + + private BasicLibrary lib; private Story story; private ReaderType type; @@ -80,6 +97,8 @@ public abstract class BasicReader { * * @param type * the new type + * + * @return the type */ protected BasicReader setType(ReaderType type) { this.type = type; @@ -95,9 +114,34 @@ public abstract class BasicReader { return story; } + /** + * The {@link LocalLibrary} to load the stories from (by default, takes the + * default {@link LocalLibrary}). + * + * @return the {@link LocalLibrary} + */ + public BasicLibrary getLibrary() { + if (lib == null) { + lib = defaultLibrary; + } + + 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) { + this.lib = lib; + } + /** * Create a new {@link BasicReader} for a {@link Story} in the - * {@link Library} . + * {@link LocalLibrary}. * * @param luid * the {@link Story} ID @@ -108,7 +152,7 @@ public abstract class BasicReader { * in case of I/O error */ public void setStory(String luid, Progress pg) throws IOException { - story = Instance.getLibrary().getStory(luid, pg); + story = lib.getStory(luid, pg); if (story == null) { throw new IOException("Cannot retrieve story from library: " + luid); } @@ -162,14 +206,14 @@ public abstract class BasicReader { public abstract void read(int chapter) throws IOException; /** - * Start the reader in browse mode for the given type (or pass NULL for all - * types). + * Start the reader in browse mode for the given source (or pass NULL for + * all sources). * - * @param type + * @param source * the type of {@link Story} to take into account, or NULL for * all */ - public abstract void start(String type); + public abstract void browse(String source); /** * Return a new {@link BasicReader} ready for use if one is configured. @@ -181,8 +225,8 @@ public abstract class BasicReader { public static BasicReader getReader() { try { if (defaultType != null) { - return ((BasicReader)SerialUtils.createObject - (defaultType.getTypeName())).setType(defaultType); + return ((BasicReader) SerialUtils.createObject(defaultType + .getTypeName())).setType(defaultType); } } catch (Exception e) { Instance.syserr(new Exception("Cannot create a reader of type: " @@ -213,6 +257,17 @@ public abstract class BasicReader { BasicReader.defaultType = defaultType; } + /** + * Change the default {@link LocalLibrary} to open with the + * {@link BasicReader}s. + * + * @param lib + * the new {@link LocalLibrary} + */ + public static void setDefaultLibrary(BasicLibrary lib) { + BasicReader.defaultLibrary = lib; + } + /** * Return an {@link URL} from this {@link String}, be it a file path or an * actual {@link URL}. @@ -241,15 +296,37 @@ public abstract class BasicReader { return source; } - // open with external player the related file - public static void open(String luid) throws IOException { - MetaData meta = Instance.getLibrary().getInfo(luid); - File target = Instance.getLibrary().getFile(luid); + /** + * Open the {@link Story} with an external reader (the program will be + * passed the main file associated with this {@link Story}). + * + * @param lib + * the {@link BasicLibrary} to select the {@link Story} from + * @param luid + * the {@link Story} LUID + * + * @throws IOException + * in case of I/O error + */ + public static void open(BasicLibrary lib, String luid) throws IOException { + MetaData meta = lib.getInfo(luid); + File target = lib.getFile(luid); open(meta, target); } - // open with external player the related file + /** + * Open the {@link Story} with an external reader (the program will be + * passed the given target file). + * + * @param meta + * the {@link Story} to load + * @param target + * the target {@link File} + * + * @throws IOException + * in case of I/O error + */ protected static void open(MetaData meta, File target) throws IOException { String program = null; if (meta.isImageDocument()) {