/* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you 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.
*/
using System;
using System.Runtime.Serialization;
namespace OpenSearch.Client
{
public interface IQuery
{
///
/// Provides a boost to this query to influence its relevance score.
/// For example, a query with a boost of 2 is twice as important as a query with a boost of 1,
/// although the actual boost value that is applied undergoes normalization and internal optimization.
///
///
/// Setting a boost for an query will throw a parsing exception on the server.
///
[DataMember(Name = "boost")]
double? Boost { get; set; }
///
/// Whether the query is conditionless. A conditionless query is not serialized as part of the request
/// sent to OpenSearch.
///
[IgnoreDataMember]
bool Conditionless { get; }
///
/// Whether the query should be treated as strict. A strict query will throw an exception when serialized
/// if it is .
///
[IgnoreDataMember]
bool IsStrict { get; set; }
///
/// Whether the query should be treated as verbatim. A verbatim query will be serialized as part of the request,
/// irrespective
/// of whether it is or not.
///
[IgnoreDataMember]
bool IsVerbatim { get; set; }
///
/// Whether the query should be treated as writable. Used when determining how to combine queries.
///
[IgnoreDataMember]
bool IsWritable { get; }
///
/// The name of the query. Allows you to retrieve for each document what part of the query it matched on.
///
[DataMember(Name = "_name")]
string Name { get; set; }
}
public abstract class QueryBase : IQuery
{
public double? Boost { get; set; }
public bool IsStrict { get; set; }
public bool IsVerbatim { get; set; }
public bool IsWritable => IsVerbatim || !Conditionless;
///
public string Name { get; set; }
protected abstract bool Conditionless { get; }
bool IQuery.Conditionless => Conditionless;
//always evaluate to false so that each side of && equation is evaluated
public static bool operator false(QueryBase a) => false;
//always evaluate to false so that each side of && equation is evaluated
public static bool operator true(QueryBase a) => false;
public static QueryBase operator &(QueryBase leftQuery, QueryBase rightQuery) => Combine(leftQuery, rightQuery, (l, r) => l && r);
public static QueryBase operator |(QueryBase leftQuery, QueryBase rightQuery) => Combine(leftQuery, rightQuery, (l, r) => l || r);
public static QueryBase operator !(QueryBase query) => query == null || !query.IsWritable
? null
: new BoolQuery { MustNot = new QueryContainer[] { query } };
public static QueryBase operator +(QueryBase query) => query == null || !query.IsWritable
? null
: new BoolQuery { Filter = new QueryContainer[] { query } };
private static QueryBase Combine(QueryBase leftQuery, QueryBase rightQuery, Func combine)
{
if (IfEitherIsEmptyReturnTheOtherOrEmpty(leftQuery, rightQuery, out var q))
return q;
IQueryContainer container = combine(leftQuery, rightQuery);
var query = container.Bool;
return new BoolQuery
{
Must = query.Must,
MustNot = query.MustNot,
Should = query.Should,
Filter = query.Filter,
};
}
private static bool IfEitherIsEmptyReturnTheOtherOrEmpty(QueryBase leftQuery, QueryBase rightQuery, out QueryBase query)
{
query = null;
if (leftQuery == null && rightQuery == null) return true;
var leftWritable = leftQuery?.IsWritable ?? false;
var rightWritable = rightQuery?.IsWritable ?? false;
if (leftWritable && rightWritable) return false;
if (!leftWritable && !rightWritable) return true;
query = leftWritable ? leftQuery : rightQuery;
return true;
}
public static implicit operator QueryContainer(QueryBase query) =>
query == null ? null : new QueryContainer(query);
internal void WrapInContainer(IQueryContainer container)
{
container.IsVerbatim = IsVerbatim;
container.IsStrict = IsStrict;
InternalWrapInContainer(container);
}
internal abstract void InternalWrapInContainer(IQueryContainer container);
}
}