org.hibernate.search.elasticsearch.ElasticsearchQueries Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-elasticsearch Show documentation

Hibernate Search backend which has indexing operations forwarded to Elasticsearch

There is a newer version: 5.11.12.Final

Show newest version

/*
 * Hibernate Search, full-text search for your domain model
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.search.elasticsearch;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.hibernate.search.elasticsearch.impl.ElasticsearchJsonQueryDescriptor;
import org.hibernate.search.elasticsearch.impl.JsonBuilder;
import org.hibernate.search.elasticsearch.logging.impl.Log;
import org.hibernate.search.query.engine.spi.QueryDescriptor;
import org.hibernate.search.util.impl.CollectionHelper;
import org.hibernate.search.util.logging.impl.LoggerFactory;
import java.lang.invoke.MethodHandles;

import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import com.google.gson.JsonSyntaxException;

/**
 * Creates queries to be used with Elasticsearch.
 *
 * Methods in this class return {@link QueryDescriptor}s. See {@code QueryDescriptor}'s
 * javadoc for more information about how to use it.
 *
 * @author Gunnar Morling
 */
public class ElasticsearchQueries {

	private static final Log LOG = LoggerFactory.make( Log.class, MethodHandles.lookup() );

	private static final JsonParser PARSER = new JsonParser();

	private static final Set ALLOWED_PAYLOAD_ATTRIBUTES = Collections.unmodifiableSet(
			CollectionHelper.asSet( "query" ) );

	private ElasticsearchQueries() {
	}

	/**
	 * Creates an Elasticsearch query from the given JSON payload for the Elasticsearch Search API.
	 * 

	 * Note that only the 'query' attribute is supported.
	 * 

	 * See the 
	 * official documentation for the complete payload syntax.
	 *
	 * @param payload The JSON payload as a String
	 * @return A query descriptor that can be used to create a query.
	 */
	public static QueryDescriptor fromJson(String payload) {
		JsonObject payloadAsJsonObject;

		try {
			payloadAsJsonObject = PARSER.parse( payload ).getAsJsonObject();
		}
		catch (IllegalStateException | JsonSyntaxException e) {
			throw LOG.invalidSearchAPIPayload( e );
		}

		List invalidAttributes = new ArrayList<>();
		for ( Map.Entry entry : payloadAsJsonObject.entrySet() ) {
			String payloadAttribute = entry.getKey();
			if ( ! ALLOWED_PAYLOAD_ATTRIBUTES.contains( payloadAttribute ) ) {
				invalidAttributes.add( payloadAttribute );
			}
		}
		if ( !invalidAttributes.isEmpty() ) {
			throw LOG.unsupportedSearchAPIPayloadAttributes( invalidAttributes );
		}

		return new ElasticsearchJsonQueryDescriptor( PARSER.parse( payload ).getAsJsonObject() );
	}

	/**
	 * Creates an Elasticsearch query from the given Query String Query, as e.g. to be used with the "q" parameter in
	 * the Elasticsearch Search API.
	 * 
	 * See the 
	 * official documentation for the query syntax.
	 *
	 * @param queryStringQuery A query string conforming to the "query string" syntax.
	 * @return A query descriptor that can be used to create a query.
	 */
	public static QueryDescriptor fromQueryString(String queryStringQuery) {
		// Payload looks like so:
		// { "query" : { "query_string" : { "query" : "abstract:Hibernate" } } }

		JsonBuilder.Object query = JsonBuilder.object().add( "query",
				JsonBuilder.object().add( "query_string",
						JsonBuilder.object().addProperty( "query", queryStringQuery ) ) );

		return new ElasticsearchJsonQueryDescriptor( query.build() );
	}
}