net.antidot.api.search.FacetStickyness Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of afs-api Show documentation

The newest version!

package net.antidot.api.search;

/** Sticky characteristic of facets. 
 * 
 * Facets can be:
 * 

 *   STICKY
 *     Even if results are filtered on one facet value and results involve only this facet value,
 *      all facet values of the facet are still present in Antidot search engine replies.
 *   NON_STICKY
 *     Only facet values involved in Antidot search engine replies are present in the result.
 * 
 * For more details, see What is a sticky facet?.
 */
public enum FacetStickyness {
	/** Internal use to allow auto configuration depending on other facet parameters. */
	UNDEFINED,
	/** All facet values are present in output replies. */
	STICKY,
	/** Only relevant facet values are present in output replies. */
	NON_STICKY
}