com.couchbase.client.java.search.queries.BooleanQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
The official Couchbase Java SDK
There is a newer version: 3.7.5
/*
 * 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.queries;

import com.couchbase.client.core.api.search.CoreSearchQuery;
import com.couchbase.client.core.api.search.queries.CoreBooleanQuery;
import com.couchbase.client.java.search.SearchQuery;
import reactor.util.annotation.Nullable;

/**
 * A compound FTS query that allows various combinations of sub-queries.
 *
 * @since 2.3.0
 */
public class BooleanQuery extends SearchQuery {

    @Nullable private ConjunctionQuery must;
    @Nullable private DisjunctionQuery mustNot;
    @Nullable private DisjunctionQuery should;

    /**
     * Specifies the minimum number of "{@link #should}" conditions a document
     * has to meet in order to be included in the result set.
     * 
     * The default is zero, a special value that means different
     * things depending on whether a "{@link #must}" condition is present:
     * 

     *   If there is no "must" condition, {@code shouldMin = 0}
     *       is the same as {@code shouldMin = 1}. In this case,
     *       a document has to meet at least one "should" condition
     *       (and none of the "{@link #mustNot}" conditions) in order to
     *       be included in the result set.
     *   
If there is a "must" condition, {@code shouldMin = 0}
     *       means the "should" conditions influence scoring
     *       but are not used as document selection criteria.
     *       In this case, only the "must" and "mustNot" conditions
     *       affect whether a document is included in the result set.
     * 
     *
     * In other words, if your {@link BooleanQuery} has "must" conditions
     * as well as "should" conditions, and you want the "should" conditions
     * to affect which documents are included in the result set,
     * then call this method to set {@code shouldMin} to a value greater than zero.
     *
     * @see #should(SearchQuery...)
     */
    public BooleanQuery shouldMin(int minForShould) {
        if (this.should == null) {
          this.should = new DisjunctionQuery();
        }
        this.should.min(minForShould);
        return this;
    }

    public BooleanQuery must(SearchQuery... mustQueries) {
        if (this.must == null) {
          this.must = new ConjunctionQuery();
        }
        must.and(mustQueries);
        return this;
    }

    public BooleanQuery mustNot(SearchQuery... mustNotQueries) {
        if (this.mustNot == null) {
          this.mustNot = new DisjunctionQuery();
        }
        mustNot.or(mustNotQueries);
        return this;
    }

    /**
     * @see #shouldMin(int)
     */
    public BooleanQuery should(SearchQuery... shouldQueries) {
        if (this.should == null) {
          this.should = new DisjunctionQuery();
        }
        should.or(shouldQueries);
        return this;
    }

    @Override
    public BooleanQuery boost(double boost) {
        super.boost(boost);
        return this;
    }

    @Override
    public CoreSearchQuery toCore() {
        return new CoreBooleanQuery(
            must == null ? null : must.toCore(),
            mustNot == null ? null : mustNot.toCore(),
            should == null ? null : should.toCore(),
            boost
        );
    }
}