com.crawljax.core.state

Class StateFlowGraph

java.lang.Object

com.crawljax.core.state.StateFlowGraph

All Implemented Interfaces:

Serializable

@Singleton
public class StateFlowGraph
extends Object
implements Serializable

The State-Flow Graph is a multi-edge directed graph with states (StateVetex) on the vertices and clickables (Eventable) on the edges.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StateFlowGraph(ExitNotifier exitNotifier) The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEdge(StateVertex sourceVert, StateVertex targetVert, Eventable clickable) Adds the specified edge to this graph, going from the source vertex to the target vertex.
boolean	canGoTo(StateVertex source, StateVertex target) Is it possible to go from s1 -> s2?
com.google.common.collect.ImmutableSet<Eventable>	getAllEdges() Return all the edges in the StateFlowGraph.
List<List<org.jgrapht.GraphPath<StateVertex,Eventable>>>	getAllPossiblePaths(StateVertex index) This method returns all possible paths from the index state using the Kshortest paths.
com.google.common.collect.ImmutableSet<StateVertex>	getAllStates() Return all the states in the StateFlowGraph.
StateVertex	getById(int id)
List<StateVertex>	getDeepStates(StateVertex state)
com.google.common.collect.ImmutableSet<Eventable>	getIncomingClickable(StateVertex stateVertix) Returns a set of all edges incoming into the specified vertex.
StateVertex	getInitialState()
int	getMeanStateStringSize()
String	getNewStateName(int id) Return the name of the (new)State.
int	getNextStateId()
int	getNumberOfStates()
com.google.common.collect.ImmutableSet<Eventable>	getOutgoingClickables(StateVertex stateVertix) Returns a set of all clickables outgoing from the specified vertex.
com.google.common.collect.ImmutableSet<StateVertex>	getOutgoingStates(StateVertex stateVertix) Returns the set of outgoing states.
com.google.common.collect.ImmutableList<Eventable>	getShortestPath(StateVertex start, StateVertex end) Convenience method to find the Dijkstra shortest path between two states on the graph.
StateVertex	getTargetState(Eventable clickable)
StateVertex	putIfAbsent(StateVertex stateVertix) Adds a state (as a vertix) to the State-Flow Graph if not already present.
StateVertex	putIfAbsent(StateVertex stateVertix, boolean correctName) Adds a state (as a vertix) to the State-Flow Graph if not already present.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StateFlowGraph

@Inject
public StateFlowGraph(ExitNotifier exitNotifier)

The constructor.

Parameters:

initialState - the state to start from.

Method Detail

putIfAbsent

public StateVertex putIfAbsent(StateVertex stateVertix)

Adds a state (as a vertix) to the State-Flow Graph if not already present. More formally, adds the specified vertex, v, to this graph if this graph contains no vertex u such that u.equals(v). If this graph already contains such vertex, the call leaves this graph unchanged and returns false. In combination with the restriction on constructors, this ensures that graphs never contain duplicate vertices. Throws java.lang.NullPointerException - if the specified vertex is null. This method automatically updates the state name to reflect the internal state counter.

Parameters:

stateVertix - the state to be added.

Returns:

the clone if one is detected null otherwise.

See Also:

Graph.addVertex(Object)

putIfAbsent

public StateVertex putIfAbsent(StateVertex stateVertix,
                      boolean correctName)

Adds a state (as a vertix) to the State-Flow Graph if not already present. More formally, adds the specified vertex, v, to this graph if this graph contains no vertex u such that u.equals(v). If this graph already contains such vertex, the call leaves this graph unchanged and returns false. In combination with the restriction on constructors, this ensures that graphs never contain duplicate vertices. Throws java.lang.NullPointerException - if the specified vertex is null.

Parameters:

stateVertix - the state to be added.

correctName - if true the name of the state will be corrected according to the internal state counter.

Returns:

the clone if one is detected null otherwise.

See Also:

Graph.addVertex(Object)

getById

public StateVertex getById(int id)

Parameters:

id - The ID of the state

Returns:

The state if found or null.

getInitialState

public StateVertex getInitialState()

addEdge

public boolean addEdge(StateVertex sourceVert,
              StateVertex targetVert,
              Eventable clickable)

Adds the specified edge to this graph, going from the source vertex to the target vertex. More formally, adds the specified edge, e, to this graph if this graph contains no edge e2 such that e2.equals(e). If this graph already contains such an edge, the call leaves this graph unchanged and returns false. Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, than this method does not change the graph and returns false. If the edge was added to the graph, returns true. The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.

Parameters:

sourceVert - source vertex of the edge.

targetVert - target vertex of the edge.

clickable - the clickable edge to be added to this graph.

Returns:

true if this graph did not already contain the specified edge.

See Also:

Graph.addEdge(Object, Object, Object)

toString

public String toString()

Overrides:

toString in class Object

Returns:

the string representation of the graph.

See Also:

org.jgrapht.DirectedGraph#toString()

getOutgoingClickables

public com.google.common.collect.ImmutableSet<Eventable> getOutgoingClickables(StateVertex stateVertix)

Returns a set of all clickables outgoing from the specified vertex.

Parameters:

stateVertix - the state vertix.

Returns:

a set of the outgoing edges (clickables) of the stateVertix.

See Also:

DirectedGraph.outgoingEdgesOf(Object)

getIncomingClickable

public com.google.common.collect.ImmutableSet<Eventable> getIncomingClickable(StateVertex stateVertix)

Returns a set of all edges incoming into the specified vertex.

Parameters:

stateVertix - the state vertix.

Returns:

a set of the incoming edges (clickables) of the stateVertix.

See Also:

DirectedGraph.incomingEdgesOf(Object)

getOutgoingStates

public com.google.common.collect.ImmutableSet<StateVertex> getOutgoingStates(StateVertex stateVertix)

Returns the set of outgoing states.

Parameters:

stateVertix - the state.

Returns:

the set of outgoing states from the stateVertix.

getTargetState

public StateVertex getTargetState(Eventable clickable)

Parameters:

clickable - the edge.

Returns:

the target state of this edge.

canGoTo

public boolean canGoTo(StateVertex source,
              StateVertex target)

Is it possible to go from s1 -> s2?

Parameters:

source - the source state.

target - the target state.

Returns:

true if it is possible (edge exists in graph) to go from source to target.

getShortestPath

public com.google.common.collect.ImmutableList<Eventable> getShortestPath(StateVertex start,
                                                                 StateVertex end)

Convenience method to find the Dijkstra shortest path between two states on the graph.

Parameters:

start - the start state.

end - the end state.

Returns:

a list of shortest path of clickables from the state to the end

getAllStates

public com.google.common.collect.ImmutableSet<StateVertex> getAllStates()

Return all the states in the StateFlowGraph.

Returns:

all the states on the graph.

getAllEdges

public com.google.common.collect.ImmutableSet<Eventable> getAllEdges()

Return all the edges in the StateFlowGraph.

Returns:

a Set of all edges in the StateFlowGraph

getMeanStateStringSize

public int getMeanStateStringSize()

Returns:

Dom string average size (byte).

getDeepStates

public List<StateVertex> getDeepStates(StateVertex state)

Parameters:

state - The starting state.

Returns:

A list of the deepest states (states with no outgoing edges).

getAllPossiblePaths

public List<List<org.jgrapht.GraphPath<StateVertex,Eventable>>> getAllPossiblePaths(StateVertex index)

This method returns all possible paths from the index state using the Kshortest paths.

Parameters:

index - the initial state.

Returns:

a list of GraphPath lists.

getNewStateName

public String getNewStateName(int id)

Return the name of the (new)State. By using the AtomicInteger the stateCounter is thread-safe

Returns:

State name the name of the state

getNextStateId

public int getNextStateId()

getNumberOfStates

public int getNumberOfStates()

Returns:

The number of states, currently in the graph.