<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> package org.maltparser.core.syntaxgraph;<a name="line.1"></a>
<FONT color="green">002</FONT> <a name="line.2"></a>
<FONT color="green">003</FONT> import java.util.SortedMap;<a name="line.3"></a>
<FONT color="green">004</FONT> import java.util.SortedSet;<a name="line.4"></a>
<FONT color="green">005</FONT> <a name="line.5"></a>
<FONT color="green">006</FONT> import org.maltparser.core.exception.MaltChainedException;<a name="line.6"></a>
<FONT color="green">007</FONT> import org.maltparser.core.symbol.SymbolTable;<a name="line.7"></a>
<FONT color="green">008</FONT> import org.maltparser.core.syntaxgraph.edge.Edge;<a name="line.8"></a>
<FONT color="green">009</FONT> import org.maltparser.core.syntaxgraph.node.DependencyNode;<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> * @author Johan Hall<a name="line.13"></a>
<FONT color="green">014</FONT> */<a name="line.14"></a>
<FONT color="green">015</FONT> public interface DependencyStructure extends TokenStructure, SecEdgeStructure {<a name="line.15"></a>
<FONT color="green">016</FONT> public DependencyNode addDependencyNode() throws MaltChainedException;<a name="line.16"></a>
<FONT color="green">017</FONT> public DependencyNode addDependencyNode(int index) throws MaltChainedException;<a name="line.17"></a>
<FONT color="green">018</FONT> /**<a name="line.18"></a>
<FONT color="green">019</FONT> * Returns the dependency node identified by <i>index</i> if it exists, otherwise <i>null</i>.<a name="line.19"></a>
<FONT color="green">020</FONT> * <a name="line.20"></a>
<FONT color="green">021</FONT> * @param index the index of the dependency node<a name="line.21"></a>
<FONT color="green">022</FONT> * @return the dependency node identified by <i>index</i> if it exists, otherwise <i>null</i>.<a name="line.22"></a>
<FONT color="green">023</FONT> * @throws MaltChainedException<a name="line.23"></a>
<FONT color="green">024</FONT> */<a name="line.24"></a>
<FONT color="green">025</FONT> public DependencyNode getDependencyNode(int index) throws MaltChainedException;<a name="line.25"></a>
<FONT color="green">026</FONT> public int nDependencyNode();<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> public int getHighestDependencyNodeIndex();<a name="line.29"></a>
<FONT color="green">030</FONT> /**<a name="line.30"></a>
<FONT color="green">031</FONT> * Adds an edge from the head to the dependent identified by the indices of the dependency nodes.<a name="line.31"></a>
<FONT color="green">032</FONT> * <a name="line.32"></a>
<FONT color="green">033</FONT> * @param headIndex the index of the head dependency node<a name="line.33"></a>
<FONT color="green">034</FONT> * @param dependentIndex the index of the dependent dependency node<a name="line.34"></a>
<FONT color="green">035</FONT> * @return the edge that have been added.<a name="line.35"></a>
<FONT color="green">036</FONT> * @throws MaltChainedException<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public Edge addDependencyEdge(int headIndex, int dependentIndex) throws MaltChainedException;<a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * Replace the head of the dependent with a new head. The labels are not affected.<a name="line.40"></a>
<FONT color="green">041</FONT> * <a name="line.41"></a>
<FONT color="green">042</FONT> * @param newHeadIndex the index of the new head dependency node<a name="line.42"></a>
<FONT color="green">043</FONT> * @param dependentIndex the index of the dependent dependency node<a name="line.43"></a>
<FONT color="green">044</FONT> * @return the edge that have been moved.<a name="line.44"></a>
<FONT color="green">045</FONT> * @throws MaltChainedException<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> public Edge moveDependencyEdge(int newHeadIndex, int dependentIndex) throws MaltChainedException;<a name="line.47"></a>
<FONT color="green">048</FONT> /**<a name="line.48"></a>
<FONT color="green">049</FONT> * Remove an edge from the head to the dependent identified by the indices of the dependency nodes.<a name="line.49"></a>
<FONT color="green">050</FONT> * @param headIndex the index of the head dependency node<a name="line.50"></a>
<FONT color="green">051</FONT> * @param dependentIndex the index of the dependent dependency node<a name="line.51"></a>
<FONT color="green">052</FONT> * @throws MaltChainedException<a name="line.52"></a>
<FONT color="green">053</FONT> */<a name="line.53"></a>
<FONT color="green">054</FONT> public void removeDependencyEdge(int headIndex, int dependentIndex) throws MaltChainedException;<a name="line.54"></a>
<FONT color="green">055</FONT> /**<a name="line.55"></a>
<FONT color="green">056</FONT> * Returns the number of edges<a name="line.56"></a>
<FONT color="green">057</FONT> * <a name="line.57"></a>
<FONT color="green">058</FONT> * @return the number of edges<a name="line.58"></a>
<FONT color="green">059</FONT> */<a name="line.59"></a>
<FONT color="green">060</FONT> public int nEdges();<a name="line.60"></a>
<FONT color="green">061</FONT> public SortedSet<Edge> getEdges();<a name="line.61"></a>
<FONT color="green">062</FONT> /**<a name="line.62"></a>
<FONT color="green">063</FONT> * Returns a sorted set of integers {0,s,..n} , where each index i identifies a dependency node. Index 0<a name="line.63"></a>
<FONT color="green">064</FONT> * should always be the root dependency node and index s is the first terminal node and index n is the<a name="line.64"></a>
<FONT color="green">065</FONT> * last terminal node. <a name="line.65"></a>
<FONT color="green">066</FONT> * <a name="line.66"></a>
<FONT color="green">067</FONT> * @return a sorted set of integers<a name="line.67"></a>
<FONT color="green">068</FONT> */<a name="line.68"></a>
<FONT color="green">069</FONT> public SortedSet<Integer> getDependencyIndices();<a name="line.69"></a>
<FONT color="green">070</FONT> /**<a name="line.70"></a>
<FONT color="green">071</FONT> * Returns the root of the dependency structure.<a name="line.71"></a>
<FONT color="green">072</FONT> * <a name="line.72"></a>
<FONT color="green">073</FONT> * @return the root of the dependency structure.<a name="line.73"></a>
<FONT color="green">074</FONT> */<a name="line.74"></a>
<FONT color="green">075</FONT> public DependencyNode getDependencyRoot();<a name="line.75"></a>
<FONT color="green">076</FONT> /**<a name="line.76"></a>
<FONT color="green">077</FONT> * Returns <i>true</i> if the head edge of the dependency node with <i>index</i> is labeled, otherwise <i>false</i>.<a name="line.77"></a>
<FONT color="green">078</FONT> * <a name="line.78"></a>
<FONT color="green">079</FONT> * @param index the index of the dependency node<a name="line.79"></a>
<FONT color="green">080</FONT> * @return <i>true</i> if the head edge of the dependency node with <i>index</i> is labeled, otherwise <i>false</i>.<a name="line.80"></a>
<FONT color="green">081</FONT> * @throws MaltChainedException<a name="line.81"></a>
<FONT color="green">082</FONT> */<a name="line.82"></a>
<FONT color="green">083</FONT> public boolean hasLabeledDependency(int index) throws MaltChainedException;<a name="line.83"></a>
<FONT color="green">084</FONT> /**<a name="line.84"></a>
<FONT color="green">085</FONT> * Returns <i>true</i> if all nodes in the dependency structure are connected, otherwise <i>false</i>.<a name="line.85"></a>
<FONT color="green">086</FONT> * <a name="line.86"></a>
<FONT color="green">087</FONT> * @return <i>true</i> if all nodes in the dependency structure are connected, otherwise <i>false</i>.<a name="line.87"></a>
<FONT color="green">088</FONT> */<a name="line.88"></a>
<FONT color="green">089</FONT> public boolean isConnected();<a name="line.89"></a>
<FONT color="green">090</FONT> /**<a name="line.90"></a>
<FONT color="green">091</FONT> * Returns <i>true</i> if all edges in the dependency structure are projective, otherwise <i>false</i>.<a name="line.91"></a>
<FONT color="green">092</FONT> * <a name="line.92"></a>
<FONT color="green">093</FONT> * @return <i>true</i> if all edges in the dependency structure are projective, otherwise <i>false</i>.<a name="line.93"></a>
<FONT color="green">094</FONT> * @throws MaltChainedException<a name="line.94"></a>
<FONT color="green">095</FONT> */<a name="line.95"></a>
<FONT color="green">096</FONT> public boolean isProjective() throws MaltChainedException;<a name="line.96"></a>
<FONT color="green">097</FONT> /**<a name="line.97"></a>
<FONT color="green">098</FONT> * Returns <i>true</i> if all dependency nodes have at most one incoming edge, otherwise <i>false</i>.<a name="line.98"></a>
<FONT color="green">099</FONT> * <a name="line.99"></a>
<FONT color="green">100</FONT> * @return <i>true</i> if all dependency nodes have at most one incoming edge, otherwise <i>false</i>.<a name="line.100"></a>
<FONT color="green">101</FONT> */<a name="line.101"></a>
<FONT color="green">102</FONT> public boolean isSingleHeaded();<a name="line.102"></a>
<FONT color="green">103</FONT> /**<a name="line.103"></a>
<FONT color="green">104</FONT> * Returns <i>true</i> if the dependency structure are a tree (isConnected() && isSingleHeaded()), otherwise <i>false</i>.<a name="line.104"></a>
<FONT color="green">105</FONT> * <a name="line.105"></a>
<FONT color="green">106</FONT> * @return <i>true</i> if the dependency structure are a tree (isConnected() && isSingleHeaded()), otherwise <i>false</i>.<a name="line.106"></a>
<FONT color="green">107</FONT> */ <a name="line.107"></a>
<FONT color="green">108</FONT> public boolean isTree();<a name="line.108"></a>
<FONT color="green">109</FONT> /**<a name="line.109"></a>
<FONT color="green">110</FONT> * Returns the number of non-projective edges in the dependency structure.<a name="line.110"></a>
<FONT color="green">111</FONT> * <a name="line.111"></a>
<FONT color="green">112</FONT> * @return the number of non-projective edges in the dependency structure.<a name="line.112"></a>
<FONT color="green">113</FONT> * @throws MaltChainedException<a name="line.113"></a>
<FONT color="green">114</FONT> */<a name="line.114"></a>
<FONT color="green">115</FONT> public int nNonProjectiveEdges() throws MaltChainedException;<a name="line.115"></a>
<FONT color="green">116</FONT> /**<a name="line.116"></a>
<FONT color="green">117</FONT> * Links all subtrees to the root of the dependency structure.<a name="line.117"></a>
<FONT color="green">118</FONT> * <a name="line.118"></a>
<FONT color="green">119</FONT> * @throws MaltChainedException<a name="line.119"></a>
<FONT color="green">120</FONT> */<a name="line.120"></a>
<FONT color="green">121</FONT> public void linkAllTreesToRoot() throws MaltChainedException;<a name="line.121"></a>
<FONT color="green">122</FONT> <a name="line.122"></a>
<FONT color="green">123</FONT> <a name="line.123"></a>
<FONT color="green">124</FONT> public LabelSet getDefaultRootEdgeLabels() throws MaltChainedException;<a name="line.124"></a>
<FONT color="green">125</FONT> /**<a name="line.125"></a>
<FONT color="green">126</FONT> * Returns the default edge label of the root as a string value.<a name="line.126"></a>
<FONT color="green">127</FONT> * <a name="line.127"></a>
<FONT color="green">128</FONT> * @param table the symbol table that identifies the label type.<a name="line.128"></a>
<FONT color="green">129</FONT> * @return the default edge label of the root.<a name="line.129"></a>
<FONT color="green">130</FONT> * @throws MaltChainedException<a name="line.130"></a>
<FONT color="green">131</FONT> */<a name="line.131"></a>
<FONT color="green">132</FONT> public String getDefaultRootEdgeLabelSymbol(SymbolTable table) throws MaltChainedException;<a name="line.132"></a>
<FONT color="green">133</FONT> /**<a name="line.133"></a>
<FONT color="green">134</FONT> * Returns the default edge label of the root as an integer value.<a name="line.134"></a>
<FONT color="green">135</FONT> * <a name="line.135"></a>
<FONT color="green">136</FONT> * @param table the symbol table that identifies the label type.<a name="line.136"></a>
<FONT color="green">137</FONT> * @return the default edge label of the root as an integer value.<a name="line.137"></a>
<FONT color="green">138</FONT> * @throws MaltChainedException<a name="line.138"></a>
<FONT color="green">139</FONT> */<a name="line.139"></a>
<FONT color="green">140</FONT> public int getDefaultRootEdgeLabelCode(SymbolTable table) throws MaltChainedException;<a name="line.140"></a>
<FONT color="green">141</FONT> /**<a name="line.141"></a>
<FONT color="green">142</FONT> * Sets the default edge label of the root.<a name="line.142"></a>
<FONT color="green">143</FONT> * <a name="line.143"></a>
<FONT color="green">144</FONT> * @param table the symbol table that identifies the label type.<a name="line.144"></a>
<FONT color="green">145</FONT> * @param defaultRootSymbol the default root edge label<a name="line.145"></a>
<FONT color="green">146</FONT> * @throws MaltChainedException<a name="line.146"></a>
<FONT color="green">147</FONT> */<a name="line.147"></a>
<FONT color="green">148</FONT> public void setDefaultRootEdgeLabel(SymbolTable table, String defaultRootSymbol) throws MaltChainedException;<a name="line.148"></a>
<FONT color="green">149</FONT> /**<a name="line.149"></a>
<FONT color="green">150</FONT> * Sets the default edge label of the root according to the default root label option<a name="line.150"></a>
<FONT color="green">151</FONT> * <a name="line.151"></a>
<FONT color="green">152</FONT> * @param rootLabelOption the default root label option<a name="line.152"></a>
<FONT color="green">153</FONT> * @param edgeSymbolTables a sorted map that maps the symbol table name to the symbol table object.<a name="line.153"></a>
<FONT color="green">154</FONT> * @throws MaltChainedException<a name="line.154"></a>
<FONT color="green">155</FONT> */<a name="line.155"></a>
<FONT color="green">156</FONT> public void setDefaultRootEdgeLabels(String rootLabelOption, SortedMap<String, SymbolTable> edgeSymbolTables) throws MaltChainedException;<a name="line.156"></a>
<FONT color="green">157</FONT> }<a name="line.157"></a>
</PRE>
</BODY>
</HTML>