org.opentripplanner.common

Class LuceneIndex

java.lang.Object

org.opentripplanner.common.LuceneIndex

public class LuceneIndex
extends Object

Lucene based index of streets, stops, etc. For reference see: https://svn.apache.org/repos/asf/lucene/dev/trunk/lucene/demo/src/java/org/apache/lucene/demo/IndexFiles.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LuceneIndex.Category
static class	LuceneIndex.LuceneResult This class matches the structure of the Geocoder responses expected by the OTP client.

Constructor Summary

Constructors

Constructor and Description
LuceneIndex(GraphIndex graphIndex, File basePath, boolean background)

Method Summary

Modifier and Type	Method and Description
List<LuceneIndex.LuceneResult>	query(String queryString, boolean autocomplete, boolean stops, boolean clusters, boolean corners) Fetch results for the geocoder using the OTP graph for stops, clusters and street names

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneIndex

public LuceneIndex(GraphIndex graphIndex,
                   File basePath,
                   boolean background)

Parameters:

basePath - the filesystem location under which to save indexes

background - if true, perform the initial indexing in a background thread, if false block to index

Method Detail

query

public List<LuceneIndex.LuceneResult> query(String queryString,
                                            boolean autocomplete,
                                            boolean stops,
                                            boolean clusters,
                                            boolean corners)

Fetch results for the geocoder using the OTP graph for stops, clusters and street names

Parameters:

queryString -

autocomplete - Whether we should use the query string to do a prefix match

stops - Search for stops, either by name or stop code

clusters - Search for clusters by their name

corners - Search for street corners using at least one of the street names

Returns:

list of results in in the format expected by GeocoderBuiltin.js in the OTP Leaflet client