org.opentripplanner.routing.impl

Class InputStreamGraphSource

java.lang.Object

org.opentripplanner.routing.impl.InputStreamGraphSource

All Implemented Interfaces:

GraphSource

public class InputStreamGraphSource
extends Object
implements GraphSource

The primary implementation of the GraphSource interface. The graph is loaded from a serialized graph from a given source.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InputStreamGraphSource.FileFactory A GraphSource factory creating InputStreamGraphSource from file.

Nested classes/interfaces inherited from interface org.opentripplanner.routing.services.GraphSource

GraphSource.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static String	GRAPH_FILENAME

Method Summary

Modifier and Type	Method and Description
void	evict() Callback when the graph (source) gets evicted from the repository.
Router	getRouter()
static InputStreamGraphSource	newClasspathGraphSource(String routerId, File path)
static InputStreamGraphSource	newFileGraphSource(String routerId, File path)
boolean	reload(boolean force, boolean preEvict) Reload the graph from it's source.

Methods inherited from class java.lang.Object

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

Field Detail

GRAPH_FILENAME

public static final String GRAPH_FILENAME

See Also:

Constant Field Values

Method Detail

newFileGraphSource

public static InputStreamGraphSource newFileGraphSource(String routerId,
                                                        File path)

Returns:

A GraphSource loading graph from the file system under a base path.

newClasspathGraphSource

public static InputStreamGraphSource newClasspathGraphSource(String routerId,
                                                             File path)

Returns:

A GraphSource loading graph from an embedded classpath resources (a graph bundled inside a pre-packaged WAR for example).

getRouter

public Router getRouter()

Specified by:

getRouter in interface GraphSource

Returns:

The router containing a graph object. Delegates to the Router lifecycle manager the startup and shutdown of the graph.

reload

public boolean reload(boolean force,
                      boolean preEvict)

Description copied from interface: GraphSource

Reload the graph from it's source.

Specified by:

reload in interface GraphSource

Parameters:

force - True to force a reload, false to check only.

preEvict - True to evict the old version *before* loading the new one. In that case the implementation have to take care of making the getGraph() call wait while the new graph is being loaded and not return null.

Returns:

False if a new graph has not been reloaded and we could not keep the previous one: it should be evicted.

evict

public void evict()

Description copied from interface: GraphSource

Callback when the graph (source) gets evicted from the repository.

Specified by:

evict in interface GraphSource