org.opentripplanner.routing.services

Class GraphService

java.lang.Object

org.opentripplanner.routing.services.GraphService

Direct Known Subclasses:

ClusterGraphService

public class GraphService
extends Object

A GraphService maps RouterIds to Graphs. This graph service allows us to decouple the deserialization, loading, and management of the underlying graph objects from the classes that need access to the objects. This indirection allows us to provide multiple graphs distringuished by routerIds or to dynamically swap in new graphs if underlying data changes. Delegate the graph creation/loading details to the GraphSource implementations.

See Also:

GraphSource

Field Summary

Fields

Modifier and Type	Field and Description
GraphSource.Factory	graphSourceFactory

Constructor Summary

Constructors

Constructor and Description
GraphService()
GraphService(boolean autoReload)

Method Summary

Modifier and Type	Method and Description
int	evictAll() Dissocate all graphs from their router IDs and release references to the graphs to allow garbage collection.
boolean	evictRouter(String routerId) Dissociate a router ID from the corresponding graph/services object, and disable that router ID for use in routing.
GraphSource.Factory	getGraphSourceFactory()
Router	getRouter()
Router	getRouter(String routerId)
Collection<String>	getRouterIds()
boolean	registerGraph(String routerId, GraphSource graphSource) Blocking method to associate the specified router ID with the corresponding graph source, load it from appropriate source (serialized file, memory...), and enable its use in routing.
boolean	reloadGraph(String routerId, boolean preEvict, boolean force) Reload a registered graph.
boolean	reloadGraphs(boolean preEvict, boolean force) Reload all registered graphs from wherever they came from.
static boolean	routerIdLegal(String routerId) Check whether a router ID is legal or not.
void	setDefaultRouterId(String defaultRouterId)

Methods inherited from class java.lang.Object

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

Field Detail

graphSourceFactory

public GraphSource.Factory graphSourceFactory

Constructor Detail

GraphService

public GraphService()

GraphService

public GraphService(boolean autoReload)

Method Detail

setDefaultRouterId

public void setDefaultRouterId(String defaultRouterId)

Parameters:

defaultRouterId - The ID of the default router to return when no one is specified

getRouter

public Router getRouter()
                 throws GraphNotFoundException

Returns:

the current default router object

Throws:

GraphNotFoundException

getRouter

public Router getRouter(String routerId)
                 throws GraphNotFoundException

Returns:

the graph object for the given router ID

Throws:

GraphNotFoundException

reloadGraphs

public boolean reloadGraphs(boolean preEvict,
                            boolean force)

Reload all registered graphs from wherever they came from. See reloadGraph().

Returns:

whether the operation completed successfully (all reloads are successful).

reloadGraph

public boolean reloadGraph(String routerId,
                           boolean preEvict,
                           boolean force)

Reload a registered graph. If the reload fails, evict (remove) the graph.

Parameters:

routerId - ID of the router

preEvict - When true, release the existing graph (if any) before loading. This will halve the amount of memory needed for the operation, but routing will be unavailable for that graph during the load process

force - When true, force a reload. If false, only check if the source has been modified, and reload if so.

Returns:

True if the reload is successful, false otherwise.

getRouterIds

public Collection<String> getRouterIds()

Returns:

a collection of all valid router IDs for this server

registerGraph

public boolean registerGraph(String routerId,
                             GraphSource graphSource)

Blocking method to associate the specified router ID with the corresponding graph source, load it from appropriate source (serialized file, memory...), and enable its use in routing. The relationship between router IDs and paths in the filesystem is determined by the GraphSource implementation.

Returns:

whether the operation completed successfully

evictRouter

public boolean evictRouter(String routerId)

Dissociate a router ID from the corresponding graph/services object, and disable that router ID for use in routing.

Returns:

whether a router was associated with this router ID and was evicted.

evictAll

public int evictAll()

Dissocate all graphs from their router IDs and release references to the graphs to allow garbage collection. Routing will not be possible until new graphs are registered. This is equivalent to calling evictGraph on every registered router ID.

getGraphSourceFactory

public GraphSource.Factory getGraphSourceFactory()

Returns:

The default GraphSource factory. Needed in case someone want to register or save a new router with a router ID only (namely, via the web-service API).

routerIdLegal

public static boolean routerIdLegal(String routerId)

Check whether a router ID is legal or not. Router IDs may contain alphanumeric characters, underscores, and dashes only. This prevents any confusion caused by the presence of special characters that might have a meaning for the filesystem.