com.graphhopper.search

Class StringIndex

java.lang.Object

com.graphhopper.search.StringIndex

All Implemented Interfaces:

Storable<StringIndex>, Closeable, AutoCloseable

public class StringIndex
extends Object
implements Storable<StringIndex>

Author:

Peter Karich

Constructor Summary

Constructors

Constructor and Description
StringIndex(Directory dir)
StringIndex(Directory dir, int cacheSize) Specify a larger cacheSize to reduce disk usage.

Method Summary

Modifier and Type	Method and Description
long	add(Map<String,String> entryMap) This method writes the specified key-value pairs into the storage.
void	close() This method makes sure that the underlying used resources are released.
void	copyTo(StringIndex stringIndex)
StringIndex	create(long initBytes) Creates the underlying storage.
void	flush() This method makes sure that the underlying data is written to the storage.
String	get(long entryPointer, String key)
Map<String,String>	getAll(long entryPointer)
long	getCapacity()
boolean	isClosed()
boolean	loadExisting()
void	setSegmentSize(int segments)

Methods inherited from class java.lang.Object

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

Constructor Detail

StringIndex

public StringIndex(Directory dir)

StringIndex

public StringIndex(Directory dir,
                   int cacheSize)

Specify a larger cacheSize to reduce disk usage. Note that this increases the memory usage of this object.

Method Detail

create

public StringIndex create(long initBytes)

Description copied from interface: Storable

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

Specified by:

create in interface Storable<StringIndex>

loadExisting

public boolean loadExisting()

Specified by:

loadExisting in interface Storable<StringIndex>

Returns:

true if successfully loaded from persistent storage.

add

public long add(Map<String,String> entryMap)

This method writes the specified key-value pairs into the storage.

Returns:

entryPointer to later fetch the entryMap via get

getAll

public Map<String,String> getAll(long entryPointer)

get

public String get(long entryPointer,
                  String key)

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<StringIndex>

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<StringIndex>

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Storable<StringIndex>

setSegmentSize

public void setSegmentSize(int segments)

getCapacity

public long getCapacity()

Specified by:

getCapacity in interface Storable<StringIndex>

Returns:

the allocated storage size in bytes

copyTo

public void copyTo(StringIndex stringIndex)