com.couchbase.client.java.search.result.hits.HitLocations 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.hits;

import java.util.List;
import java.util.Set;

import com.couchbase.client.core.annotations.InterfaceAudience;
import com.couchbase.client.core.annotations.InterfaceStability;

/**
 * Represents the locations of a search result hit. {@link HitLocation locations} show
 * where a given term occurs inside of a given field.
 *
 * @author Simon Baslé
 * @author Michael Nitschinger
 * @since 2.3.0
 */
@InterfaceStability.Experimental
@InterfaceAudience.Public
public interface HitLocations {

    /** add a location and allow method chaining */
    HitLocations add(HitLocation l);

    /**list all locations for a given field (any term) */
    List get(String field);

    /**list all locations for a given field and term */
    List get(String field, String term);

    /**list all locations (any field, any term) */
    List getAll();

    /**size of all() */
    long count();

    /**list the fields in this location */
    List fields();

    /**list the terms for a given field */
    List termsFor(String field);

    /**list all terms in this locations, considering all fields (so a set) */
    Set terms();
}