com.graphhopper.storage.index

Class Location2IDFullWithEdgesIndex

java.lang.Object

com.graphhopper.storage.index.Location2IDFullWithEdgesIndex

All Implemented Interfaces:

LocationIndex, Storable<LocationIndex>, Closeable, AutoCloseable

public class Location2IDFullWithEdgesIndex
extends Object
implements LocationIndex

Same as full index but calculates distance to all edges too

Author:

Peter Karich

Nested Class Summary

Nested classes/interfaces inherited from interface com.graphhopper.storage.index.LocationIndex

LocationIndex.EdgeVisitor, LocationIndex.Visitor

Constructor Summary

Constructors

Constructor and Description
Location2IDFullWithEdgesIndex(Graph g)

Method Summary

Modifier and Type	Method and Description
void	close() This method makes sure that the underlying used resources are released.
LocationIndex	create(long size) Creates the underlying storage.
QueryResult	findClosest(double queryLat, double queryLon, EdgeFilter filter) This method returns the closest QueryResult for the specified location (lat, lon) and only if the filter accepts the edge as valid candidate (e.g.
void	flush() This method makes sure that the underlying data is written to the storage.
long	getCapacity()
boolean	isClosed()
boolean	loadExisting()
LocationIndex	prepareIndex() Creates this index - to be called once before findID.
void	query(BBox queryBBox, LocationIndex.Visitor function) This method explores the nodes in this LocationIndex with the specified Visitor.
LocationIndex	setApproximation(boolean approxDist)
LocationIndex	setResolution(int resolution) Integer value to specify the resolution of this location index.
void	setSegmentSize(int bytes)

Methods inherited from class java.lang.Object

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

Constructor Detail

Location2IDFullWithEdgesIndex

public Location2IDFullWithEdgesIndex(Graph g)

Method Detail

loadExisting

public boolean loadExisting()

Specified by:

loadExisting in interface Storable<LocationIndex>

Returns:

true if successfully loaded from persistent storage.

setResolution

public LocationIndex setResolution(int resolution)

Description copied from interface: LocationIndex

Integer value to specify the resolution of this location index. The higher the better the resolution.

Specified by:

setResolution in interface LocationIndex

setApproximation

public LocationIndex setApproximation(boolean approxDist)

Specified by:

setApproximation in interface LocationIndex

Parameters:

approxDist - false if initialization and querying should be faster but less precise.

prepareIndex

public LocationIndex prepareIndex()

Description copied from interface: LocationIndex

Creates this index - to be called once before findID.

Specified by:

prepareIndex in interface LocationIndex

findClosest

public QueryResult findClosest(double queryLat,
                               double queryLon,
                               EdgeFilter filter)

Description copied from interface: LocationIndex

This method returns the closest QueryResult for the specified location (lat, lon) and only if the filter accepts the edge as valid candidate (e.g. filtering away car-only results for bike search)

Specified by:

findClosest in interface LocationIndex

filter - if a graph supports multiple vehicles we have to make sure that the entry node into the graph is accessible from a selected vehicle. E.g. if you have a FOOT-query do:

DefaultEdgeFilter.allEdges(footFlagEncoder);

Returns:

An object containing the closest node and edge for the specified location. The node id has at least one edge which is accepted from the specified edgeFilter. If nothing is found the method QueryResult.isValid will return false.

query

public void query(BBox queryBBox,
                  LocationIndex.Visitor function)

Description copied from interface: LocationIndex

This method explores the nodes in this LocationIndex with the specified Visitor. It guarantees to visit all unique nodes included in the queryBBox but it could visit more.

Specified by:

query in interface LocationIndex

create

public LocationIndex create(long size)

Description copied from interface: Storable

Creates the underlying storage. First operation if it cannot be loaded.

Specified by:

create in interface Storable<LocationIndex>

flush

public void flush()

Description copied from interface: Storable

This method makes sure that the underlying data is written to the storage. Keep in mind that a disc normally has an IO cache so that flush() is (less) probably not save against power loses.

Specified by:

flush in interface Storable<LocationIndex>

close

public void close()

Description copied from interface: Storable

This method makes sure that the underlying used resources are released. WARNING: it does NOT flush on close!

Specified by:

close in interface Storable<LocationIndex>

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Storable<LocationIndex>

getCapacity

public long getCapacity()

Specified by:

getCapacity in interface Storable<LocationIndex>

Returns:

the allocated storage size in bytes

setSegmentSize

public void setSegmentSize(int bytes)

Specified by:

setSegmentSize in interface LocationIndex