nl.vpro.domain.api.Facet Maven / Gradle / Ivy

Go to download

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

Contains the objects used by the Frontend API, like forms and result objects

There is a newer version: 8.3.3

/*
 * Copyright (C) 2013 All rights reserved
 * VPRO The Netherlands
 */
package nl.vpro.domain.api;

/**
 * A facet is a kind of aggregation. Counts per bucket.
 *
 * @author Roelof Jan Koekoek
 * @since 2.0
 */
public interface Facet {

    /**
     * The filter of facet defines on which parts of the complete index the facet must be applied.
     *
     * This may be implicit ('profiles'), but it can also be done explicitely
     *
     * E.g. apply facets only on all object of type 'ALBUM'.
     * See also {@link SearchableFacet} for limiting the number of facet values you're interested in.
     */
    F getFilter();

    void setFilter(F search);


    default boolean hasFilter() {
        return this.getFilter() != null && this.getFilter().hasSearches();
    }
}