001/* 002 * (C) Copyright 2019 Nuxeo (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * 016 * Contributors: 017 * Salem Aouana 018 */ 019 020package org.nuxeo.elasticsearch.api; 021 022import org.elasticsearch.index.query.QueryBuilder; 023import org.nuxeo.ecm.core.query.sql.model.EsHint; 024 025/** 026 * Converts an NXQL Elasticsearch Hint into {@link org.elasticsearch.index.query.QueryBuilder}. 027 * 028 * @since 11.1 029 */ 030public interface ESHintQueryBuilder { 031 032 /** 033 * Builds the Elasticsearch {@link org.elasticsearch.index.query.QueryBuilder}. 034 * 035 * @param hint the elasticsearch hint 036 * @param fieldName the elasticsearch field name 037 * @param value the value that we are looking for 038 * @return the {@link QueryBuilder} corresponding to the <code>elasticsearch hint</code> 039 */ 040 QueryBuilder make(EsHint hint, String fieldName, Object value); 041}