EvoSuiteGraph (evosuite-client 1.0.5 API)

java.lang.Object
- org.evosuite.graphs.EvoSuiteGraph<V,E>

Direct Known Subclasses:

ClassCallGraph, ClassControlFlowGraph, ControlDependenceGraph, ControlFlowGraph, DominatorTree
```
public abstract class EvoSuiteGraph<V,E extends org.jgrapht.graph.DefaultEdge>
extends Object
```
Supposed to become the super class of all kinds of graphs used within EvoSuite Examples are the raw and minimal Control Flow Graph and hopefully at one point the Control Dependency Tree This class is supposed to hide the jGraph library from the rest of EvoSuite and is supposed to serve as an interface for all kinds of primitive graph- functionality such as asking for information about the nodes and edges of the graph and the relations between them. Hopefully at some point only this class and it's sub classes are the only files in EvoSuite that import anything from the jGraph library - at least that's the idea This is very similar to the way cfg.ASMWrapper is supposed to hide the ASM library and serve as an interface for BytecodeInstrucions So most of this class' methods are just wrappers that redirect the specific call to the corresponding jGraph-method For now an EvoSuiteGraph can always be represented by a DefaultDirectedGraph from the jGraph library - that is a directed graph not allowed to contain multiple edges between to nodes but allowed to contain cycles

Author:

Andre Mis

Field Summary

Fields
Modifier and Type Field and Description

protected Class<E> edgeClass

protected org.jgrapht.DirectedGraph<V,E> graph

protected int graphId

Fields
Modifier and Type	Field and Description
`protected Class<E>`	`edgeClass`
`protected org.jgrapht.DirectedGraph<V,E>`	`graph`
`protected int`	`graphId`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`EvoSuiteGraph(Class<E> edgeClass)` Constructor for EvoSuiteGraph.
`protected`	`EvoSuiteGraph(org.jgrapht.DirectedGraph<V,E> graph, Class<E> edgeClass)` Constructor for EvoSuiteGraph.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected E`	`addEdge(V src, V target)` addEdge
`protected boolean`	`addEdge(V src, V target, E e)` addEdge
`protected boolean`	`addVertex(V v)` addVertex
`protected void`	`addVertices(Collection<V> vs)` addVertices
`protected void`	`addVertices(EvoSuiteGraph<V,E> other)` addVertices
`protected org.jgrapht.graph.DefaultDirectedGraph<V,E>`	`computeReverseJGraph()` Returns a reverted version of this graph in a jGraph That is a graph containing exactly the same nodes as this one but for each edge from v1 to v2 in this graph the resulting graph will contain an edge from v2 to v1 - or in other words the reverted edge This is used to revert CFGs in order to determine control dependencies for example
`boolean`	`containsEdge(E e)` containsEdge
`boolean`	`containsEdge(V v1, V v2)` containsEdge
`boolean`	`containsVertex(V v)` containsVertex
`Set<V>`	`determineBranches()` determineBranches
`Set<V>`	`determineConnectedVertices(V v)` Follows all edges adjacent to the given vertex v ignoring edge directions and returns a set containing all vertices visited that way
`Set<V>`	`determineEntryPoints()` determineEntryPoints
`Set<V>`	`determineExitPoints()` determineExitPoints
`Set<V>`	`determineJoins()` determineJoins
`protected String`	`dotSubFolder()` Subclasses can overwrite this method in order to separate their .dot and .png export to a special folder.
`int`	`edgeCount()` edgeCount
`Set<E>`	`edgeSet()` edgeSet
`Set<V>`	`getChildren(V node)` getChildren
`int`	`getDistance(V v1, V v2)` getDistance
`E`	`getEdge(V v1, V v2)` getEdge
`V`	`getEdgeSource(E e)` getEdgeSource
`V`	`getEdgeTarget(E e)` getEdgeTarget
`Set<V>`	`getIsolatedNodes()` Returns a Set of all nodes within this graph that neither have incoming nor outgoing edges.
`String`	`getName()` getName
`Set<V>`	`getNodesWithoutChildren()` Returns a Set containing every node in this graph that has no outgoing edges.
`Set<V>`	`getParents(V node)` getParents
`V`	`getRandomVertex()` getRandomVertex
`V`	`getSingleChild(V node)` If the given node is contained within this graph and has exactly one child v this method will return v.
`boolean`	`hasNPartentsMChildren(V node, int n, int m)` Returns true iff whether the given node is not null, in this graph and has exactly n parents and m children.
`Set<E>`	`incomingEdgesOf(V node)` incomingEdgesOf
`int`	`inDegreeOf(V node)` inDegreeOf
`boolean`	`isConnected()` Checks whether each vertex inside this graph is reachable from some other vertex
`boolean`	`isDirectSuccessor(V v1, V v2)` isDirectSuccessor
`boolean`	`isEmpty()` isEmpty
`int`	`outDegreeOf(V node)` outDegreeOf
`Set<E>`	`outgoingEdgesOf(V node)` outgoingEdgesOf
`protected boolean`	`redirectEdges(V from, V newStart, V newEnd)` Redirects all edges going into node from to the node newStart and all edges going out of node from to the node newEnd.
`protected boolean`	`redirectEdgeSource(E edge, V node)` Redirects the edge source of the given edge to the given node by removing the given edge from the graph and reinserting it from the given node to the original target node
`protected boolean`	`redirectEdgeTarget(E edge, V node)` Redirects the edge target of the given edge to the given node by removing the given edge from the graph and reinserting it from the original source node to the given node
`protected boolean`	`redirectIncomingEdges(V oldNode, V newNode)` Redirects all incoming edges to oldNode to node newNode by calling redirectEdgeTarget for each incoming edge of oldNode
`protected boolean`	`redirectOutgoingEdges(V oldNode, V newNode)` Redirects all outgoing edges to oldNode to node newNode by calling redirectEdgeSource for each outgoing edge of oldNode
`void`	`registerEdgeAttributeProvider(org.jgrapht.ext.ComponentAttributeProvider<E> edgeAttributeProvider)` registerEdgeAttributeProvider
`void`	`registerVertexAttributeProvider(org.jgrapht.ext.ComponentAttributeProvider<V> vertexAttributeProvider)` registerVertexAttributeProvider
`void`	`toDot()` toDot
`protected String`	`toFileString(String name)` toFileString
`int`	`vertexCount()` vertexCount
`Set<V>`	`vertexSet()` vertexSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - graphId
```
protected int graphId
```
  - graph
```
protected org.jgrapht.DirectedGraph<V,E extends org.jgrapht.graph.DefaultEdge> graph
```
  - edgeClass
```
protected Class<E extends org.jgrapht.graph.DefaultEdge> edgeClass
```
- Constructor Detail
  - EvoSuiteGraph
```
protected EvoSuiteGraph(Class<E> edgeClass)
```
    Constructor for EvoSuiteGraph.
    
    Type Parameters:
    
    V - a V object.
    
    E - a E object.
    
    Parameters:
    
    edgeClass - a Class object.
  - EvoSuiteGraph
```
protected EvoSuiteGraph(org.jgrapht.DirectedGraph<V,E> graph,
                        Class<E> edgeClass)
```
    Constructor for EvoSuiteGraph.
    
    Parameters:
    
    graph - a DirectedGraph object.
    
    edgeClass - a Class object.
- Method Detail
  - getEdgeSource
```
public V getEdgeSource(E e)
```
    getEdgeSource
    
    Parameters:
    
    e - a E object.
    
    Returns:
    
    a V object.
  - getEdgeTarget
```
public V getEdgeTarget(E e)
```
    getEdgeTarget
    
    Parameters:
    
    e - a E object.
    
    Returns:
    
    a V object.
  - outgoingEdgesOf
```
public Set<E> outgoingEdgesOf(V node)
```
    outgoingEdgesOf
    
    Parameters:
    
    node - a V object.
    
    Returns:
    
    a Set object.
  - incomingEdgesOf
```
public Set<E> incomingEdgesOf(V node)
```
    incomingEdgesOf
    
    Parameters:
    
    node - a V object.
    
    Returns:
    
    a Set object.
  - getChildren
```
public Set<V> getChildren(V node)
```
    getChildren
    
    Parameters:
    
    node - a V object.
    
    Returns:
    
    a Set object.
  - getParents
```
public Set<V> getParents(V node)
```
    getParents
    
    Parameters:
    
    node - a V object.
    
    Returns:
    
    a Set object.
  - vertexSet
```
public Set<V> vertexSet()
```
    vertexSet
    
    Returns:
    
    a Set object.
  - edgeSet
```
public Set<E> edgeSet()
```
    edgeSet
    
    Returns:
    
    a Set object.
  - getSingleChild
```
public V getSingleChild(V node)
```
    If the given node is contained within this graph and has exactly one child v this method will return v. Otherwise it will return null
    
    Parameters:
    
    node - a V object.
    
    Returns:
    
    a V object.
  - addVertices
```
protected void addVertices(EvoSuiteGraph<V,E> other)
```
    addVertices
    
    Parameters:
    
    other - a EvoSuiteGraph object.
  - addVertices
```
protected void addVertices(Collection<V> vs)
```
    addVertices
    
    Parameters:
    
    vs - a Collection object.
  - addVertex
```
protected boolean addVertex(V v)
```
    addVertex
    
    Parameters:
    
    v - a V object.
    
    Returns:
    
    a boolean.
  - addEdge
```
protected E addEdge(V src,
                    V target)
```
    addEdge
    
    Parameters:
    
    src - a V object.
    
    target - a V object.
    
    Returns:
    
    a E object.
  - addEdge
```
protected boolean addEdge(V src,
                          V target,
                          E e)
```
    addEdge
    
    Parameters:
    
    src - a V object.
    
    target - a V object.
    
    e - a E object.
    
    Returns:
    
    a boolean.
  - redirectEdges
```
protected boolean redirectEdges(V from,
                                V newStart,
                                V newEnd)
```
    Redirects all edges going into node from to the node newStart and all edges going out of node from to the node newEnd. All three edges have to be present in the graph prior to a call to this method.
    
    Parameters:
    
    from - a V object.
    
    newStart - a V object.
    
    newEnd - a V object.
    
    Returns:
    
    a boolean.
  - redirectIncomingEdges
```
protected boolean redirectIncomingEdges(V oldNode,
                                        V newNode)
```
    Redirects all incoming edges to oldNode to node newNode by calling redirectEdgeTarget for each incoming edge of oldNode
    
    Parameters:
    
    oldNode - a V object.
    
    newNode - a V object.
    
    Returns:
    
    a boolean.
  - redirectOutgoingEdges
```
protected boolean redirectOutgoingEdges(V oldNode,
                                        V newNode)
```
    Redirects all outgoing edges to oldNode to node newNode by calling redirectEdgeSource for each outgoing edge of oldNode
    
    Parameters:
    
    oldNode - a V object.
    
    newNode - a V object.
    
    Returns:
    
    a boolean.
  - redirectEdgeTarget
```
protected boolean redirectEdgeTarget(E edge,
                                     V node)
```
    Redirects the edge target of the given edge to the given node by removing the given edge from the graph and reinserting it from the original source node to the given node
    
    Parameters:
    
    edge - a E object.
    
    node - a V object.
    
    Returns:
    
    a boolean.
  - redirectEdgeSource
```
protected boolean redirectEdgeSource(E edge,
                                     V node)
```
    Redirects the edge source of the given edge to the given node by removing the given edge from the graph and reinserting it from the given node to the original target node
    
    Parameters:
    
    edge - a E object.
    
    node - a V object.
    
    Returns:
    
    a boolean.
  - vertexCount
```
public int vertexCount()
```
    vertexCount
    
    Returns:
    
    a int.
  - edgeCount
```
public int edgeCount()
```
    edgeCount
    
    Returns:
    
    a int.
  - outDegreeOf
```
public int outDegreeOf(V node)
```
    outDegreeOf
    
    Parameters:
    
    node - a V object.
    
    Returns:
    
    a int.
  - inDegreeOf
```
public int inDegreeOf(V node)
```
    inDegreeOf
    
    Parameters:
    
    node - a V object.
    
    Returns:
    
    a int.
  - getEdge
```
public E getEdge(V v1,
                 V v2)
```
    getEdge
    
    Parameters:
    
    v1 - a V object.
    
    v2 - a V object.
    
    Returns:
    
    a E object.
  - containsVertex
```
public boolean containsVertex(V v)
```
    containsVertex
    
    Parameters:
    
    v - a V object.
    
    Returns:
    
    a boolean.
  - containsEdge
```
public boolean containsEdge(V v1,
                            V v2)
```
    containsEdge
    
    Parameters:
    
    v1 - a V object.
    
    v2 - a V object.
    
    Returns:
    
    a boolean.
  - containsEdge
```
public boolean containsEdge(E e)
```
    containsEdge
    
    Parameters:
    
    e - a E object.
    
    Returns:
    
    a boolean.
  - isEmpty
```
public boolean isEmpty()
```
    isEmpty
    
    Returns:
    
    a boolean.
  - isConnected
```
public boolean isConnected()
```
    Checks whether each vertex inside this graph is reachable from some other vertex
    
    Returns:
    
    a boolean.
  - determineEntryPoints
```
public Set<V> determineEntryPoints()
```
    determineEntryPoints
    
    Returns:
    
    Set containing all nodes with in degree 0
  - determineExitPoints
```
public Set<V> determineExitPoints()
```
    determineExitPoints
    
    Returns:
    
    Set containing all nodes with out degree 0
  - determineConnectedVertices
```
public Set<V> determineConnectedVertices(V v)
```
    Follows all edges adjacent to the given vertex v ignoring edge directions and returns a set containing all vertices visited that way
    
    Parameters:
    
    v - a V object.
    
    Returns:
    
    a Set object.
  - hasNPartentsMChildren
```
public boolean hasNPartentsMChildren(V node,
                                     int n,
                                     int m)
```
    Returns true iff whether the given node is not null, in this graph and has exactly n parents and m children.
    
    Parameters:
    
    node - a V object.
    
    n - a int.
    
    m - a int.
    
    Returns:
    
    a boolean.
  - getIsolatedNodes
```
public Set<V> getIsolatedNodes()
```
    Returns a Set of all nodes within this graph that neither have incoming nor outgoing edges.
    
    Returns:
    
    a Set object.
  - getNodesWithoutChildren
```
public Set<V> getNodesWithoutChildren()
```
    Returns a Set containing every node in this graph that has no outgoing edges.
    
    Returns:
    
    a Set object.
  - getRandomVertex
```
public V getRandomVertex()
```
    getRandomVertex
    
    Returns:
    
    a V object.
  - getDistance
```
public int getDistance(V v1,
                       V v2)
```
    getDistance
    
    Parameters:
    
    v1 - a V object.
    
    v2 - a V object.
    
    Returns:
    
    a int.
  - isDirectSuccessor
```
public boolean isDirectSuccessor(V v1,
                                 V v2)
```
    isDirectSuccessor
    
    Parameters:
    
    v1 - a V object.
    
    v2 - a V object.
    
    Returns:
    
    a boolean.
  - determineBranches
```
public Set<V> determineBranches()
```
    determineBranches
    
    Returns:
    
    a Set object.
  - determineJoins
```
public Set<V> determineJoins()
```
    determineJoins
    
    Returns:
    
    a Set object.
  - computeReverseJGraph
```
protected org.jgrapht.graph.DefaultDirectedGraph<V,E> computeReverseJGraph()
```
    Returns a reverted version of this graph in a jGraph That is a graph containing exactly the same nodes as this one but for each edge from v1 to v2 in this graph the resulting graph will contain an edge from v2 to v1 - or in other words the reverted edge This is used to revert CFGs in order to determine control dependencies for example
    
    Returns:
    
    a DefaultDirectedGraph object.
  - toDot
```
public void toDot()
```
    toDot
  - dotSubFolder
```
protected String dotSubFolder()
```
    Subclasses can overwrite this method in order to separate their .dot and .png export to a special folder.
    
    Returns:
    
    a String object.
  - toFileString
```
protected String toFileString(String name)
```
    toFileString
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a String object.
  - getName
```
public String getName()
```
    getName
    
    Returns:
    
    a String object.
  - registerVertexAttributeProvider
```
public void registerVertexAttributeProvider(org.jgrapht.ext.ComponentAttributeProvider<V> vertexAttributeProvider)
```
    registerVertexAttributeProvider
    
    Parameters:
    
    vertexAttributeProvider - a ComponentAttributeProvider object.
  - registerEdgeAttributeProvider
```
public void registerEdgeAttributeProvider(org.jgrapht.ext.ComponentAttributeProvider<E> edgeAttributeProvider)
```
    registerEdgeAttributeProvider
    
    Parameters:
    
    edgeAttributeProvider - a ComponentAttributeProvider object.

Class EvoSuiteGraph<V,E extends org.jgrapht.graph.DefaultEdge>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

graphId

graph

edgeClass

Constructor Detail

EvoSuiteGraph

EvoSuiteGraph

Method Detail

getEdgeSource

getEdgeTarget

outgoingEdgesOf

incomingEdgesOf

getChildren

getParents

vertexSet

edgeSet

getSingleChild

addVertices

addVertices

addVertex

addEdge

addEdge

redirectEdges

redirectIncomingEdges

redirectOutgoingEdges

redirectEdgeTarget

redirectEdgeSource

vertexCount

edgeCount

outDegreeOf

inDegreeOf

getEdge

containsVertex

containsEdge

containsEdge

isEmpty

isConnected

determineEntryPoints

determineExitPoints

determineConnectedVertices

hasNPartentsMChildren

getIsolatedNodes

getNodesWithoutChildren

getRandomVertex

getDistance

isDirectSuccessor

determineBranches

determineJoins

computeReverseJGraph

toDot

dotSubFolder

toFileString

getName

registerVertexAttributeProvider

registerEdgeAttributeProvider