| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="de"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>package org.apache.archiva.components.graph.api;<a name="line.1"></a> |
| <span class="sourceLineNo">002</span>/*<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * software distributed under the License is distributed on an<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * KIND, either express or implied. See the License for the<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * specific language governing permissions and limitations<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> * under the License.<a name="line.18"></a> |
| <span class="sourceLineNo">019</span> */<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.List;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Set;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * A graph is the container for nodes. The nodes are connected by edges. Each node and<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * edge instance is coupled to the graph where it was created.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> *<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * @param <V><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>public interface Graph<V extends Node<V>><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>{<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> /**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Creates a node with the given label in the graph. The id of the node is generated<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * by the graph implementation.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * The method returns always a new node instance, even if a node with the given label<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * exists already.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @param label the label of the new node<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @return a new node instance with the given label and a generated id<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> V newNode( String label );<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Adds a new node if the id does not exist yet, otherwise returns the node with the given id<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * and the new label set.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param id the id of the node<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param label the label of the node<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @return a new node instance or the existing node with the given id<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> V addNode( String id, String label );<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> void removeNode( V node );<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Creates a new edge instance with the given label. The method returns always a new edge instance,<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * even if a edge with the given label exists already.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * The type is set to {@link StandardRelationType#DEFAULT}<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> *<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @param label the edge label<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @param sourceNode the source node<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @param destinationNode the destination node<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @return a new edge instance<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @throws IllegalArgumentException if source or destination is <code>null</code><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> Edge<V> newEdge( String label, V sourceNode, V destinationNode ) throws IllegalArgumentException;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * Creates a new edge instance with the given label. The method returns always a new edge instance,<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * even if a edge with the given label exists already.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> *<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @param type the edge type<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @param label the edge label<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param sourceNode the source node<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param destinationNode the destination node<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @return a new edge instance<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @throws IllegalArgumentException if the source or destination node is <code>null</code><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> Edge<V> newEdge( RelationType type, String label, V sourceNode, V destinationNode ) throws IllegalArgumentException;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> /**<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * Creates a new edge instance with the given id or returns the edge instance with the given id and<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * type.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * If a edge with the id exists already but with a different type it will throw a {@link IllegalArgumentException}<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> *<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @param type the type of the edge<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param id the id<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param label the edge label<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param sourceNode the source node<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param destinationNode the destination node<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @return the newly created edge instance<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @throws IllegalArgumentException if a edge instance with the given id but a different type exists already. Or if<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * source or destination node is <code>null</code><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> Edge<V> addEdge( RelationType type, String id, String label, V sourceNode, V destinationNode ) throws IllegalArgumentException;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> /**<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Creates a new edge instance with the given id or returns the edge instance with the given id.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * If the edge is newly created it will get the type {@link StandardRelationType#DEFAULT}<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> *<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @param id the id<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param label the edge label<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param sourceNode the source node<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param destinationNode the destination node<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @return the newly created edge instance<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @throws IllegalArgumentException if source or destination is <code>null</code><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> Edge<V> addEdge( String id, String label, V sourceNode, V destinationNode ) throws IllegalArgumentException;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> /**<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * Removes the edge from the graph and unregisters it from the source and destination<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> *<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @param edge the edge to remove<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> void removeEdge( Edge<V> edge );<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> /**<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * Returns the node with the given id<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> *<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @param id the node id<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * @return the found node, or <code>null</code>, if it does not exist<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> */<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> V getNode( String id );<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /**<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * Finds nodes using a given query. The query syntax depends on the graph implementation.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> *<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @param query the query to find nodes<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @return the found nodes, or a empty list<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> */<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> List<V> findNodes( String query );<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> /**<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * Returns the edge with the given id.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> *<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param id the edge id<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @return the found edge instance, or <code>null</code>, if it does not exist<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> Edge<V> getEdge( String id );<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * Returns all nodes of the graph<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> *<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @return the set of nodes that build the graph<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> */<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> Set<V> getNodes( );<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span>}<a name="line.151"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
