org.elasticsearch.search.aggregations.bucket.adjacency

Class AdjacencyMatrixAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.adjacency.AdjacencyMatrixAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder, MultiBucketAggregationBuilder

public class AdjacencyMatrixAggregationBuilder
extends AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>
implements MultiBucketAggregationBuilder

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

metaData

Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

factoriesBuilder, name

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
	AdjacencyMatrixAggregationBuilder(StreamInput in) Read from a stream.
protected	AdjacencyMatrixAggregationBuilder(java.lang.String name)
	AdjacencyMatrixAggregationBuilder(java.lang.String name, java.util.Map<java.lang.String,QueryBuilder> filters)
	AdjacencyMatrixAggregationBuilder(java.lang.String name, java.lang.String separator, java.util.Map<java.lang.String,QueryBuilder> filters)

Method Summary

Modifier and Type	Method and Description
protected void	checkConsistency()
protected AggregatorFactory<?>	doBuild(SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	doEquals(java.lang.Object obj)
protected int	doHashCode()
protected void	doWriteTo(StreamOutput out)
java.util.Map<java.lang.String,QueryBuilder>	filters() Get the filters.
java.lang.String	getType() The name of the type of aggregation built by this builder.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
static AggregationBuilder	parse(java.lang.String aggregationName, XContentParser parser)
java.lang.String	separator() Get the separator used to join pairs of bucket keys
AdjacencyMatrixAggregationBuilder	separator(java.lang.String separator) Set the separator used to join pairs of bucket keys
protected void	setFiltersAsList(java.util.List<AdjacencyMatrixAggregator.KeyedFilter> filters)
protected void	setFiltersAsMap(java.util.Map<java.lang.String,QueryBuilder> filters)

Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

AdjacencyMatrixAggregationBuilder

protected AdjacencyMatrixAggregationBuilder(java.lang.String name)

Parameters:

name - the name of this aggregation

AdjacencyMatrixAggregationBuilder

public AdjacencyMatrixAggregationBuilder(java.lang.String name,
                                         java.util.Map<java.lang.String,QueryBuilder> filters)

Parameters:

name - the name of this aggregation

filters - the filters and their keys to use with this aggregation.

AdjacencyMatrixAggregationBuilder

public AdjacencyMatrixAggregationBuilder(java.lang.String name,
                                         java.lang.String separator,
                                         java.util.Map<java.lang.String,QueryBuilder> filters)

Parameters:

name - the name of this aggregation

separator - the string used to separate keys in intersections buckets e.g. & character for keyed filters A and B would return an intersection bucket named A&B

filters - the filters and their key to use with this aggregation.

AdjacencyMatrixAggregationBuilder

public AdjacencyMatrixAggregationBuilder(StreamInput in)
                                  throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

parse

public static AggregationBuilder parse(java.lang.String aggregationName,
                                       XContentParser parser)
                                throws java.io.IOException

Throws:

java.io.IOException

checkConsistency

protected void checkConsistency()

setFiltersAsMap

protected void setFiltersAsMap(java.util.Map<java.lang.String,QueryBuilder> filters)

setFiltersAsList

protected void setFiltersAsList(java.util.List<AdjacencyMatrixAggregator.KeyedFilter> filters)

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

Throws:

java.io.IOException

separator

public AdjacencyMatrixAggregationBuilder separator(java.lang.String separator)

Set the separator used to join pairs of bucket keys

separator

public java.lang.String separator()

Get the separator used to join pairs of bucket keys

filters

public java.util.Map<java.lang.String,QueryBuilder> filters()

Get the filters. This will be an unmodifiable map

doBuild

protected AggregatorFactory<?> doBuild(SearchContext context,
                                       AggregatorFactory<?> parent,
                                       AggregatorFactories.Builder subFactoriesBuilder)
                                throws java.io.IOException

Specified by:

doBuild in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

Throws:

java.io.IOException

internalXContent

protected XContentBuilder internalXContent(XContentBuilder builder,
                                           ToXContent.Params params)
                                    throws java.io.IOException

Specified by:

internalXContent in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

doEquals

protected boolean doEquals(java.lang.Object obj)

Specified by:

doEquals in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.

Specified by:

getType in interface BaseAggregationBuilder