X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Freader%2FReader.java;h=3ecf2470021b4f6d259db9ee8b80eac9ff8a266a;hb=1387a30ab59dbf4071f2c5e5e0e08ca98c75b726;hp=5fe1c5d67d55bef4993bcd6e55ce7f6c95d8bb6d;hpb=b4f9071c1bd4534e9cca989f1e873310c94986c3;p=nikiroo-utils.git

diff --git a/src/be/nikiroo/fanfix/reader/Reader.java b/src/be/nikiroo/fanfix/reader/Reader.java
index 5fe1c5d..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;
 
 /**
@@ -70,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
@@ -130,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,
@@ -156,24 +165,103 @@ public interface Reader {
 	/**
 	 * Start the reader in browse mode for the given source (or pass NULL for
 	 * all sources).
+	 * <p>
+	 * Note that this must be a <b>synchronous</b> 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.
+	 * <p>
+	 * We use the tags <tt>DisplayName</tt>.
+	 * <p>
+	 * If no tag is given, the main tags will be shown.
+	 * <p>
+	 * If a non-leaf tag is given, the subtags will be shown.
+	 * <p>
+	 * If a leaf tag is given (or a full hierarchy ending with a leaf tag),
+	 * stories will be shown.
+	 * <p>
+	 * You can select the story you want with the <tt>item</tt> number.
+	 * 
+	 * @param searchOn
+	 *            the website to search on
+	 * @param page
+	 *            the page of results to show (0 = request the maximum number of
+	 *            pages, pages <b>start at 1</b>)
+	 * @param item
+	 *            the item to select (0 = do not select a specific item but show
+	 *            all the page, items <b>start at 1</b>)
+	 * @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
+	 *            <b>hierarchy</b>, <b>NOT</b> 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;
 }