se.l4.silo.search.FacetEntry Maven / Gradle / Ivy

Go to download

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

API for Lucene-based querying for Silo.

There is a newer version: 0.2.3

package se.l4.silo.search;

/**
 * Entry as created and returned by a facet when searching. Use {@link Facets}
 * to access them.
 *
 * @author Andreas Holstenson
 *
 */
public interface FacetEntry
{
	/**
	 * Get the label of the facet.
	 *
	 * @return
	 */
	String label();

	/**
	 * Get the number of search results that would match if this facet
	 * was applied.
	 *
	 * @return
	 */
	int count();

	/**
	 * Get the data of the facet.
	 *
	 * @return
	 */
	Object data();
}