org.hibernate.search.query.dsl.SimpleQueryStringMatchingContext Maven / Gradle / Ivy

Go to download

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

Core of the Object/Lucene mapper, query engine and index management

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.query.dsl;

/**
* @author Guillaume Smet
*/
public interface SimpleQueryStringMatchingContext extends SimpleQueryStringDefinitionTermination {
	/**
	 * Boost the field to a given value
	 * Most of the time positive float:
	 *  - lower than 1 to diminish the weight
	 *  - higher than 1 to increase the weight
	 *
	 * Could be negative but not unless you understand what is going on (advanced)
	 */
	SimpleQueryStringMatchingContext boostedTo(float boost);

	/**
	 * Field the query is executed on.
	 */
	SimpleQueryStringMatchingContext andField(String field);

	/**
	 * Fields the query is executed on.
	 */
	SimpleQueryStringMatchingContext andFields(String... field);

	/**
	 * Define the default operator as AND.
	 */
	SimpleQueryStringDefinitionTermination withAndAsDefaultOperator();

}