A

AbstractClient - Class in io.georocket.client

A client connecting to the GeoRocket api

AbstractClient(HttpClient) - Constructor for class io.georocket.client.AbstractClient

Construct a new client using the given HTTP client

addProperties(Collection<String>) - Method in class io.georocket.client.ImportParams

Add items to the collection of properties to attach to the imported data

addProperties(String...) - Method in class io.georocket.client.ImportParams

Add items to the collection of properties to attach to the imported data

addProperty(String) - Method in class io.georocket.client.ImportParams

Add a property to the collection of properties to attach to the imported data

addTag(String) - Method in class io.georocket.client.ImportParams

Add a tag to the collection of tags to attach to the imported data

addTags(Collection<String>) - Method in class io.georocket.client.ImportParams

Add items to the collection of tags to attach to the imported data

addTags(String...) - Method in class io.georocket.client.ImportParams

Add items to the collection of tags to attach to the imported data

appendTags(String, String, List<String>, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Append tags to chunks in the GeoRocket data store.

C

client - Variable in class io.georocket.client.AbstractClient

HTTP client used to connect to GeoRocket

client - Variable in class io.georocket.client.GeoRocketClient

HTTP client used to connect to GeoRocket

ClientAPIException - Class in io.georocket.client

An exception that will be created if an API exception has happened on the client-side

ClientAPIException(String, String) - Constructor for class io.georocket.client.ClientAPIException

Create a new exception

close() - Method in class io.georocket.client.GeoRocketClient

Close this client and release all resources

configureRequest(HttpClientRequest) - Method in class io.georocket.client.AbstractClient

Configure an HTTP request.

D

DEFAULT_HOST - Static variable in class io.georocket.client.GeoRocketClient

Default server host: "localhost"

DEFAULT_PORT - Static variable in class io.georocket.client.GeoRocketClient

Default server port: 63020

delete(String, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Delete chunks from the GeoRocket data store.

delete(String, String, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Delete chunks or layers from the GeoRocket data store.

E

endHandler(Handler<Void>) - Method in class io.georocket.client.SearchReadStream

 

endHandlerWithResult(Handler<SearchReadStreamResult>) - Method in class io.georocket.client.SearchReadStream

Set an end handler.

equals(Object) - Method in class io.georocket.client.ImportParams

 

equals(Object) - Method in class io.georocket.client.SearchParams

 

exceptionHandler(Handler<Throwable>) - Method in class io.georocket.client.SearchReadStream

 

F

fail(HttpClientResponse, Handler<AsyncResult<T>>) - Static method in class io.georocket.client.AbstractClient

Parses an HTTP response and calls the given handler with the parsed error message

fail(HttpClientResponse, Handler<AsyncResult<T>>, Function<String, Throwable>) - Static method in class io.georocket.client.AbstractClient

Parses an HTTP response, maps it to an exception and then calls the given handler

fetch(long) - Method in class io.georocket.client.SearchReadStream

 

G

GeoRocketClient - Class in io.georocket.client

Provides interface to perform operations against a GeoRocket server

GeoRocketClient(Vertx) - Constructor for class io.georocket.client.GeoRocketClient

Create a client connecting to GeoRocket running on "localhost":63020

GeoRocketClient(String, Vertx) - Constructor for class io.georocket.client.GeoRocketClient

Create a client connecting to GeoRocket running on the specified host and the default port 63020

GeoRocketClient(String, int, Vertx) - Constructor for class io.georocket.client.GeoRocketClient

Create a client connecting to GeoRocket running on the specified host and port

GeoRocketClient(HttpClientOptions, Vertx) - Constructor for class io.georocket.client.GeoRocketClient

Create a client connecting to GeoRocket running with specified options

GeoRocketClient(HttpClient) - Constructor for class io.georocket.client.GeoRocketClient

Create a client connecting to GeoRocket through the given HTTP client

getCompression() - Method in class io.georocket.client.ImportParams

Get the compression method

getEndpoint() - Method in class io.georocket.client.StoreClient

Return the HTTP endpoint, the GeoRocket data store path at server side.

getFallbackCRS() - Method in class io.georocket.client.ImportParams

Get the CRS that should be used if the imported file does not specify one

getLayer() - Method in class io.georocket.client.ImportParams

Get the layer to import to

getLayer() - Method in class io.georocket.client.SearchParams

Get the name of the layer where to search for chunks recursively

getProperties() - Method in class io.georocket.client.ImportParams

Get the collection of properties to attach to the imported data

getPropertyValues(String, String, String, Handler<AsyncResult<ReadStream<Buffer>>>) - Method in class io.georocket.client.StoreClient

Search the GeoRocket store for all values of the specified property and return a ReadStream of merged values matching the given criteria.

getQuery() - Method in class io.georocket.client.SearchParams

Get the search query specifying which chunks will be returned

getResponse() - Method in class io.georocket.client.SearchResult

Get a ReadStream from which the merged chunks matching the search criteria can be read

getResult() - Method in class io.georocket.client.SearchReadStream

Get a result object that contains information only available after the stream has ended.

getSize() - Method in class io.georocket.client.ImportParams

Get the size of data to be sent in bytes.

getStore() - Method in class io.georocket.client.GeoRocketClient

Create a new client accessing the GeoRocket data store

getTags() - Method in class io.georocket.client.ImportParams

Get the collection of tags to attach to the imported data

getType() - Method in class io.georocket.client.ClientAPIException

Get the type of the error

getUnmergedChunks() - Method in class io.georocket.client.SearchReadStreamResult

Get the number of chunks that could not be merged.

getWithParameter(String, String, String, String, String, Handler<AsyncResult<ReadStream<Buffer>>>) - Method in class io.georocket.client.AbstractClient

Execute a get request with specified path, query and additional parameter

H

handler(Handler<Buffer>) - Method in class io.georocket.client.SearchReadStream

 

hashCode() - Method in class io.georocket.client.ImportParams

 

hashCode() - Method in class io.georocket.client.SearchParams

 

I

ImportParams - Class in io.georocket.client

Parameters that can be passed to startImport(ImportParams, io.vertx.core.Handler)

ImportParams() - Constructor for class io.georocket.client.ImportParams

 

ImportParams.Compression - Enum in io.georocket.client

A compression method

ImportResult - Class in io.georocket.client

Results returned by startImport(ImportParams, io.vertx.core.Handler) when the data has been imported into GeoRocket

ImportResult() - Constructor for class io.georocket.client.ImportResult

 

io.georocket.client - package io.georocket.client

 

isOptimisticMerging() - Method in class io.georocket.client.SearchParams

Get whether optimistic merging is enabled or not.

P

parse(String) - Static method in class io.georocket.client.ClientAPIException

Parse an API exception from a JSON string

pause() - Method in class io.georocket.client.SearchReadStream

 

prepareImport(String, Collection<String>) - Method in class io.georocket.client.StoreClient

Prepare an import.

prepareImport(String, Collection<String>, Collection<String>) - Method in class io.georocket.client.StoreClient

Prepare an import.

prepareImport(String, Collection<String>, Collection<String>, String) - Method in class io.georocket.client.StoreClient

Prepare an import.

prepareQuery(String, String) - Method in class io.georocket.client.AbstractClient

Prepare a query.

prepareQuery(String, String, boolean) - Method in class io.georocket.client.AbstractClient

Prepare a query.

R

removeProperties(String, String, List<String>, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Remove properties from chunks in the GeoRocket data store.

removeTags(String, String, List<String>, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Remove tags from chunks in the GeoRocket data store.

resume() - Method in class io.georocket.client.SearchReadStream

 

S

search(Handler<AsyncResult<ReadStream<Buffer>>>) - Method in class io.georocket.client.StoreClient

Export the contents of the whole GeoRocket data store.

search(String, Handler<AsyncResult<ReadStream<Buffer>>>) - Method in class io.georocket.client.StoreClient

Search the GeoRocket data store and return a ReadStream of merged chunks matching the given criteria.

search(String, String, Handler<AsyncResult<ReadStream<Buffer>>>) - Method in class io.georocket.client.StoreClient

Deprecated.

Use search(SearchParams, Handler) instead

search(SearchParams, Handler<AsyncResult<SearchResult>>) - Method in class io.georocket.client.StoreClient

Search the GeoRocket data store and return a SearchResult containing a ReadStream of merged chunks matching the given options.

SearchParams - Class in io.georocket.client

Parameters that can be passed to search(SearchParams, io.vertx.core.Handler)

SearchParams() - Constructor for class io.georocket.client.SearchParams

 

SearchReadStream - Class in io.georocket.client

A read stream from which merged chunks can be read

SearchReadStream(HttpClientResponse) - Constructor for class io.georocket.client.SearchReadStream

Create a new read stream

SearchReadStreamResult - Class in io.georocket.client

Results that become available after a SearchReadStream has been read completely

SearchReadStreamResult(long) - Constructor for class io.georocket.client.SearchReadStreamResult

Create a new result

SearchResult - Class in io.georocket.client

Results returned by startImport(ImportParams, io.vertx.core.Handler) when the data has been imported into GeoRocket

SearchResult(SearchReadStream) - Constructor for class io.georocket.client.SearchResult

Create a new result

setCompression(ImportParams.Compression) - Method in class io.georocket.client.ImportParams

Set the compression method that is applied to the data that will be sent to the WriteStream returned by startImport(ImportParams, io.vertx.core.Handler).

setFallbackCRS(String) - Method in class io.georocket.client.ImportParams

Set the CRS that should be used if the imported file does not specify one

setLayer(String) - Method in class io.georocket.client.ImportParams

Set the layer to import to

setLayer(String) - Method in class io.georocket.client.SearchParams

Set the name of the layer where to search for chunks recursively

setOptimisticMerging(boolean) - Method in class io.georocket.client.SearchParams

Enable or disable optimistic merging.

setProperties(Collection<String>) - Method in class io.georocket.client.ImportParams

Set a collection of properties to attach to the imported data

setProperties(String, String, List<String>, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Set properties of chunks in the GeoRocket data store.

setQuery(String) - Method in class io.georocket.client.SearchParams

Set a search query specifying which chunks to return

setSize(Long) - Method in class io.georocket.client.ImportParams

Set the size of the data to be sent in bytes.

setTags(Collection<String>) - Method in class io.georocket.client.ImportParams

Set a collection of tags to attach to the imported data

startImport(Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Start importing data to GeoRocket.

startImport(String, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Start importing data to GeoRocket.

startImport(String, Collection<String>, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Deprecated.

Use startImport(ImportParams, Handler) instead

startImport(String, Collection<String>, Collection<String>, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Deprecated.

Use startImport(ImportParams, Handler) instead

startImport(String, Collection<String>, long, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Deprecated.

Use startImport(ImportParams, Handler) instead

startImport(String, Collection<String>, Collection<String>, long, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Deprecated.

Use startImport(ImportParams, Handler) instead

startImport(String, Collection<String>, Optional<Long>, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Deprecated.

Use startImport(ImportParams, Handler) instead

startImport(String, Collection<String>, Collection<String>, Optional<Long>, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Deprecated.

Use startImport(ImportParams, Handler) instead

startImport(String, Collection<String>, Collection<String>, Optional<Long>, String, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.StoreClient

Deprecated.

Use startImport(ImportParams, Handler) instead

startImport(ImportParams, Handler<AsyncResult<ImportResult>>) - Method in class io.georocket.client.StoreClient

Start importing data to GeoRocket.

StoreClient - Class in io.georocket.client

A client connecting to the GeoRocket data store

StoreClient(HttpClient) - Constructor for class io.georocket.client.StoreClient

Construct a new store client using the given HTTP client

U

update(HttpMethod, String, String, String, String, List<String>, Handler<AsyncResult<Void>>) - Method in class io.georocket.client.AbstractClient

Update a field in the chunk metadata (such as properties or tags).

urlencode(String) - Method in class io.georocket.client.AbstractClient

Convenience method to URL-encode a string

V

valueOf(String) - Static method in enum io.georocket.client.ImportParams.Compression

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.georocket.client.ImportParams.Compression

Returns an array containing the constants of this enum type, in the order they are declared.