Package org.opensearch.search.aggregations.bucket.adjacency

Class InternalAdjacencyMatrix

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.InternalMultiBucketAggregation<InternalAdjacencyMatrix,InternalAdjacencyMatrix.InternalBucket>

org.opensearch.search.aggregations.bucket.adjacency.InternalAdjacencyMatrix

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Aggregation, AdjacencyMatrix, MultiBucketsAggregation

public class InternalAdjacencyMatrix
extends InternalMultiBucketAggregation<InternalAdjacencyMatrix,InternalAdjacencyMatrix.InternalBucket>
implements AdjacencyMatrix

Internal class used to represent an adjacency matrix as a collection of buckets

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalAdjacencyMatrix.InternalBucket	An internal bucket of the adjacency matrix

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalAggregation

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.bucket.adjacency.AdjacencyMatrix

AdjacencyMatrix.Bucket

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.bucket.MultiBucketsAggregation

MultiBucketsAggregation.Bucket

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.search.aggregations.InternalAggregation

metadata, name

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalAdjacencyMatrix(String name, List<InternalAdjacencyMatrix.InternalBucket> buckets, Map<String,Object> metadata)
InternalAdjacencyMatrix(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
InternalAdjacencyMatrix	create(List<InternalAdjacencyMatrix.InternalBucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
InternalAdjacencyMatrix.InternalBucket	createBucket(InternalAggregations aggregations, InternalAdjacencyMatrix.InternalBucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
InternalAdjacencyMatrix.InternalBucket	getBucketByKey(String key)
List<InternalAdjacencyMatrix.InternalBucket>	getBuckets()	The buckets created by this aggregation.
String	getWriteableName()
int	hashCode()
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
protected InternalAdjacencyMatrix.InternalBucket	reduceBucket(List<InternalAdjacencyMatrix.InternalBucket> buckets, InternalAggregation.ReduceContext context)	Reduce a list of same-keyed buckets (from multiple shards) to a single bucket.

Methods inherited from class org.opensearch.search.aggregations.InternalMultiBucketAggregation

copyWithRewritenBuckets, countInnerBucket, countInnerBucket, forEachBucket, getProperty, mustReduceOnSingleInternalAgg, reducePipelines

Methods inherited from class org.opensearch.search.aggregations.InternalAggregation

getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, sortValue, sortValue, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.search.aggregations.Aggregation

getMetadata, getName, getType

Methods inherited from interface org.opensearch.core.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

InternalAdjacencyMatrix

public InternalAdjacencyMatrix(String name,
 List<InternalAdjacencyMatrix.InternalBucket> buckets,
 Map<String,Object> metadata)

InternalAdjacencyMatrix

public InternalAdjacencyMatrix(org.opensearch.core.common.io.stream.StreamInput in)
                        throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

create

public InternalAdjacencyMatrix create(List<InternalAdjacencyMatrix.InternalBucket> buckets)

Description copied from class: InternalMultiBucketAggregation

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.

Specified by:

create in class InternalMultiBucketAggregation<InternalAdjacencyMatrix,InternalAdjacencyMatrix.InternalBucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public InternalAdjacencyMatrix.InternalBucket createBucket(InternalAggregations aggregations,
 InternalAdjacencyMatrix.InternalBucket prototype)

Description copied from class: InternalMultiBucketAggregation

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Specified by:

createBucket in class InternalMultiBucketAggregation<InternalAdjacencyMatrix,InternalAdjacencyMatrix.InternalBucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

getBuckets

public List<InternalAdjacencyMatrix.InternalBucket> getBuckets()

Description copied from interface: AdjacencyMatrix

The buckets created by this aggregation.

Specified by:

getBuckets in interface AdjacencyMatrix

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in class InternalMultiBucketAggregation<InternalAdjacencyMatrix,InternalAdjacencyMatrix.InternalBucket>

Returns:

The buckets of this aggregation.

getBucketByKey

public InternalAdjacencyMatrix.InternalBucket getBucketByKey(String key)

Specified by:

getBucketByKey in interface AdjacencyMatrix

reduce

public InternalAggregation reduce(List<InternalAggregation> aggregations,
 InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

reduceBucket

protected InternalAdjacencyMatrix.InternalBucket reduceBucket(List<InternalAdjacencyMatrix.InternalBucket> buckets,
 InternalAggregation.ReduceContext context)

Description copied from class: InternalMultiBucketAggregation

Reduce a list of same-keyed buckets (from multiple shards) to a single bucket. This requires all buckets to have the same key.

Specified by:

reduceBucket in class InternalMultiBucketAggregation<InternalAdjacencyMatrix,InternalAdjacencyMatrix.InternalBucket>

doXContentBody

public org.opensearch.core.xcontent.XContentBuilder doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                            throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalAggregation