Class IncludeExclude
java.lang.Object
org.elasticsearch.search.aggregations.bucket.terms.IncludeExclude
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
public class IncludeExclude extends java.lang.Object implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment
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 Description static class
IncludeExclude.Filter
static class
IncludeExclude.LongFilter
static class
IncludeExclude.OrdinalsFilter
class
IncludeExclude.PartitionedLongFilter
static class
IncludeExclude.SetBackedLongFilter
static class
IncludeExclude.StringFilter
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static org.elasticsearch.common.ParseField
EXCLUDE_FIELD
static org.elasticsearch.common.ParseField
INCLUDE_FIELD
static org.elasticsearch.common.ParseField
NUM_PARTITIONS_FIELD
static org.elasticsearch.common.ParseField
PARTITION_FIELD
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description IncludeExclude(double[] includeValues, double[] excludeValues)
IncludeExclude(int partition, int numPartitions)
IncludeExclude(long[] includeValues, long[] excludeValues)
IncludeExclude(java.lang.String[] includeValues, java.lang.String[] excludeValues)
IncludeExclude(java.lang.String include, java.lang.String exclude)
IncludeExclude(java.lang.String include, java.lang.String exclude, java.lang.String[] includeValues, java.lang.String[] excludeValues)
IncludeExclude(java.util.SortedSet<org.apache.lucene.util.BytesRef> includeValues, java.util.SortedSet<org.apache.lucene.util.BytesRef> excludeValues)
IncludeExclude(org.apache.lucene.util.automaton.RegExp include, org.apache.lucene.util.automaton.RegExp exclude)
IncludeExclude(org.apache.lucene.util.automaton.RegExp include, org.apache.lucene.util.automaton.RegExp exclude, java.util.SortedSet<org.apache.lucene.util.BytesRef> includeValues, java.util.SortedSet<org.apache.lucene.util.BytesRef> excludeValues)
IncludeExclude(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description IncludeExclude.LongFilter
convertToDoubleFilter()
IncludeExclude.LongFilter
convertToLongFilter(DocValueFormat format)
IncludeExclude.OrdinalsFilter
convertToOrdinalsFilter(DocValueFormat format)
IncludeExclude.StringFilter
convertToStringFilter(DocValueFormat format)
boolean
equals(java.lang.Object obj)
int
hashCode()
boolean
isPartitionBased()
boolean
isRegexBased()
static IncludeExclude
merge(IncludeExclude include, IncludeExclude exclude)
static IncludeExclude
parseExclude(org.elasticsearch.common.xcontent.XContentParser parser)
static IncludeExclude
parseInclude(org.elasticsearch.common.xcontent.XContentParser parser)
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
Field Details
-
INCLUDE_FIELD
public static final org.elasticsearch.common.ParseField INCLUDE_FIELD -
EXCLUDE_FIELD
public static final org.elasticsearch.common.ParseField EXCLUDE_FIELD -
PARTITION_FIELD
public static final org.elasticsearch.common.ParseField PARTITION_FIELD -
NUM_PARTITIONS_FIELD
public static final org.elasticsearch.common.ParseField NUM_PARTITIONS_FIELD
-
-
Constructor Details
-
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 includedexclude
- The regular expression pattern for the terms to be excluded
-
IncludeExclude
public IncludeExclude(org.apache.lucene.util.automaton.RegExp include, org.apache.lucene.util.automaton.RegExp exclude, java.util.SortedSet<org.apache.lucene.util.BytesRef> includeValues, java.util.SortedSet<org.apache.lucene.util.BytesRef> excludeValues) -
IncludeExclude
public IncludeExclude(java.lang.String include, java.lang.String exclude, java.lang.String[] includeValues, java.lang.String[] excludeValues) -
IncludeExclude
public IncludeExclude(java.lang.String include, java.lang.String exclude) -
IncludeExclude
public IncludeExclude(java.util.SortedSet<org.apache.lucene.util.BytesRef> includeValues, java.util.SortedSet<org.apache.lucene.util.BytesRef> excludeValues)- Parameters:
includeValues
- The terms to be includedexcludeValues
- The terms to be excluded
-
IncludeExclude
public IncludeExclude(java.lang.String[] includeValues, java.lang.String[] excludeValues) -
IncludeExclude
public IncludeExclude(double[] includeValues, double[] excludeValues) -
IncludeExclude
public IncludeExclude(long[] includeValues, long[] excludeValues) -
IncludeExclude
public IncludeExclude(int partition, int numPartitions) -
IncludeExclude
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
merge
-
parseInclude
public static IncludeExclude parseInclude(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
parseExclude
public static IncludeExclude parseExclude(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
isRegexBased
public boolean isRegexBased() -
isPartitionBased
public boolean isPartitionBased() -
convertToStringFilter
-
convertToOrdinalsFilter
-
convertToLongFilter
-
convertToDoubleFilter
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-