X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;ds=sidebyside;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Freader%2FReader.java;h=3ecf2470021b4f6d259db9ee8b80eac9ff8a266a;hb=a67248cf983a1370625887c82ed7524e95b56dd1;hp=09d45c15f3943ccffac23a7d774e71a351996765;hpb=6322ab64949f9f4ae2b04b9504d58a301039d670;p=fanfix.git diff --git a/src/be/nikiroo/fanfix/reader/Reader.java b/src/be/nikiroo/fanfix/reader/Reader.java index 09d45c1..3ecf247 100644 --- a/src/be/nikiroo/fanfix/reader/Reader.java +++ b/src/be/nikiroo/fanfix/reader/Reader.java @@ -3,11 +3,18 @@ package be.nikiroo.fanfix.reader; import java.io.IOException; import java.net.URL; +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.SupportType; import be.nikiroo.utils.Progress; +/** + * A {@link Reader} is a class that will handle {@link Story} reading and + * browsing. + * + * @author niki + */ public interface Reader { /** * A type of {@link BasicReader}. @@ -21,6 +28,8 @@ public interface Reader { GUI, /** A text (UTF-8) reader with menu and text windows */ TUI, + /** A GUI reader implemented with the Android framework */ + ANDROID, ; @@ -34,54 +43,81 @@ public interface Reader { String pkg = "be.nikiroo.fanfix.reader."; switch (this) { case CLI: - return pkg + "CliReader"; + return pkg + "cli.CliReader"; case TUI: - return pkg + "TuiReader"; + return pkg + "tui.TuiReader"; case GUI: - return pkg + "GuiReader"; + return pkg + "ui.GuiReader"; + case ANDROID: + return pkg + "android.AndroidReader"; } return null; } - }; + } /** - * Return the current {@link Story}. + * Return the current target {@link MetaData}. + * + * @return the meta + */ + public MetaData getMeta(); + + /** + * Return the current {@link Story} as described by the current + * {@link MetaData}. + * + * @param pg + * the optional progress * * @return the {@link Story} + * + * @throws IOException + * in case of I/O error + * */ - public Story getStory(); + public Story getStory(Progress pg) throws IOException; /** - * The {@link LocalLibrary} to load the stories from (by default, takes the - * default {@link LocalLibrary}). + * The {@link BasicLibrary} to load the stories from (by default, takes the + * default {@link BasicLibrary}). * - * @return the {@link LocalLibrary} + * @return the {@link BasicLibrary} */ public BasicLibrary getLibrary(); /** - * Change the {@link LocalLibrary} that will be managed by this + * Change the {@link BasicLibrary} that will be managed by this * {@link BasicReader}. * * @param lib - * the new {@link LocalLibrary} + * the new {@link BasicLibrary} */ - public void setLibrary(LocalLibrary lib); + public void setLibrary(BasicLibrary lib); /** - * Set a {@link Story} from the current {@link Library} into the + * Set a {@link Story} from the current {@link BasicLibrary} into the * {@link Reader}. * * @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; + public void setMeta(String luid) throws IOException; + + /** + * Set a {@link Story} from the current {@link BasicLibrary} into the + * {@link Reader}. + * + * @param meta + * the meta + * + * @throws IOException + * in case of I/O error + */ + public void setMeta(MetaData meta) throws IOException; /** * Set an external {@link Story} into this {@link Reader}. @@ -94,36 +130,138 @@ public interface Reader { * @throws IOException * in case of I/O error */ - public void setStory(URL source, Progress pg) throws IOException; + public void setMeta(URL source, Progress pg) throws IOException; /** * Start the {@link Story} Reading. * + * @param sync + * execute the process synchronously (wait until it is terminated + * before returning) + * * @throws IOException * in case of I/O error or if the {@link Story} was not * previously set */ - public void read() throws IOException; + public void read(boolean sync) throws IOException; /** - * Read the selected chapter (starting at 1, 0 = description, -1 = none). + * The selected chapter to start reading at (starting at 1, 0 = description, + * -1 = none). + * + * @return the chapter, or -1 for "no chapter" + */ + public int getChapter(); + + /** + * The selected chapter to start reading at (starting at 1, 0 = description, + * -1 = none). * * @param chapter * the chapter, or -1 for "no chapter" - * - * @throws IOException - * in case of I/O error or if the {@link Story} was not - * previously set */ - public void read(int chapter) throws IOException; + public void setChapter(int chapter); /** * Start the reader in browse mode for the given source (or pass NULL for * all sources). + *
+ * Note that this must be a synchronous action. * * @param source * the type of {@link Story} to take into account, or NULL for * all + * + * @throws IOException + * in case of I/O error + */ + public void browse(String source) throws IOException; + + /** + * Display all supports that allow search operations. + * + * @param sync + * execute the process synchronously (wait until it is terminated + * before returning) + * + * @throws IOException + * in case of I/O error + */ + public void search(boolean sync) throws IOException; + + /** + * Search for the given terms and find stories that correspond if possible. + * + * @param searchOn + * the website to search on + * @param keywords + * the words to search for (cannot be NULL) + * @param page + * the page of results to show (0 = request the maximum number of + * pages, pages start at 1) + * @param item + * the item to select (0 = do not select a specific item but show + * all the page, items start at 1) + * @param sync + * execute the process synchronously (wait until it is terminated + * before returning) + * + * @throws IOException + * in case of I/O error + */ + public void search(SupportType searchOn, String keywords, int page, + int item, boolean sync) throws IOException; + + /** + * Search based upon a hierarchy of tags, or search for (sub)tags. + *
+ * We use the tags DisplayName. + *
+ * If no tag is given, the main tags will be shown. + *
+ * If a non-leaf tag is given, the subtags will be shown. + *
+ * If a leaf tag is given (or a full hierarchy ending with a leaf tag), + * stories will be shown. + *
+ * You can select the story you want with the item number. + * + * @param searchOn + * the website to search on + * @param page + * the page of results to show (0 = request the maximum number of + * pages, pages start at 1) + * @param item + * the item to select (0 = do not select a specific item but show + * all the page, items start at 1) + * @param sync + * execute the process synchronously (wait until it is terminated + * before returning) + * @param tags + * the tags indices to search for (this is a tag + * hierarchy, NOT a multiple tags choice) + * + * @throws IOException + * in case of I/O error + */ + public void searchTag(SupportType searchOn, int page, int item, + boolean sync, Integer... tags) throws IOException; + + /** + * Open the {@link Story} with an external reader (the program should 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 + * @param sync + * execute the process synchronously (wait until it is terminated + * before returning) + * + * @throws IOException + * in case of I/O error */ - public void browse(String source); + public void openExternal(BasicLibrary lib, String luid, boolean sync) + throws IOException; }