Package org.elasticsearch.action.explain

Class ExplainResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.explain.ExplainResponse

All Implemented Interfaces:

Streamable, Writeable, StatusToXContentObject, ToXContent, ToXContentObject

public class ExplainResponse
extends ActionResponse
implements StatusToXContentObject

Response containing the score explanation.

Nested Class Summary

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

TransportResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static ExplainResponse	fromXContent(XContentParser parser, boolean exists)
org.apache.lucene.search.Explanation	getExplanation()
GetResult	getGetResult()
java.lang.String	getId()
java.lang.String	getIndex()
java.lang.String	getType()	Deprecated. Types are in the process of being removed.
boolean	hasExplanation()
int	hashCode()
boolean	isExists()
boolean	isMatch()
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
RestStatus	status()	Returns the REST status to make sure it is returned correctly
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Detail

ExplainResponse

public ExplainResponse(java.lang.String index,
                       java.lang.String type,
                       java.lang.String id,
                       boolean exists)

ExplainResponse

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

ExplainResponse

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

ExplainResponse

public ExplainResponse(StreamInput in)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getIndex

public java.lang.String getIndex()

getType

@Deprecated
public java.lang.String getType()

Deprecated.

Types are in the process of being removed.

getId

public java.lang.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()

status

public RestStatus status()

Description copied from interface: StatusToXContentObject

Returns the REST status to make sure it is returned correctly

Specified by:

status in interface StatusToXContentObject

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionResponse

Throws:

java.io.IOException

fromXContent

public static ExplainResponse fromXContent(XContentParser parser,
                                           boolean exists)

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object