<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> package org.maltparser.core.syntaxgraph.reader;<a name="line.1"></a>
<FONT color="green">002</FONT> <a name="line.2"></a>
<FONT color="green">003</FONT> import java.io.InputStream;<a name="line.3"></a>
<FONT color="green">004</FONT> import java.io.InputStreamReader;<a name="line.4"></a>
<FONT color="green">005</FONT> import java.net.URL;<a name="line.5"></a>
<FONT color="green">006</FONT> <a name="line.6"></a>
<FONT color="green">007</FONT> import org.maltparser.core.exception.MaltChainedException;<a name="line.7"></a>
<FONT color="green">008</FONT> import org.maltparser.core.io.dataformat.DataFormatInstance;<a name="line.8"></a>
<FONT color="green">009</FONT> import org.maltparser.core.syntaxgraph.TokenStructure;<a name="line.9"></a>
<FONT color="green">010</FONT> <a name="line.10"></a>
<FONT color="green">011</FONT> /**<a name="line.11"></a>
<FONT color="green">012</FONT> *<a name="line.12"></a>
<FONT color="green">013</FONT> *<a name="line.13"></a>
<FONT color="green">014</FONT> * @author Johan Hall<a name="line.14"></a>
<FONT color="green">015</FONT> */<a name="line.15"></a>
<FONT color="green">016</FONT> public interface SyntaxGraphReader {<a name="line.16"></a>
<FONT color="green">017</FONT> /**<a name="line.17"></a>
<FONT color="green">018</FONT> * Opens a file for read only<a name="line.18"></a>
<FONT color="green">019</FONT> * <a name="line.19"></a>
<FONT color="green">020</FONT> * @param fileName the file name of the file<a name="line.20"></a>
<FONT color="green">021</FONT> * @param charsetName the name of the character encoding set <a name="line.21"></a>
<FONT color="green">022</FONT> * @throws MaltChainedException<a name="line.22"></a>
<FONT color="green">023</FONT> */<a name="line.23"></a>
<FONT color="green">024</FONT> public void open(String fileName, String charsetName) throws MaltChainedException;<a name="line.24"></a>
<FONT color="green">025</FONT> /**<a name="line.25"></a>
<FONT color="green">026</FONT> * Opens an URL for read only<a name="line.26"></a>
<FONT color="green">027</FONT> * <a name="line.27"></a>
<FONT color="green">028</FONT> * @param url the URL of the resource<a name="line.28"></a>
<FONT color="green">029</FONT> * @param charsetName the name of the character encoding set <a name="line.29"></a>
<FONT color="green">030</FONT> * @throws MaltChainedException<a name="line.30"></a>
<FONT color="green">031</FONT> */<a name="line.31"></a>
<FONT color="green">032</FONT> public void open(URL url, String charsetName) throws MaltChainedException;<a name="line.32"></a>
<FONT color="green">033</FONT> /**<a name="line.33"></a>
<FONT color="green">034</FONT> * Opens an input stream<a name="line.34"></a>
<FONT color="green">035</FONT> * <a name="line.35"></a>
<FONT color="green">036</FONT> * @param is an input stream<a name="line.36"></a>
<FONT color="green">037</FONT> * @param charsetName the name of the character encoding set <a name="line.37"></a>
<FONT color="green">038</FONT> * @throws MaltChainedException<a name="line.38"></a>
<FONT color="green">039</FONT> */<a name="line.39"></a>
<FONT color="green">040</FONT> public void open(InputStream is, String charsetName) throws MaltChainedException;<a name="line.40"></a>
<FONT color="green">041</FONT> /**<a name="line.41"></a>
<FONT color="green">042</FONT> * Cause the syntax graph reader to read the beginning of the file (such as header information)<a name="line.42"></a>
<FONT color="green">043</FONT> * <a name="line.43"></a>
<FONT color="green">044</FONT> * @throws MaltChainedException<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> public void readProlog() throws MaltChainedException;<a name="line.46"></a>
<FONT color="green">047</FONT> <a name="line.47"></a>
<FONT color="green">048</FONT> /**<a name="line.48"></a>
<FONT color="green">049</FONT> * Reads a sentence (token structure, dependency structure or/and phrase structure)<a name="line.49"></a>
<FONT color="green">050</FONT> * <a name="line.50"></a>
<FONT color="green">051</FONT> * @param syntaxGraph a syntax graph (token structure, dependency structure or/and phrase structure)<a name="line.51"></a>
<FONT color="green">052</FONT> * @return true if there is more sentences to be processed, otherwise false.<a name="line.52"></a>
<FONT color="green">053</FONT> * @throws MaltChainedException<a name="line.53"></a>
<FONT color="green">054</FONT> */<a name="line.54"></a>
<FONT color="green">055</FONT> public boolean readSentence(TokenStructure syntaxGraph) throws MaltChainedException;<a name="line.55"></a>
<FONT color="green">056</FONT> /**<a name="line.56"></a>
<FONT color="green">057</FONT> * Reads the end of the file, after all sentences have been processed, <a name="line.57"></a>
<FONT color="green">058</FONT> * <a name="line.58"></a>
<FONT color="green">059</FONT> * @throws MaltChainedException<a name="line.59"></a>
<FONT color="green">060</FONT> */<a name="line.60"></a>
<FONT color="green">061</FONT> public void readEpilog() throws MaltChainedException;<a name="line.61"></a>
<FONT color="green">062</FONT> /**<a name="line.62"></a>
<FONT color="green">063</FONT> * Returns the current number of the sentence.<a name="line.63"></a>
<FONT color="green">064</FONT> * <a name="line.64"></a>
<FONT color="green">065</FONT> * @return the current number of the sentence.<a name="line.65"></a>
<FONT color="green">066</FONT> * @throws MaltChainedException<a name="line.66"></a>
<FONT color="green">067</FONT> */<a name="line.67"></a>
<FONT color="green">068</FONT> public int getSentenceCount() throws MaltChainedException;<a name="line.68"></a>
<FONT color="green">069</FONT> /**<a name="line.69"></a>
<FONT color="green">070</FONT> * Returns the input data format instance<a name="line.70"></a>
<FONT color="green">071</FONT> * <a name="line.71"></a>
<FONT color="green">072</FONT> * @return the input data format instance<a name="line.72"></a>
<FONT color="green">073</FONT> */<a name="line.73"></a>
<FONT color="green">074</FONT> public DataFormatInstance getDataFormatInstance();<a name="line.74"></a>
<FONT color="green">075</FONT> /**<a name="line.75"></a>
<FONT color="green">076</FONT> * Sets the input data format instance<a name="line.76"></a>
<FONT color="green">077</FONT> * <a name="line.77"></a>
<FONT color="green">078</FONT> * @param dataFormatInstance an input data format instance<a name="line.78"></a>
<FONT color="green">079</FONT> */<a name="line.79"></a>
<FONT color="green">080</FONT> public void setDataFormatInstance(DataFormatInstance dataFormatInstance);<a name="line.80"></a>
<FONT color="green">081</FONT> /**<a name="line.81"></a>
<FONT color="green">082</FONT> * Returns a string representation of the reader specific options.<a name="line.82"></a>
<FONT color="green">083</FONT> * <a name="line.83"></a>
<FONT color="green">084</FONT> * @return a string representation of the reader specific options.<a name="line.84"></a>
<FONT color="green">085</FONT> */<a name="line.85"></a>
<FONT color="green">086</FONT> public String getOptions();<a name="line.86"></a>
<FONT color="green">087</FONT> /**<a name="line.87"></a>
<FONT color="green">088</FONT> * Sets the reader specific options.<a name="line.88"></a>
<FONT color="green">089</FONT> * <a name="line.89"></a>
<FONT color="green">090</FONT> * @param optionString a string representation of the reader specific options<a name="line.90"></a>
<FONT color="green">091</FONT> * @throws MaltChainedException<a name="line.91"></a>
<FONT color="green">092</FONT> */<a name="line.92"></a>
<FONT color="green">093</FONT> public void setOptions(String optionString) throws MaltChainedException;<a name="line.93"></a>
<FONT color="green">094</FONT> /**<a name="line.94"></a>
<FONT color="green">095</FONT> * Closes the file or the input stream.<a name="line.95"></a>
<FONT color="green">096</FONT> * <a name="line.96"></a>
<FONT color="green">097</FONT> * @throws MaltChainedException<a name="line.97"></a>
<FONT color="green">098</FONT> */<a name="line.98"></a>
<FONT color="green">099</FONT> public void close() throws MaltChainedException;<a name="line.99"></a>
<FONT color="green">100</FONT> <a name="line.100"></a>
<FONT color="green">101</FONT> public int getNIterations();<a name="line.101"></a>
<FONT color="green">102</FONT> public void setNIterations(int iterations);<a name="line.102"></a>
<FONT color="green">103</FONT> public int getIterationCounter();<a name="line.103"></a>
<FONT color="green">104</FONT> }<a name="line.104"></a>
</PRE>
</BODY>
</HTML>