org.apache.archiva.components.graph.base

Class DirectedGraph<V extends Node<V>>

java.lang.Object

org.apache.archiva.components.graph.base.DirectedGraph<V>

Type Parameters:

V - The node implementation.

All Implemented Interfaces:

Graph<V>

Direct Known Subclasses:

SimpleGraph

public abstract class DirectedGraph<V extends Node<V>>
extends Object
implements Graph<V>

Abstract implementation of a directed graph

Field Summary

Fields

Modifier and Type	Field and Description
protected TreeMap<String,Edge<V>>	edges
protected TreeMap<String,V>	nodes

Constructor Summary

Constructors

Constructor and Description
DirectedGraph()

Method Summary

Modifier and Type	Method and Description
Edge<V>	addEdge(RelationType type, String id, String label, V sourceNode, V destinationNode) Creates a new edge instance with the given id or returns the edge instance with the given id and type.
Edge<V>	addEdge(String id, String label, V sourceNode, V destinationNode) Creates a new edge instance with the given id or returns the edge instance with the given id.
V	addNode(String id, String label) Adds a new node if the id does not exist yet, otherwise returns the node with the given id and the new label set.
protected Edge<V>	createNewEdge(RelationType type, V sourceNode, V destinationNode) Creates a new edge instance on each method call.
protected V	createNewNode()
List<V>	findNodes(String query) Finds nodes using a given query.
Edge<V>	getEdge(String id) Returns the edge with the given id.
V	getNode(String id) Returns the node with the given id
Set<V>	getNodes() Returns all nodes of the graph
Edge<V>	newEdge(RelationType type, String label, V sourceNode, V destinationNode) Creates a new edge instance with the given label.
Edge<V>	newEdge(String label, V sourceNode, V destinationNode) Creates a new edge instance with the given label.
V	newNode(String label) Creates a node with the given label in the graph.
void	removeEdge(Edge<V> edge) Removes the edge from the graph and unregisters it from the source and destination
void	removeNode(V node)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nodes

protected TreeMap<String,V extends Node<V>> nodes

edges

protected TreeMap<String,Edge<V extends Node<V>>> edges

Constructor Detail

DirectedGraph

public DirectedGraph()

Method Detail

newNode

public V newNode(String label)

Description copied from interface: Graph

Creates a node with the given label in the graph. The id of the node is generated by the graph implementation. The method returns always a new node instance, even if a node with the given label exists already.

Specified by:

newNode in interface Graph<V extends Node<V>>

Parameters:

label - the label of the new node

Returns:

a new node instance with the given label and a generated id

addNode

public V addNode(String id,
                 String label)

Description copied from interface: Graph

Adds a new node if the id does not exist yet, otherwise returns the node with the given id and the new label set.

Specified by:

addNode in interface Graph<V extends Node<V>>

Parameters:

id - the id of the node

label - the label of the node

Returns:

a new node instance or the existing node with the given id

createNewNode

protected V createNewNode()

createNewEdge

protected Edge<V> createNewEdge(RelationType type,
                                V sourceNode,
                                V destinationNode)

Creates a new edge instance on each method call. The id will be a generated UUID.

Parameters:

type - the relation type

sourceNode - the source node

destinationNode - the destination node

Returns:

the new edge instance

newEdge

public Edge<V> newEdge(String label,
                       V sourceNode,
                       V destinationNode)

Description copied from interface: Graph

Creates a new edge instance with the given label. The method returns always a new edge instance, even if a edge with the given label exists already. The type is set to StandardRelationType.DEFAULT

Specified by:

newEdge in interface Graph<V extends Node<V>>

Parameters:

label - the edge label

sourceNode - the source node

destinationNode - the destination node

Returns:

a new edge instance

newEdge

public Edge<V> newEdge(RelationType type,
                       String label,
                       V sourceNode,
                       V destinationNode)

Description copied from interface: Graph

Creates a new edge instance with the given label. The method returns always a new edge instance, even if a edge with the given label exists already.

Specified by:

newEdge in interface Graph<V extends Node<V>>

Parameters:

type - the edge type

label - the edge label

sourceNode - the source node

destinationNode - the destination node

Returns:

a new edge instance

addEdge

public Edge<V> addEdge(RelationType type,
                       String id,
                       String label,
                       V sourceNode,
                       V destinationNode)
                throws IllegalArgumentException

Description copied from interface: Graph

Creates a new edge instance with the given id or returns the edge instance with the given id and type. If a edge with the id exists already but with a different type it will throw a IllegalArgumentException

Specified by:

addEdge in interface Graph<V extends Node<V>>

Parameters:

type - the type of the edge

id - the id

label - the edge label

sourceNode - the source node

destinationNode - the destination node

Returns:

the newly created edge instance

Throws:

IllegalArgumentException - if a edge instance with the given id but a different type exists already. Or if source or destination node is null

addEdge

public Edge<V> addEdge(String id,
                       String label,
                       V sourceNode,
                       V destinationNode)
                throws IllegalArgumentException

Description copied from interface: Graph

Creates a new edge instance with the given id or returns the edge instance with the given id. If the edge is newly created it will get the type StandardRelationType.DEFAULT

Specified by:

addEdge in interface Graph<V extends Node<V>>

Parameters:

id - the id

label - the edge label

sourceNode - the source node

destinationNode - the destination node

Returns:

the newly created edge instance

Throws:

IllegalArgumentException - if source or destination is null

getNode

public V getNode(String id)

Description copied from interface: Graph

Returns the node with the given id

Specified by:

getNode in interface Graph<V extends Node<V>>

Parameters:

id - the node id

Returns:

the found node, or null, if it does not exist

getEdge

public Edge<V> getEdge(String id)

Description copied from interface: Graph

Returns the edge with the given id.

Specified by:

getEdge in interface Graph<V extends Node<V>>

Parameters:

id - the edge id

Returns:

the found edge instance, or null, if it does not exist

getNodes

public Set<V> getNodes()

Description copied from interface: Graph

Returns all nodes of the graph

Specified by:

getNodes in interface Graph<V extends Node<V>>

Returns:

the set of nodes that build the graph

findNodes

public List<V> findNodes(String query)

Description copied from interface: Graph

Finds nodes using a given query. The query syntax depends on the graph implementation.

Specified by:

findNodes in interface Graph<V extends Node<V>>

Parameters:

query - the query to find nodes

Returns:

the found nodes, or a empty list

removeNode

public void removeNode(V node)

Specified by:

removeNode in interface Graph<V extends Node<V>>

removeEdge

public void removeEdge(Edge<V> edge)

Description copied from interface: Graph

Removes the edge from the graph and unregisters it from the source and destination

Specified by:

removeEdge in interface Graph<V extends Node<V>>

Parameters:

edge - the edge to remove