io.georocket.client

Class SearchParams

java.lang.Object

io.georocket.client.SearchParams

public class SearchParams
extends java.lang.Object

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

Since:

1.3.0

Author:

Michel Kraemer

Constructor Summary

Constructors

Constructor and Description
SearchParams()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getLayer() Get the name of the layer where to search for chunks recursively
java.lang.String	getQuery() Get the search query specifying which chunks will be returned
int	hashCode()
boolean	isOptimisticMerging() Get whether optimistic merging is enabled or not.
SearchParams	setLayer(java.lang.String layer) Set the name of the layer where to search for chunks recursively
SearchParams	setOptimisticMerging(boolean optimisticMerging) Enable or disable optimistic merging.
SearchParams	setQuery(java.lang.String query) Set a search query specifying which chunks to return

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchParams

public SearchParams()

Method Detail

setQuery

public SearchParams setQuery(java.lang.String query)

Set a search query specifying which chunks to return

Parameters:

query - the query (may be null if all chunks should be returned)

Returns:

a reference to this, so the API can be used fluently

getQuery

public java.lang.String getQuery()

Get the search query specifying which chunks will be returned

Returns:

the query (may be null if all chunks will be returned)

setLayer

public SearchParams setLayer(java.lang.String layer)

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

Parameters:

layer - the layer (may be null if chunks should be searched in the root layer recursively)

Returns:

a reference to this, so the API can be used fluently

getLayer

public java.lang.String getLayer()

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

Returns:

the layer (may be null if chunks will be searched in the root layer recursively)

setOptimisticMerging

public SearchParams setOptimisticMerging(boolean optimisticMerging)

Enable or disable optimistic merging.

Optimistic merging can tremendously reduce search latency by immediately returning chunks as soon as they have been fetched from GeoRocket's store without initialization. This is particularly useful if the data is homogeneous. The drawback is that GeoRocket might not be able to merge chunks that do not fit to the overall search result. For example, if the store contains XML files and all chunks are homogeneous and have the same XML namespaces they can be merged perfectly with optimistic merging enabled. However, if some chunks have different namespaces, GeoRocket will not be able to merge them if the XML header of the search result has already been sent to the client.

Chunks that cannot be merged will be ignored by GeoRocket and the operation will succeed. The number of chunks that could not be merged can be obtained with SearchReadStreamResult.getUnmergedChunks(). The caller can then decide whether to repeat the query with optimistic merging disabled or not.

Parameters:

optimisticMerging - true if optimistic merging should be enabled, false otherwise.

Returns:

a reference to this, so the API can be used fluently

See Also:

SearchReadStreamResult.getUnmergedChunks()

isOptimisticMerging

public boolean isOptimisticMerging()

Get whether optimistic merging is enabled or not. See setOptimisticMerging(boolean).

Returns:

true if optimistic merging is enabled, false otherwise.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object