com.couchbase.client.scala.search.queries.DocIdQuery.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scala-client_2.12 Show documentation

The official Couchbase Scala SDK

There is a newer version: 1.7.5

/*
 * Copyright (c) 2019 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.scala.search.queries

import com.couchbase.client.core.api.search.queries.CoreDocIdQuery

import scala.jdk.CollectionConverters._

/** An FTS query that matches on Couchbase document IDs. Useful to restrict the search space to a list of keys
  * (by using this in an [[AbstractCompoundQuery]] compound query).
  *
  * @param docIds list of document IDs to be restricted against. At least one ID is required.
  *
  * @since 1.0.0
  */
case class DocIdQuery(
    private[scala] val docIds: Seq[String],
    private[scala] val boost: Option[Double] = None
) extends SearchQuery {

  /** The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease
    * the relative weight (with a boost between 0 and 1)
    *
    * @param boost the boost parameter, which must be >= 0
    *
    * @return a copy of this, for chaining
    */
  def boost(boost: Double): DocIdQuery = {
    copy(boost = Some(boost))
  }

  override private[scala] def toCore =
    new CoreDocIdQuery(boost.map(_.asInstanceOf[java.lang.Double]).orNull, docIds.asJava)
}