Package 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, Rewriteable<AggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

public class AdjacencyMatrixAggregationBuilder
extends AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

Nested Class Summary

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 final String	NAME

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

metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AdjacencyMatrixAggregationBuilder(String name)
	AdjacencyMatrixAggregationBuilder(String name, String separator, Map<String,QueryBuilder> filters)
	AdjacencyMatrixAggregationBuilder(String name, Map<String,QueryBuilder> filters)
	AdjacencyMatrixAggregationBuilder(StreamInput in)	Read from a stream.
protected	AdjacencyMatrixAggregationBuilder(AdjacencyMatrixAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected AggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected AdjacencyMatrixAggregationBuilder	doRewrite(QueryRewriteContext queryRewriteContext)	Rewrites this aggregation builder into its primitive form.
protected void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
Map<String,QueryBuilder>	filters()	Get the filters.
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
static AggregationBuilder	parse(XContentParser parser, String name)
String	separator()	Get the separator used to join pairs of bucket keys
AdjacencyMatrixAggregationBuilder	separator(String separator)	Set the separator used to join pairs of bucket keys
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

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

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

buildPipelineTree, bytesToPreallocate, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, isInSortOrderExecutionRequired, rewrite, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

AdjacencyMatrixAggregationBuilder

protected AdjacencyMatrixAggregationBuilder(String name)

Parameters:

name - the name of this aggregation

AdjacencyMatrixAggregationBuilder

public AdjacencyMatrixAggregationBuilder(String name,
 Map<String,QueryBuilder> filters)

Parameters:

name - the name of this aggregation

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

AdjacencyMatrixAggregationBuilder

protected AdjacencyMatrixAggregationBuilder(AdjacencyMatrixAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

AdjacencyMatrixAggregationBuilder

public AdjacencyMatrixAggregationBuilder(String name,
 String separator,
 Map<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 IOException

Read from a stream.

Throws:

IOException

Method Details

parse

public static AggregationBuilder parse(XContentParser parser,
 String name)
                                throws IOException

Throws:

IOException

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

Throws:

IOException

separator

public AdjacencyMatrixAggregationBuilder separator(String separator)

Set the separator used to join pairs of bucket keys

separator

public String separator()

Get the separator used to join pairs of bucket keys

filters

public Map<String,QueryBuilder> filters()

Get the filters. This will be an unmodifiable map

doRewrite

protected AdjacencyMatrixAggregationBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                                               throws IOException

Description copied from class: AggregationBuilder

Rewrites this aggregation builder into its primitive form. By default this method return the builder itself. If the builder did not change the identity reference must be returned otherwise the builder will be rewritten infinitely.

Overrides:

doRewrite in class AggregationBuilder

Throws:

IOException

doBuild

protected AggregatorFactory doBuild(AggregationContext context,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                             throws IOException

Specified by:

doBuild in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

Throws:

IOException

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

internalXContent

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

Specified by:

internalXContent in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAggregationBuilder<AdjacencyMatrixAggregationBuilder>

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

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