org.elasticsearch.action.explain

Class ExplainResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.explain.ExplainResponse

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class ExplainResponse
extends ActionResponse

Response containing the score explanation.

Nested Class Summary

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

TransportResponse.Empty

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
ExplainResponse(String index, String type, String id, boolean exists)
ExplainResponse(String index, String type, String id, boolean exists, org.apache.lucene.search.Explanation explanation)
ExplainResponse(String index, String type, String id, boolean exists, org.apache.lucene.search.Explanation explanation, GetResult getResult)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.search.Explanation	getExplanation()
GetResult	getGetResult()
String	getId()
String	getIndex()
String	getType()
boolean	hasExplanation()
boolean	isExists()
boolean	isMatch()
void	readFrom(StreamInput in)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ExplainResponse

public ExplainResponse(String index,
               String type,
               String id,
               boolean exists)

ExplainResponse

public ExplainResponse(String index,
               String type,
               String id,
               boolean exists,
               org.apache.lucene.search.Explanation explanation)

ExplainResponse

public ExplainResponse(String index,
               String type,
               String id,
               boolean exists,
               org.apache.lucene.search.Explanation explanation,
               GetResult getResult)

Method Detail

getIndex

public String getIndex()

getType

public String getType()

getId

public String getId()

getExplanation

public org.apache.lucene.search.Explanation getExplanation()

isMatch

public boolean isMatch()

hasExplanation

public boolean hasExplanation()

isExists

public boolean isExists()

getGetResult

public GetResult getGetResult()

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

IOException