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

Go to download
package net.antidot.api.search;

import java.util.List;

/** Interface representing one facet value.
 * 
 * You can get access to main data such as:
 * 

 *   key used to filter on specific facet value,
 *   label for better integration than simple key,
 *   count of documents defining the facet value,
 *   sub-facet values for hierarchical facets.
 * 
 */
public interface FacetValueHelperInterface {
	/** Retrieves key of the facet value.
	 * This key is used to filter on this specific facet value.
	 * @return key of the facet value.
	 */
	public String getKey();
	/** Retrieves label of the facet value.
	 * This label can be used instead of the key for a better web integration.
	 *  
	 * If no label has been defined on PaF side,
	 * this method should return same result as {@link #getKey()} method.
	 * @return label of the facet value.
	 */
	public String getLabel();
	/** Retrieves number of documents which defines this specific facet value.
	 * @return number of documents defining this facet value.
	 */
	public long getCount();
	/** Lists sub-values of this facet value.
	 * This list can be empty if sub-values are not applicable.
	 * @return sub-values of the facet value.
	 */
	public List getValues();
}