io.sphere.sdk.search.TermFacetResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sphere-common Show documentation

sphere-common

There is a newer version: 1.0.0-M26

package io.sphere.sdk.search;

import com.fasterxml.jackson.annotation.JsonCreator;
import io.sphere.sdk.models.Base;

import java.util.List;

public class TermFacetResult extends Base implements FacetResult {
    private final Long missing;
    private final Long total;
    private final Long other;
    private final List terms;

    @JsonCreator
    private TermFacetResult(final Long missing, final Long total, final Long other, final List terms) {
        this.missing = missing;
        this.total = total;
        this.other = other;
        this.terms = terms;
    }

    /**
     * The number of resources which have no value for the corresponding field.
     * Use case: in a product search where a term facet is requested for a color attribute,
     * it would represent the amount of variants with no color associated.
     * @return amount of resources missing a value for the faceted field.
     */
    public Long getMissing() {
        return missing;
    }

    /**
     * The number of resources matching some term in the facet.
     * @return amount of resources that match at least one term in the facet.
     */
    public Long getTotal() {
        return total;
    }

    /**
     * The number of resources not included in the returned list of terms.
     * @return amount of resources matching the terms that could not be included in the facet result.
     */
    public Long getOther() {
        return other;
    }

    /**
     * List of the different terms and amount of associated resources.
     * @return the list of distinct terms aLong with the number of matching resources.
     */
    public List getTerms() {
        return terms;
    }

    public static TermFacetResult of(final Long missing, final Long total, final Long other, final List terms) {
        return new TermFacetResult(missing, total, other, terms);
    }
}