Package org.elasticsearch.action.search

Class SearchShardIterator

java.lang.Object

org.elasticsearch.cluster.routing.PlainShardsIterator

org.elasticsearch.cluster.routing.PlainShardIterator

org.elasticsearch.action.search.SearchShardIterator

All Implemented Interfaces:

Comparable<ShardIterator>, Iterable<ShardRouting>, ShardIterator, ShardsIterator

public final class SearchShardIterator
extends PlainShardIterator

Extension of PlainShardIterator used in the search api, which also holds the OriginalIndices of the search request (useful especially with cross-cluster search, as each cluster has its own set of original indices) as well as the cluster alias.

See Also:

OriginalIndices

Constructor Summary

Constructors

Constructor	Description
SearchShardIterator(String clusterAlias, ShardId shardId, List<ShardRouting> shards, OriginalIndices originalIndices)	Creates a PlainShardIterator instance that iterates over a subset of the given shards this the a given shardId.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ShardIterator o)
boolean	equals(Object o)
String	getClusterAlias()	Returns the alias of the cluster where the shard is located.
OriginalIndices	getOriginalIndices()	Returns the original indices associated with this shard iterator, specifically with the cluster that this shard belongs to.
int	hashCode()

Methods inherited from class org.elasticsearch.cluster.routing.PlainShardIterator

shardId

Methods inherited from class org.elasticsearch.cluster.routing.PlainShardsIterator

getShardRoutings, iterator, nextOrNull, remaining, reset, size, sizeActive

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.elasticsearch.cluster.routing.ShardIterator

reset

Methods inherited from interface org.elasticsearch.cluster.routing.ShardsIterator

getShardRoutings, nextOrNull, remaining, size, sizeActive

Constructor Detail

SearchShardIterator

public SearchShardIterator(@Nullable
                           String clusterAlias,
                           ShardId shardId,
                           List<ShardRouting> shards,
                           OriginalIndices originalIndices)

Creates a PlainShardIterator instance that iterates over a subset of the given shards this the a given shardId.

Parameters:

clusterAlias - the alias of the cluster where the shard is located

shardId - shard id of the group

shards - shards to iterate

originalIndices - the indices that the search request originally related to (before any rewriting happened)

Method Detail

getOriginalIndices

public OriginalIndices getOriginalIndices()

Returns the original indices associated with this shard iterator, specifically with the cluster that this shard belongs to.

getClusterAlias

@Nullable
public String getClusterAlias()

Returns the alias of the cluster where the shard is located.

equals

public boolean equals(Object o)

Specified by:

equals in interface ShardsIterator

Overrides:

equals in class PlainShardIterator

hashCode

public int hashCode()

Specified by:

hashCode in interface ShardsIterator

Overrides:

hashCode in class PlainShardIterator

compareTo

public int compareTo(ShardIterator o)

Specified by:

compareTo in interface Comparable<ShardIterator>

Overrides:

compareTo in class PlainShardIterator