Skip to content

Add wildcard and prefix interval rules #4060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/CodeGeneration/DocGenerator/StringExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public static class StringExtensions
{ "_ctxNumberofCommits", "\"_source.numberOfCommits > 0\"" },
{ "Project.First.Name", "\"Lesch Group\"" },
{ "Project.First.NumberOfCommits", "775" },
{ "IntervalsPrefix", "\"lorem\"" },
{ "LastNameSearch", "\"Stokes\"" },
{ "_first.Language", "\"painless\"" },
{ "_first.Init", "\"state.map = [:]\"" },
Expand Down
71 changes: 71 additions & 0 deletions src/Nest/QueryDsl/FullText/Intervals/IntervalsPrefix.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
using System;
using System.Linq.Expressions;
using System.Runtime.Serialization;

namespace Nest
{
/// <summary>
/// Matches terms that start with a specified set of characters. This prefix can expand to match at most 128 terms.
/// If the prefix matches more than 128 terms, Elasticsearch returns an error.
/// You can use the index-prefixes option in the field mapping to avoid this limit.
/// <para />
/// Available in Elasticsearch 7.3.0+
/// </summary>
[ReadAs(typeof(IntervalsPrefix))]
public interface IIntervalsPrefix : IIntervalsNoFilter
{
/// <summary>
/// Analyzer used to normalize the prefix. Defaults to the top-level field's analyzer.
/// </summary>
[DataMember(Name = "analyzer")]
string Analyzer { get; set; }

/// <summary>
/// Beginning characters of terms you wish to find in the top-level field
/// </summary>
[DataMember(Name = "prefix")]
string Prefix { get; set; }

/// <summary>
/// If specified, then match intervals from this field rather than the top-level field.
/// The prefix is normalized using the search analyzer from this field, unless a separate analyzer is specified.
/// </summary>
[DataMember(Name = "use_field")]
Field UseField { get; set; }
}

/// <inheritdoc cref="IIntervalsPrefix" />
public class IntervalsPrefix : IntervalsNoFilterBase, IIntervalsPrefix
{
/// <inheritdoc />
public string Analyzer { get; set; }

/// <inheritdoc />
public string Prefix { get; set; }

/// <inheritdoc />
public Field UseField { get; set; }

internal override void WrapInContainer(IIntervalsContainer container) => container.Prefix = this;
}

/// <inheritdoc cref="IIntervalsPrefix" />
public class IntervalsPrefixDescriptor : DescriptorBase<IntervalsPrefixDescriptor, IIntervalsPrefix>, IIntervalsPrefix
{
string IIntervalsPrefix.Analyzer { get; set; }
string IIntervalsPrefix.Prefix { get; set; }
Field IIntervalsPrefix.UseField { get; set; }

/// <inheritdoc cref="IIntervalsPrefix.Analyzer" />
public IntervalsPrefixDescriptor Analyzer(string analyzer) => Assign(analyzer, (a, v) => a.Analyzer = v);

/// <inheritdoc cref="IIntervalsPrefix.Prefix" />
public IntervalsPrefixDescriptor Prefix(string prefix) => Assign(prefix, (a, v) => a.Prefix = v);

/// <inheritdoc cref="IIntervalsPrefix.UseField" />
public IntervalsPrefixDescriptor UseField<T>(Expression<Func<T, object>> objectPath) => Assign(objectPath, (a, v) => a.UseField = v);

/// <inheritdoc cref="IIntervalsPrefix.UseField" />
public IntervalsPrefixDescriptor UseField(Field useField) => Assign(useField, (a, v) => a.UseField = v);
}
}
72 changes: 70 additions & 2 deletions src/Nest/QueryDsl/FullText/Intervals/IntervalsQuery.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,16 @@ public class IntervalsQuery : FieldNameQueryBase, IIntervalsQuery
/// <inheritdoc cref="IIntervalsMatch"/>
public IIntervalsMatch Match { get; set; }

/// <inheritdoc cref="IIntervalsPrefix"/>
public IIntervalsPrefix Prefix { get; set; }

/// <inheritdoc cref="IIntervalsWildcard"/>
public IIntervalsWildcard Wildcard { get; set; }

protected override bool Conditionless => IsConditionless(this);

internal static bool IsConditionless(IIntervalsQuery q) =>
q.Field.IsConditionless() || q.Match == null && q.AllOf == null && q.AnyOf == null;
q.Field.IsConditionless() || q.Match == null && q.AllOf == null && q.AnyOf == null && q.Prefix == null && q.Wildcard == null;

internal override void InternalWrapInContainer(IQueryContainer container) => container.Intervals = this;
}
Expand All @@ -45,11 +51,21 @@ public class IntervalsQueryDescriptor<T>
IIntervalsAllOf IIntervalsContainer.AllOf { get; set; }
IIntervalsAnyOf IIntervalsContainer.AnyOf { get; set; }
IIntervalsMatch IIntervalsContainer.Match { get; set; }
IIntervalsPrefix IIntervalsContainer.Prefix { get; set; }
IIntervalsWildcard IIntervalsContainer.Wildcard { get; set; }

/// <inheritdoc cref="IntervalsQuery.Match" />
public IntervalsQueryDescriptor<T> Match(Func<IntervalsMatchDescriptor, IIntervalsMatch> selector) =>
Assign(selector, (a, v) => a.Match = v?.Invoke(new IntervalsMatchDescriptor()));

/// <inheritdoc cref="IntervalsQuery.Prefix" />
public IntervalsQueryDescriptor<T> Prefix(Func<IntervalsPrefixDescriptor, IIntervalsPrefix> selector) =>
Assign(selector, (a, v) => a.Prefix = v?.Invoke(new IntervalsPrefixDescriptor()));

/// <inheritdoc cref="IntervalsQuery.Wildcard" />
public IntervalsQueryDescriptor<T> Wildcard(Func<IntervalsWildcardDescriptor, IIntervalsWildcard> selector) =>
Assign(selector, (a, v) => a.Wildcard = v?.Invoke(new IntervalsWildcardDescriptor()));

/// <inheritdoc cref="IntervalsQuery.AnyOf" />
public IntervalsQueryDescriptor<T> AnyOf(Func<IntervalsAnyOfDescriptor, IIntervalsAnyOf> selector) =>
Assign(selector, (a, v) => a.AnyOf = v?.Invoke(new IntervalsAnyOfDescriptor()));
Expand All @@ -75,6 +91,14 @@ public interface IIntervalsContainer
/// <inheritdoc cref="IIntervalsMatch" />
[DataMember(Name = "match")]
IIntervalsMatch Match { get; set; }

/// <inheritdoc cref="IIntervalsPrefix" />
[DataMember(Name = "prefix")]
IIntervalsPrefix Prefix { get; set; }

/// <inheritdoc cref="IIntervalsWildcard" />
[DataMember(Name = "wildcard")]
IIntervalsWildcard Wildcard { get; set; }
}

/// <inheritdoc cref="IIntervalsContainer" />
Expand All @@ -88,13 +112,25 @@ public IntervalsContainer(IntervalsBase intervals)
intervals.WrapInContainer(this);
}

public IntervalsContainer(IntervalsNoFilterBase intervals)
{
intervals.ThrowIfNull(nameof(intervals));
intervals.WrapInContainer(this);
}

IIntervalsAllOf IIntervalsContainer.AllOf { get; set; }
IIntervalsAnyOf IIntervalsContainer.AnyOf { get; set; }
IIntervalsMatch IIntervalsContainer.Match { get; set; }
IIntervalsPrefix IIntervalsContainer.Prefix { get; set; }
IIntervalsWildcard IIntervalsContainer.Wildcard { get; set; }

public static implicit operator IntervalsContainer(IntervalsBase intervals) => intervals == null
? null
: new IntervalsContainer(intervals);

public static implicit operator IntervalsContainer(IntervalsNoFilterBase intervals) => intervals == null
? null
: new IntervalsContainer(intervals);
}

/// <summary>
Expand All @@ -109,6 +145,14 @@ private IntervalsDescriptor Assign<TValue>(TValue value, Action<IIntervalsContai
public IntervalsDescriptor Match(Func<IntervalsMatchDescriptor, IIntervalsMatch> selector) =>
Assign(selector, (a, v) => a.Match = v?.Invoke(new IntervalsMatchDescriptor()));

/// <inheritdoc cref="IntervalsPrefixDescriptor" />
public IntervalsDescriptor Prefix(Func<IntervalsPrefixDescriptor, IIntervalsPrefix> selector) =>
Assign(selector, (a, v) => a.Prefix = v?.Invoke(new IntervalsPrefixDescriptor()));

/// <inheritdoc cref="IntervalsWildcardDescriptor" />
public IntervalsDescriptor Wildcard(Func<IntervalsWildcardDescriptor, IIntervalsWildcard> selector) =>
Assign(selector, (a, v) => a.Wildcard = v?.Invoke(new IntervalsWildcardDescriptor()));

/// <inheritdoc cref="IntervalsAnyOfDescriptor" />
public IntervalsDescriptor AnyOf(Func<IntervalsAnyOfDescriptor, IIntervalsAnyOf> selector) =>
Assign(selector, (a, v) => a.AnyOf = v?.Invoke(new IntervalsAnyOfDescriptor()));
Expand All @@ -118,8 +162,9 @@ public IntervalsDescriptor AllOf(Func<IntervalsAllOfDescriptor, IIntervalsAllOf>
Assign(selector, (a, v) => a.AllOf = v?.Invoke(new IntervalsAllOfDescriptor()));
}

// TODO: Rename this to IIntervalsWithFilter and IIntervalsNoFilter to IIntervals in 8.0
/// <summary>
/// An <see cref="IIntervalsQuery" /> rule
/// An <see cref="IIntervalsQuery" /> rule with an optional filter
/// </summary>
public interface IIntervals
{
Expand All @@ -130,6 +175,13 @@ public interface IIntervals
IIntervalsFilter Filter { get; set; }
}

/// <summary>
/// An <see cref="IIntervalsQuery" /> rule
/// </summary>
public interface IIntervalsNoFilter
{
}

/// <summary>
/// Base type for an <see cref="IIntervals" /> implementation
/// </summary>
Expand All @@ -141,6 +193,14 @@ public abstract class IntervalsBase : IIntervals
internal abstract void WrapInContainer(IIntervalsContainer container);
}

/// <summary>
/// Base type for an <see cref="IIntervalsNoFilter" /> implementation
/// </summary>
public abstract class IntervalsNoFilterBase : IIntervalsNoFilter
{
internal abstract void WrapInContainer(IIntervalsContainer container);
}

/// <summary>
/// Base type for descriptors that define <see cref="IIntervals" />
/// </summary>
Expand All @@ -166,6 +226,14 @@ public IntervalsListDescriptor() : base(new List<IntervalsContainer>()) { }
public IntervalsListDescriptor Match(Func<IntervalsMatchDescriptor, IIntervalsMatch> selector) =>
Assign(selector, (a, v) => a.AddIfNotNull(new IntervalsDescriptor().Match(v)));

/// <inheritdoc cref="IIntervalsPrefix" />
public IntervalsListDescriptor Prefix(Func<IntervalsPrefixDescriptor, IIntervalsPrefix> selector) =>
Assign(selector, (a, v) => a.AddIfNotNull(new IntervalsDescriptor().Prefix(v)));

/// <inheritdoc cref="IIntervalsWildcard" />
public IntervalsListDescriptor Wildcard(Func<IntervalsWildcardDescriptor, IIntervalsWildcard> selector) =>
Assign(selector, (a, v) => a.AddIfNotNull(new IntervalsDescriptor().Wildcard(v)));

/// <inheritdoc cref="IIntervalsAnyOf" />
public IntervalsListDescriptor AnyOf(Func<IntervalsAnyOfDescriptor, IIntervalsAnyOf> selector) =>
Assign(selector, (a, v) => a.AddIfNotNull(new IntervalsDescriptor().AnyOf(v)));
Expand Down
73 changes: 73 additions & 0 deletions src/Nest/QueryDsl/FullText/Intervals/IntervalsWildcard.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
using System;
using System.Linq.Expressions;
using System.Runtime.Serialization;

namespace Nest
{
/// <summary>
/// Matches terms using a wildcard pattern. This pattern can expand to match at most 128 terms.
/// If the pattern matches more than 128 terms, Elasticsearch returns an error.
/// <para />
/// Available in Elasticsearch 7.3.0+
/// </summary>
[ReadAs(typeof(IntervalsWildcard))]
public interface IIntervalsWildcard : IIntervalsNoFilter
{
/// <summary>
/// Analyzer used to normalize the prefix. Defaults to the top-level field's analyzer.
/// </summary>
[DataMember(Name = "analyzer")]
string Analyzer { get; set; }

/// <summary>
/// Wildcard pattern used to find matching terms. Supports two wildcard operators:
/// <para />?, which matches any single character
/// <para />*, which can match zero or more characters, including an empty one
/// <para />Warning: Avoid beginning patterns with * or ?. This can increase the iterations needed to find matching terms and slow search performance.
/// </summary>
[DataMember(Name = "pattern")]
string Pattern { get; set; }

/// <summary>
/// If specified, then match intervals from this field rather than the top-level field.
/// The prefix is normalized using the search analyzer from this field, unless a separate analyzer is specified.
/// </summary>
[DataMember(Name = "use_field")]
Field UseField { get; set; }
}

/// <inheritdoc cref="IIntervalsWildcard" />
public class IntervalsWildcard : IntervalsNoFilterBase, IIntervalsWildcard
{
/// <inheritdoc />
public string Analyzer { get; set; }

/// <inheritdoc />
public string Pattern { get; set; }

/// <inheritdoc />
public Field UseField { get; set; }

internal override void WrapInContainer(IIntervalsContainer container) => container.Wildcard = this;
}

/// <inheritdoc cref="IIntervalsWildcard" />
public class IntervalsWildcardDescriptor : DescriptorBase<IntervalsWildcardDescriptor, IIntervalsWildcard>, IIntervalsWildcard
{
string IIntervalsWildcard.Analyzer { get; set; }
string IIntervalsWildcard.Pattern { get; set; }
Field IIntervalsWildcard.UseField { get; set; }

/// <inheritdoc cref="IIntervalsWildcard.Analyzer" />
public IntervalsWildcardDescriptor Analyzer(string analyzer) => Assign(analyzer, (a, v) => a.Analyzer = v);

/// <inheritdoc cref="IIntervalsWildcard.Pattern" />
public IntervalsWildcardDescriptor Pattern(string pattern) => Assign(pattern, (a, v) => a.Pattern = v);

/// <inheritdoc cref="IIntervalsWildcard.UseField" />
public IntervalsWildcardDescriptor UseField<T>(Expression<Func<T, object>> objectPath) => Assign(objectPath, (a, v) => a.UseField = v);

/// <inheritdoc cref="IIntervalsWildcard.UseField" />
public IntervalsWildcardDescriptor UseField(Field useField) => Assign(useField, (a, v) => a.UseField = v);
}
}
Loading