io.sphere.client.model.facets.TermFacetResult Maven / Gradle / Ivy

Go to download

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

sphere-java-client

There is a newer version: 0.72.1

package io.sphere.client.model.facets;

import org.codehaus.jackson.annotate.JsonCreator;
import org.codehaus.jackson.annotate.JsonProperty;

import java.util.List;
import java.util.ArrayList;

/** Aggregated counts for a terms facet, returned as a part of {@link io.sphere.client.model.SearchResult}. */
public class TermFacetResult implements FacetResult {
    private List items = new ArrayList();
    private final int missingValuesCount;
    private final int presentValuesCount;
    private final int notReturnedValuesCount;

    @JsonCreator
    public TermFacetResult(
            @JsonProperty("terms") List items,
            @JsonProperty("missing") int missingValuesCount,
            @JsonProperty("total") int presentValuesCount,
            @JsonProperty("other") int notReturnedValuesCount)
    {
        this.items = items;
        this.missingValuesCount = missingValuesCount;
        this.presentValuesCount = presentValuesCount;
        this.notReturnedValuesCount = notReturnedValuesCount;
    }

    /** The number of resources in the search result that have no value for this facet. */
    public int getMissingValueCount() {
        return missingValuesCount;
    }

    /** The number of resources in the search result that have some value for this facet. */
    public int getPresentValueCount() {
        return presentValuesCount;
    }

    /** The number of resources that have some value for the facet but were not returned. */
    public int getNotReturnedCount() {
        return notReturnedValuesCount;
    }

    /** A list of individual values for this facet and their respective counts. */
    public List getItems() {
        return items;
    }

    @Override
    public String toString() {
        return "TermFacetResult{" +
                "items=" + items +
                ", missingValuesCount=" + missingValuesCount +
                ", presentValuesCount=" + presentValuesCount +
                ", notReturnedValuesCount=" + notReturnedValuesCount +
                '}';
    }
}