Graph

Type Parameters:

V - Class of vertices this Graph will contain (extends Vertex.

E - Class of edges this Graph will have (extends Edge<V>.

All Known Implementing Classes:

AdjacencyListGraph
```
public interface Graph<V extends Vertex,E extends Edge<V>>
```
Interface that gives the methods a Graph should implement to be a real Graph. It has two parameters: the kind of vertices that contains, and the edges that join those vertices.

Author:

Antonio

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`E`	`addEdge(V source, V target)` Method that add a new edge that join the parameter vertices.
`boolean`	`addVertex(V vertex)` Method to add a new Vertex to the graph.
`default boolean`	`containsEdge(E edge)` Method to check if an edge is contained in the graph,
`default boolean`	`containsEdge(V source, V target)` Method to check if an edge with a source and target vertices is contained in the graph,
`boolean`	`containsVertex(V vertex)` Method to check if a vertex is contained in the graph,
`java.util.Set<E>`	`edgeSet()` Method that returns the set of Edges contained in this graph.
`default java.util.Set<E>`	`edgesFrom(V vertex)` Method that return a set of edge where everyone has a certain source vertex.
`default java.util.Set<E>`	`edgesOf(V vertex)` Method to get a set with all the edges that has as source or target a certain vertex.
`default java.util.Set<E>`	`edgesTo(V vertex)` Method that return a set of edge where everyone has a certain target vertex.
`default java.util.Set<E>`	`getAllEdges(V ver1, V ver2)` Method to get all the edges related with two vertices at the same time.
`default E`	`getEdge(V source, V target)` Getter method for an edge of the graph joining two vertices of the graph.
`java.lang.Class<? extends E>`	`getEdgeClass()` Method to get the Edge class of the Graph.
`EdgeFactory<V,E>`	`getEdgeFactory()` Method to get the Edge Factory to create new edges for this graph.
`default V`	`getEdgeSource(E edge)` Method to get the source vertex of an edge of the graph.
`default V`	`getEdgeTarget(E edge)` Method to get the target vertex of an edge of the graph.
`default double`	`getEdgeWeight(E edge)` Method that gets the weight of a particular edge of the graph.
`java.lang.Class<? extends V>`	`getVertexClass()` Method to get the Vertex class of the Graph.
`VertexFactory<V>`	`getVertexFactory()` Method to get the Vertex Factory to create new edges for this graph.
`default boolean`	`removeAllEdges(java.util.Collection<? extends E> edges)` Method that removes a collection of vertices.
`default java.util.Set<E>`	`removeAllEdges(V ver1, V ver2)` Method that remove the edges related to two vertices.
`default boolean`	`removeAllVertices(java.util.Collection<? extends V> vertices)` Method that removes a collection of vertices.
`boolean`	`removeEdge(E edge)` Method to remove an edge of the graph.
`default E`	`removeEdge(V source, V target)` Method to remove an edge given the source and the target vertices.
`boolean`	`removeVertex(V vertex)` Method that remove a vertex from the graph.
`default java.util.Set<V>`	`vertexFrom(V vertex)` Method to get all the vertices we can reach from a certain vertex.
`java.util.Set<V>`	`vertexSet()` Method that returns the set of Vertex contained in this graph.
`default java.util.Set<V>`	`vertexTo(V vertex)` Method to get all the vertices from we can reach a certain vertex.

- Method Detail
  - addVertex
```
boolean addVertex(V vertex)
```
    Method to add a new Vertex to the graph.
    
    Parameters:
    
    vertex - The vertex we will add.
    
    Returns:
    
    True if the vertex have been added and false if the vertex already was in the Graph.
  - addEdge
```
E addEdge(V source,
          V target)
```
    Method that add a new edge that join the parameter vertices. The two vertices should exist in the Graph. If the edge already exists, this method do nothing.
    
    Parameters:
    
    source - Vertex from the edge will go.
    
    target - Vertex to the edge will go.
    
    Returns:
    
    An edge in the graph that joins source to target or null if there is any error.
  - removeVertex
```
boolean removeVertex(V vertex)
```
    Method that remove a vertex from the graph. If the graph does not contain the vertex, this method do nothing. This method remove all the edges of the graph that have as source or target the vertex.
    
    Parameters:
    
    vertex - Vertex we want to remove.
    
    Returns:
    
    True if the vertex was successfully removed and false if the graph does not contain the vertex.
  - removeAllVertices
```
default boolean removeAllVertices(java.util.Collection<? extends V> vertices)
```
    Method that removes a collection of vertices. It calls the method removeVertex(Vertex).
    
    Parameters:
    
    vertices - Collection of vertices to remove.
    
    Returns:
    
    True if the graph has changed and false otherwise.
  - removeEdge
```
boolean removeEdge(E edge)
```
    Method to remove an edge of the graph.
    
    Parameters:
    
    edge - Edge we want to remove from the graph.
    
    Returns:
    
    True if the edge was successfully removed and false if the edge was not contained in the graph.
  - removeEdge
```
default E removeEdge(V source,
                     V target)
```
    Method to remove an edge given the source and the target vertices. It returns the edge removed, so returns null when the edge does not exist.
    
    Parameters:
    
    source - Source vertex of the edge we want remove.
    
    target - Target vertex of the edge we want remove.
    
    Returns:
    
    The edge removed and null if it does not exist.
  - removeAllEdges
```
default boolean removeAllEdges(java.util.Collection<? extends E> edges)
```
    Method that removes a collection of vertices. It calls the method removeEdge(Edge).
    
    Parameters:
    
    edges - Collection of edges to remove.
    
    Returns:
    
    True if the graph has changed and false otherwise.
  - removeAllEdges
```
default java.util.Set<E> removeAllEdges(V ver1,
                                        V ver2)
```
    Method that remove the edges related to two vertices. As these graphs are not multi-graphs, this method will remove two, one or none edges.
    
    Parameters:
    
    ver1 - One vertex.
    
    ver2 - Another vertex.
    
    Returns:
    
    The set of edges removed from the graph or an empty set if no edge has been removed.
  - getVertexFactory
```
VertexFactory<V> getVertexFactory()
```
    Method to get the Vertex Factory to create new edges for this graph.
    
    Returns:
    
    A factory of type VertexFactory<V>
  - getEdgeFactory
```
EdgeFactory<V,E> getEdgeFactory()
```
    Method to get the Edge Factory to create new edges for this graph.
    
    Returns:
    
    A factory of type EdgeFactory<V,E>
  - vertexSet
```
java.util.Set<V> vertexSet()
```
    Method that returns the set of Vertex contained in this graph.
    
    Returns:
    
    Set of the vertex.
  - edgeSet
```
java.util.Set<E> edgeSet()
```
    Method that returns the set of Edges contained in this graph.
    
    Returns:
    
    Set of the vertex.
  - getEdge
```
default E getEdge(V source,
                  V target)
```
    Getter method for an edge of the graph joining two vertices of the graph.
    
    Parameters:
    
    source - Source vertex of the edge returned.
    
    target - Target vertex of the edge returned.
    
    Returns:
    
    The edge joining the two parameters. It returns null if any vertex are not included in the graph or if the edge does not exist.
  - getEdgeSource
```
default V getEdgeSource(E edge)
```
    Method to get the source vertex of an edge of the graph.
    
    Parameters:
    
    edge - Edge where we want to look.
    
    Returns:
    
    The source vertex of the parameter. Null if the edge is not included in the graph.
  - getEdgeTarget
```
default V getEdgeTarget(E edge)
```
    Method to get the target vertex of an edge of the graph.
    
    Parameters:
    
    edge - Edge where we want to look.
    
    Returns:
    
    The target vertex of the parameter. Null if the edge is not included in the graph.
  - getEdgeWeight
```
default double getEdgeWeight(E edge)
```
    Method that gets the weight of a particular edge of the graph.
    
    Parameters:
    
    edge - Edge we want to check.
    
    Returns:
    
    Double value with the weight.
  - containsVertex
```
boolean containsVertex(V vertex)
```
    Method to check if a vertex is contained in the graph,
    
    Parameters:
    
    vertex - Vertex to check.
    
    Returns:
    
    True if the vertex is in the graph and false otherwise.
  - containsEdge
```
default boolean containsEdge(E edge)
```
    Method to check if an edge is contained in the graph,
    
    Parameters:
    
    edge - Edge to check.
    
    Returns:
    
    True if the edge is in the graph and false otherwise.
  - containsEdge
```
default boolean containsEdge(V source,
                             V target)
```
    Method to check if an edge with a source and target vertices is contained in the graph,
    
    Parameters:
    
    source - Source vertex of the edge searched.
    
    target - Target vertex of the edge searched.
    
    Returns:
    
    True if the edge (source,target) is in the graph and false otherwise.
  - edgesFrom
```
default java.util.Set<E> edgesFrom(V vertex)
```
    Method that return a set of edge where everyone has a certain source vertex.
    
    Parameters:
    
    vertex - Vertex we search as source.
    
    Returns:
    
    Set of edges where for all edge in it, "edge.getSource().equals(vertex)" is true.
  - edgesTo
```
default java.util.Set<E> edgesTo(V vertex)
```
    Method that return a set of edge where everyone has a certain target vertex.
    
    Parameters:
    
    vertex - Vertex we search as target.
    
    Returns:
    
    Set of edges where for all edge in it, "edge.getTarget().equals(vertex)" is true.
  - edgesOf
```
default java.util.Set<E> edgesOf(V vertex)
```
    Method to get a set with all the edges that has as source or target a certain vertex.
    
    Parameters:
    
    vertex - Vertex we are searching
    
    Returns:
    
    Set of edges where, for all edge in it: [edge.getTarget().equals(vertex) || edge.getDource().equals(vertex)] == true
  - getAllEdges
```
default java.util.Set<E> getAllEdges(V ver1,
                                     V ver2)
```
    Method to get all the edges related with two vertices at the same time. This means that this method returns a set of edge contain in the set: {(ver1,ver2), (ver2,ver1)}
    
    Parameters:
    
    ver1 - A vertex to search.
    
    ver2 - Another vertex to search.
    
    Returns:
    
    Set of edges with zero, one or two elements.
  - vertexFrom
```
default java.util.Set<V> vertexFrom(V vertex)
```
    Method to get all the vertices we can reach from a certain vertex.
    
    Parameters:
    
    vertex - Vertex from we want to find another vertices.
    
    Returns:
    
    A set of vertices that, for all vertex V in it: this.containsEdge(vertex, V) == true
  - vertexTo
```
default java.util.Set<V> vertexTo(V vertex)
```
    Method to get all the vertices from we can reach a certain vertex.
    
    Parameters:
    
    vertex - Vertex we want to find from another vertices.
    
    Returns:
    
    A set of vertices that, for all vertex V in it: this.containsEdge(V, vertex) == true
  - getVertexClass
```
java.lang.Class<? extends V> getVertexClass()
```
    Method to get the Vertex class of the Graph. It must be the parameter V of the Graph class.
    
    Returns:
    
    Class of the Vertices
  - getEdgeClass
```
java.lang.Class<? extends E> getEdgeClass()
```
    Method to get the Edge class of the Graph. It must be the parameter E of the Graph class.
    
    Returns:
    
    Class of the Edges

Interface Graph<V extends Vertex,E extends Edge<V>>

Method Summary

Method Detail

addVertex

addEdge

removeVertex

removeAllVertices

removeEdge

removeEdge

removeAllEdges

removeAllEdges

getVertexFactory

getEdgeFactory

vertexSet

edgeSet

getEdge

getEdgeSource

getEdgeTarget

getEdgeWeight

containsVertex

containsEdge

containsEdge

edgesFrom

edgesTo

edgesOf

getAllEdges

vertexFrom

vertexTo

getVertexClass

getEdgeClass