/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat, Inc. and/or its affiliates or third-party contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors. All third-party contributions are
* distributed under license by Red Hat, Inc.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package org.hibernate.search.query.dsl;
/**
* @author Emmanuel Bernard
*/
public interface FieldCustomization<T> {
/**
* 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)
*/
T boostedTo(float boost);
/**
* Advanced
* Do not execute the analyzer on the text.
* (It is usually a good idea to apply the analyzer)
*/
T ignoreAnalyzer();
/**
* Do not try and find the field bridge nor apply the object / string conversion
* matching objects should be of type String in this case.
*/
T ignoreFieldBridge();
}