org.opentripplanner.routing.vertextype

Interface TemporaryVertex

All Known Implementing Classes:

OnboardDepartVertex, SampleVertex, TemporaryPatternArriveVertex, TemporaryPatternDepartVertex, TemporarySplitterVertex, TemporaryStreetLocation, TemporaryTransitStop, TemporaryTransitStopArrive, TemporaryTransitStopDepart

public interface TemporaryVertex

Marker interface for temporary vertices.

Remember to use the dispose(Vertex) to delete the temporary vertex from the main graph after use.

Method Summary

Modifier and Type	Method and Description
static Collection<Vertex>	dispose(Vertex vertex) This method traverses the subgraph of temporary vertices, and cuts that subgraph off from the main graph at each point it encounters a non-temporary vertexes.
static Collection<Vertex>	disposeAll(Collection<Vertex> vertices) This method traverses the subgraph of all temporary vertices connected to the collection, and removes connections to the main graph.
static Collection<Vertex>	findSubgraph(Vertex vertex) Return the subgraph of temporary vertices which are connected to this vertex.
boolean	isEndVertex()

Method Detail

isEndVertex

boolean isEndVertex()

dispose

static Collection<Vertex> dispose(Vertex vertex)

This method traverses the subgraph of temporary vertices, and cuts that subgraph off from the main graph at each point it encounters a non-temporary vertexes. OTP then holds no references to the temporary subgraph and it is garbage collected.

Note! If the vertex is NOT a TemporaryVertex the method returns. No action taken.

Parameters:

vertex - Vertex part of the temporary part of the graph.

Returns:

a collection of all the vertices removed from the graph.

disposeAll

static Collection<Vertex> disposeAll(Collection<Vertex> vertices)

This method traverses the subgraph of all temporary vertices connected to the collection, and removes connections to the main graph. OTP then holds no references to any of the temporary subgraphs and they can be garbage-collected.

Note! Any vertices which are not instances of TemporaryVertex are ignored and no action is taken.

Parameters:

vertices - All temporary vertices

Returns:

a collection of all the vertices removed from the graph.

findSubgraph

static Collection<Vertex> findSubgraph(Vertex vertex)

Return the subgraph of temporary vertices which are connected to this vertex. Returns an empty collection if the given vertex is not a TemporaryVertex.

Parameters:

vertex - Vertex part of the temporary vertex subgraph.

Returns:

a collection of all temporary vertices in the subgraph.