Module org.elasticsearch.server

Package org.elasticsearch.search.query

Class ScrollQuerySearchResult

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.search.SearchPhaseResult

org.elasticsearch.search.query.ScrollQuerySearchResult

All Implemented Interfaces:

Writeable, RefCounted

public final class ScrollQuerySearchResult
extends SearchPhaseResult

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

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

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

Field Summary

Fields inherited from class org.elasticsearch.search.SearchPhaseResult

contextId

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
ScrollQuerySearchResult(StreamInput in)
ScrollQuerySearchResult(QuerySearchResult result, SearchShardTarget shardTarget)

Method Summary

Modifier and Type	Method	Description
boolean	decRef()	Note that the lifetime of an outbound TransportMessage lasts at least until it has been fully sent over the network, and it may be closed on a network thread in a context in which there's a risk of stack overflows if on close it calls back into the network layer in a manner that might end up nesting too deeply.
boolean	hasReferences()
void	incRef()
QuerySearchResult	queryResult()	Returns the query result iff it's included in this response otherwise null
void	setSearchShardTarget(SearchShardTarget shardTarget)
void	setShardIndex(int shardIndex)
boolean	tryIncRef()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.search.SearchPhaseResult

fetchResult, getContextId, getRescoreDocIds, getSearchShardTarget, getShardIndex, getShardSearchRequest, hasSearchContext, rankFeatureResult, setRescoreDocIds, setShardSearchRequest

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Constructor Details

ScrollQuerySearchResult

public ScrollQuerySearchResult(StreamInput in)
                        throws IOException

Throws:

IOException

ScrollQuerySearchResult

public ScrollQuerySearchResult(QuerySearchResult result,
 SearchShardTarget shardTarget)

Method Details

setSearchShardTarget

public void setSearchShardTarget(SearchShardTarget shardTarget)

Overrides:

setSearchShardTarget in class SearchPhaseResult

setShardIndex

public void setShardIndex(int shardIndex)

Overrides:

setShardIndex in class SearchPhaseResult

queryResult

public QuerySearchResult queryResult()

Description copied from class: SearchPhaseResult

Returns the query result iff it's included in this response otherwise null

Overrides:

queryResult in class SearchPhaseResult

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class SearchPhaseResult

Throws:

IOException

incRef

public void incRef()

Specified by:

incRef in interface RefCounted

Overrides:

incRef in class TransportMessage

tryIncRef

public boolean tryIncRef()

Specified by:

tryIncRef in interface RefCounted

Overrides:

tryIncRef in class TransportMessage

decRef

public boolean decRef()

Description copied from class: TransportMessage

Note that the lifetime of an outbound TransportMessage lasts at least until it has been fully sent over the network, and it may be closed on a network thread in a context in which there's a risk of stack overflows if on close it calls back into the network layer in a manner that might end up nesting too deeply. When in doubt, dispatch any further work onto a separate thread.

Specified by:

decRef in interface RefCounted

Overrides:

decRef in class TransportMessage

hasReferences

public boolean hasReferences()

Specified by:

hasReferences in interface RefCounted

Overrides:

hasReferences in class TransportMessage