io.georocket.query

Interface QueryCompiler

All Known Subinterfaces:

IndexerFactory, JsonIndexerFactory, MetaIndexerFactory, XMLIndexerFactory

public interface QueryCompiler

Compiles search strings to Elasticsearch documents

Since:

1.0.0

Author:

Michel Kraemer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QueryCompiler.MatchPriority Specifies how the query returned by compileQuery(String) should be applied

Method Summary

Modifier and Type	Method and Description
JsonObject	compileQuery(String search) Create an Elasticsearch query for the given search string.
QueryCompiler.MatchPriority	getQueryPriority(String search) Get the priority with which the query returned by compileQuery(String) should be applied for the given search string

Method Detail

getQueryPriority

QueryCompiler.MatchPriority getQueryPriority(String search)

Get the priority with which the query returned by compileQuery(String) should be applied for the given search string

Parameters:

search - the search string

Returns:

the priority

compileQuery

JsonObject compileQuery(String search)

Create an Elasticsearch query for the given search string.

Heads up: implementors may use the helper methods from ElasticsearchQueryHelper to build the query.

Parameters:

search - the search string

Returns:

the query (may be null)