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=f98f12c53f0c21b811341bc79703799bbc646080;hpb=16a81ef7656c5c692fb831927e75edde25dd77a0;p=fanfix.git diff --git a/src/be/nikiroo/fanfix/reader/Reader.java b/src/be/nikiroo/fanfix/reader/Reader.java index f98f12c..3ecf247 100644 --- a/src/be/nikiroo/fanfix/reader/Reader.java +++ b/src/be/nikiroo/fanfix/reader/Reader.java @@ -6,6 +6,7 @@ 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.supported.SupportType; import be.nikiroo.utils.Progress; /** @@ -27,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, ; @@ -45,6 +48,8 @@ public interface Reader { return pkg + "tui.TuiReader"; case GUI: return pkg + "ui.GuiReader"; + case ANDROID: + return pkg + "android.AndroidReader"; } return null; @@ -66,8 +71,12 @@ public interface Reader { * the optional progress * * @return the {@link Story} + * + * @throws IOException + * in case of I/O error + * */ - public Story getStory(Progress pg); + public Story getStory(Progress pg) throws IOException; /** * The {@link BasicLibrary} to load the stories from (by default, takes the @@ -126,11 +135,15 @@ public interface Reader { /** * 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; /** * The selected chapter to start reading at (starting at 1, 0 = description, @@ -152,24 +165,103 @@ public interface Reader { /** * 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 browse(String source); + 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 will be + * 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 openExternal(BasicLibrary lib, String luid) throws IOException; + public void openExternal(BasicLibrary lib, String luid, boolean sync) + throws IOException; }