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.Parser

Constructor Summary

Constructors

Constructor and Description
IncludeExclude(Pattern include, Pattern exclude, Set<org.apache.lucene.util.BytesRef> includeValues, Set<org.apache.lucene.util.BytesRef> excludeValues)

Method Summary

Modifier and Type	Method and Description
boolean	accept(org.apache.lucene.util.BytesRef value) Returns whether the given value is accepted based on the include & exclude patterns.
org.apache.lucene.util.LongBitSet	acceptedGlobalOrdinals(org.apache.lucene.index.RandomAccessOrds globalOrdinals, ValuesSource.Bytes.WithOrdinals valueSource) Computes which global ordinals are accepted by this IncludeExclude instance.
IncludeExclude.LongFilter	convertToDoubleFilter()
IncludeExclude.LongFilter	convertToLongFilter()
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(Pattern include,
                      Pattern exclude,
                      Set<org.apache.lucene.util.BytesRef> includeValues,
                      Set<org.apache.lucene.util.BytesRef> excludeValues)

Parameters:

include - The regular expression pattern for the terms to be included (may only be null if one of the other arguments is none-null.

includeValues - The terms to be included (may only be null if one of the other arguments is none-null.

exclude - The regular expression pattern for the terms to be excluded (may only be null if one of the other arguments is none-null.

excludeValues - The terms to be excluded (may only be null if one of the other arguments is none-null.

Method Detail

accept

public boolean accept(org.apache.lucene.util.BytesRef value)

Returns whether the given value is accepted based on the include & exclude patterns.

acceptedGlobalOrdinals

public org.apache.lucene.util.LongBitSet acceptedGlobalOrdinals(org.apache.lucene.index.RandomAccessOrds globalOrdinals,
                                                                ValuesSource.Bytes.WithOrdinals valueSource)

Computes which global ordinals are accepted by this IncludeExclude instance.

isRegexBased

public boolean isRegexBased()

convertToLongFilter

public IncludeExclude.LongFilter convertToLongFilter()

convertToDoubleFilter

public IncludeExclude.LongFilter convertToDoubleFilter()