com.couchbase.client.java.search.result.facets.FacetResult Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016 Couchbase, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.couchbase.client.java.search.result.facets;

import com.couchbase.client.core.annotations.InterfaceAudience;
import com.couchbase.client.core.annotations.InterfaceStability;
import com.couchbase.client.java.search.facet.SearchFacet;

/**
 * Base interface for all facet results.
 *
 * @author Simon Baslé
 * @author Michael Nitschinger
 * @since 2.3.0
 */
@InterfaceStability.Experimental
@InterfaceAudience.Public
public interface FacetResult {

    /**
     * @return the name of the {@link SearchFacet} this result corresponds to.
     */
    String name();

    /**
     * @return the field the {@link SearchFacet} was targeting.
     */
    String field();

    /**
     * @return the total number of *valued* facet results. Total = {@link #other()} + terms (but doesn't include
     * {@link #missing()}).
     */
    long total();

    /**
     * @return the number of results that couldn't be faceted, missing the adequate value. Not matter how many more
     * buckets are added to the original facet, these result won't ever be included in one.
     */
    long missing();

    /**
     * @return the number of results that could have been faceted (because they have a value for the facet's field) but
     * weren't, due to not having a bucket in which they belong. Adding a bucket can result in these results being faceted.
     */
    long other();
}