org.elasticsearch.search.aggregations.bucket.terms.support

Class IncludeExclude

java.lang.Object

org.elasticsearch.search.aggregations.bucket.terms.support.IncludeExclude

public class IncludeExclude
extends Object

Defines the include/exclude regular expression filtering for string terms aggregation. In this filtering logic, exclusion has precedence, where the include is evaluated first and then the exclude.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IncludeExclude.LongFilter
static class	IncludeExclude.OrdinalsFilter
static class	IncludeExclude.Parser
static class	IncludeExclude.StringFilter

Constructor Summary

Constructors

Constructor and Description
IncludeExclude(org.apache.lucene.util.automaton.RegExp include, org.apache.lucene.util.automaton.RegExp exclude)
IncludeExclude(SortedSet<org.apache.lucene.util.BytesRef> includeValues, SortedSet<org.apache.lucene.util.BytesRef> excludeValues)

Method Summary

Methods

Modifier and Type	Method and Description
IncludeExclude.LongFilter	convertToDoubleFilter()
IncludeExclude.LongFilter	convertToLongFilter()
IncludeExclude.OrdinalsFilter	convertToOrdinalsFilter()
IncludeExclude.StringFilter	convertToStringFilter()
boolean	isRegexBased()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IncludeExclude

public IncludeExclude(org.apache.lucene.util.automaton.RegExp include,
              org.apache.lucene.util.automaton.RegExp exclude)

Parameters:

include - The regular expression pattern for the terms to be included

exclude - The regular expression pattern for the terms to be excluded

IncludeExclude

public IncludeExclude(SortedSet<org.apache.lucene.util.BytesRef> includeValues,
              SortedSet<org.apache.lucene.util.BytesRef> excludeValues)

Parameters:

includeValues - The terms to be included

excludeValues - The terms to be excluded

Method Detail

isRegexBased

public boolean isRegexBased()

convertToStringFilter

public IncludeExclude.StringFilter convertToStringFilter()

convertToOrdinalsFilter

public IncludeExclude.OrdinalsFilter convertToOrdinalsFilter()

convertToLongFilter

public IncludeExclude.LongFilter convertToLongFilter()

convertToDoubleFilter

public IncludeExclude.LongFilter convertToDoubleFilter()