Package com.mongodb.client.model.search

Interface CompoundSearchOperatorBase

All Known Subinterfaces:

CompoundSearchOperator, FilterCompoundSearchOperator, MustCompoundSearchOperator, MustNotCompoundSearchOperator, ShouldCompoundSearchOperator

@Evolving
@Beta(CLIENT)
public interface CompoundSearchOperatorBase

A base for a CompoundSearchOperator which allows creating instances of this operator. This interface is a technicality and does not represent a meaningful element of the full-text search query syntax.

Since:

4.7

See Also:

• SearchOperator.compound()

Method Summary

Modifier and Type	Method	Description
FilterCompoundSearchOperator	filter(Iterable<? extends SearchOperator> clauses)	Creates a new CompoundSearchOperator by adding to it clauses that, similarly to must(Iterable), must all be satisfied.
MustCompoundSearchOperator	must(Iterable<? extends SearchOperator> clauses)	Creates a new CompoundSearchOperator by adding to it clauses that must all be satisfied.
MustNotCompoundSearchOperator	mustNot(Iterable<? extends SearchOperator> clauses)	Creates a new CompoundSearchOperator by adding to it clauses that must all not be satisfied.
ShouldCompoundSearchOperator	should(Iterable<? extends SearchOperator> clauses)	Creates a new CompoundSearchOperator by adding to it clauses that are preferred to be satisfied.

Method Details

must

MustCompoundSearchOperator must(Iterable<? extends SearchOperator> clauses)

Creates a new CompoundSearchOperator by adding to it clauses that must all be satisfied.

This method may be called multiple times.

Parameters:

clauses - The non-empty clauses to add.

Returns:

A new CompoundSearchOperator.

mustNot

MustNotCompoundSearchOperator mustNot(Iterable<? extends SearchOperator> clauses)

Creates a new CompoundSearchOperator by adding to it clauses that must all not be satisfied.

This method may be called multiple times.

Parameters:

clauses - The non-empty clauses to add.

Returns:

A new CompoundSearchOperator.

should

ShouldCompoundSearchOperator should(Iterable<? extends SearchOperator> clauses)

Creates a new CompoundSearchOperator by adding to it clauses that are preferred to be satisfied.

This method may be called multiple times.

Parameters:

clauses - The non-empty clauses to add.

Returns:

A new CompoundSearchOperator.

filter

FilterCompoundSearchOperator filter(Iterable<? extends SearchOperator> clauses)

Creates a new CompoundSearchOperator by adding to it clauses that, similarly to must(Iterable), must all be satisfied. The difference is that this method does not affect the relevance score.

This method may be called multiple times.

Parameters:

clauses - The non-empty clauses to add.

Returns:

A new CompoundSearchOperator.