org.opentripplanner.routing.core

Class RouteMatcher

java.lang.Object

org.opentripplanner.routing.core.RouteMatcher

All Implemented Interfaces:

Serializable, Cloneable

public class RouteMatcher
extends Object
implements Cloneable, Serializable

A RouteMatcher is a collection of routes based on IDs, short name and/or agency IDs. We currently support route full IDs (agency ID + route ID), agency ID + route name, or route name only. Support for other matching expression can be easily added later on.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
String	asString()
RouteMatcher	clone()
static RouteMatcher	emptyMatcher() Return an empty matcher (which match no routes).
boolean	equals(Object another)
int	hashCode()
boolean	isEmpty()
boolean	matches(Route route)
static RouteMatcher	parse(String routeSpecList) Build a new RouteMatcher from a string representation.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

emptyMatcher

public static RouteMatcher emptyMatcher()

Return an empty matcher (which match no routes).

parse

public static RouteMatcher parse(String routeSpecList)

Build a new RouteMatcher from a string representation.

Parameters:

routeSpecList - A comma-separated list of route spec, each of the format [agencyId]_[routeName]_[routeId] Please note that this format is not really intuitive as it does not follow the OBA-gtfslib AgencyAndId standard ('agencyID_routeId'). This was kept for backward-compatibility purposes. If the original routeName contains some "_" each *must* be replaced by a space. If the agency or route ID contains a "_" they must be escaped using a backslash. TODO why do we want to accept route name strings when we have IDs? Break backward compatibility. FIXME this is the only place we are still using underscores as scope separators. Rethink this from scratch, see #1671.

Returns:

A RouteMatcher

Throws:

IllegalArgumentException - If the string representation is invalid.

matches

public boolean matches(Route route)

isEmpty

public boolean isEmpty()

asString

public String asString()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object another)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RouteMatcher clone()

Overrides:

clone in class Object