org.elasticsearch.index.query

Class InnerHitBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.InnerHitBuilder

All Implemented Interfaces:

Writeable, ToXContent

public final class InnerHitBuilder
extends ToXContentToBytes
implements Writeable

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static QueryBuilder	DEFAULT_INNER_HIT_QUERY
static ParseField	INNER_HITS_FIELD
static ParseField	NAME_FIELD

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InnerHitBuilder()
InnerHitBuilder(StreamInput in) Read from a stream.

Method Summary

Modifier and Type	Method and Description
InnerHitBuilder	addDocValueField(java.lang.String field) Adds a field to load from the docvalue and return.
InnerHitBuilder	addFieldDataField(java.lang.String field) Deprecated. Use addDocValueField(String) instead.
InnerHitBuilder	addScriptField(java.lang.String name, Script script)
InnerHitBuilder	addSort(SortBuilder<?> sort)
InnerHitsContext.BaseInnerHits	build(SearchContext parentSearchContext, InnerHitsContext innerHitsContext)
boolean	equals(java.lang.Object o)
static void	extractInnerHits(QueryBuilder query, java.util.Map<java.lang.String,InnerHitBuilder> innerHitBuilders)
static InnerHitBuilder	fromXContent(QueryParseContext context)
java.util.List<java.lang.String>	getDocValueFields() Gets the docvalue fields.
FetchSourceContext	getFetchSourceContext()
java.util.List<java.lang.String>	getFieldDataFields() Deprecated. Use getDocValueFields() instead.
java.util.List<java.lang.String>	getFieldNames() Deprecated. Use getStoredFieldsContext() instead.
int	getFrom()
HighlightBuilder	getHighlightBuilder()
java.lang.String	getName()
java.util.Set<SearchSourceBuilder.ScriptField>	getScriptFields()
int	getSize()
java.util.List<SortBuilder<?>>	getSorts()
StoredFieldsContext	getStoredFieldsContext() Gets the stored fields context.
int	hashCode()
void	inlineInnerHits(java.util.Map<java.lang.String,InnerHitBuilder> innerHits)
boolean	isExplain()
boolean	isTrackScores()
boolean	isVersion()
InnerHitBuilder	setDocValueFields(java.util.List<java.lang.String> docValueFields) Sets the stored fields to load from the docvalue and return.
InnerHitBuilder	setExplain(boolean explain)
InnerHitBuilder	setFetchSourceContext(FetchSourceContext fetchSourceContext)
InnerHitBuilder	setFieldDataFields(java.util.List<java.lang.String> fieldDataFields) Deprecated. Use setDocValueFields(List) instead.
InnerHitBuilder	setFieldNames(java.util.List<java.lang.String> fieldNames) Deprecated. Use setStoredFieldNames(List) instead.
InnerHitBuilder	setFrom(int from)
InnerHitBuilder	setHighlightBuilder(HighlightBuilder highlightBuilder)
InnerHitBuilder	setName(java.lang.String name)
InnerHitBuilder	setScriptFields(java.util.Set<SearchSourceBuilder.ScriptField> scriptFields)
InnerHitBuilder	setSize(int size)
InnerHitBuilder	setSorts(java.util.List<SortBuilder<?>> sorts)
InnerHitBuilder	setStoredFieldNames(java.util.List<java.lang.String> fieldNames) Sets the stored fields to load and return.
InnerHitBuilder	setTrackScores(boolean trackScores)
InnerHitBuilder	setVersion(boolean version)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Field Detail

NAME_FIELD

public static final ParseField NAME_FIELD

INNER_HITS_FIELD

public static final ParseField INNER_HITS_FIELD

DEFAULT_INNER_HIT_QUERY

public static final QueryBuilder DEFAULT_INNER_HIT_QUERY

Constructor Detail

InnerHitBuilder

public InnerHitBuilder()

InnerHitBuilder

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

Read from a stream.

Throws:

java.io.IOException

Method Detail

writeTo

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

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

getName

public java.lang.String getName()

setName

public InnerHitBuilder setName(java.lang.String name)

getFrom

public int getFrom()

setFrom

public InnerHitBuilder setFrom(int from)

getSize

public int getSize()

setSize

public InnerHitBuilder setSize(int size)

isExplain

public boolean isExplain()

setExplain

public InnerHitBuilder setExplain(boolean explain)

isVersion

public boolean isVersion()

setVersion

public InnerHitBuilder setVersion(boolean version)

isTrackScores

public boolean isTrackScores()

setTrackScores

public InnerHitBuilder setTrackScores(boolean trackScores)

getFieldNames

@Deprecated
public java.util.List<java.lang.String> getFieldNames()

Deprecated. Use getStoredFieldsContext() instead.

Gets the stored fields to load and return.

setFieldNames

@Deprecated
public InnerHitBuilder setFieldNames(java.util.List<java.lang.String> fieldNames)

Deprecated. Use setStoredFieldNames(List) instead.

Sets the stored fields to load and return. If none are specified, the source of the document will be returned.

getStoredFieldsContext

public StoredFieldsContext getStoredFieldsContext()

Gets the stored fields context.

setStoredFieldNames

public InnerHitBuilder setStoredFieldNames(java.util.List<java.lang.String> fieldNames)

Sets the stored fields to load and return. If none are specified, the source of the document will be returned.

getFieldDataFields

@Deprecated
public java.util.List<java.lang.String> getFieldDataFields()

Deprecated. Use getDocValueFields() instead.

Gets the docvalue fields.

setFieldDataFields

@Deprecated
public InnerHitBuilder setFieldDataFields(java.util.List<java.lang.String> fieldDataFields)

Deprecated. Use setDocValueFields(List) instead.

Sets the stored fields to load from the docvalue and return.

addFieldDataField

@Deprecated
public InnerHitBuilder addFieldDataField(java.lang.String field)

Deprecated. Use addDocValueField(String) instead.

Adds a field to load from the docvalue and return.

getDocValueFields

public java.util.List<java.lang.String> getDocValueFields()

Gets the docvalue fields.

setDocValueFields

public InnerHitBuilder setDocValueFields(java.util.List<java.lang.String> docValueFields)

Sets the stored fields to load from the docvalue and return.

addDocValueField

public InnerHitBuilder addDocValueField(java.lang.String field)

Adds a field to load from the docvalue and return.

getScriptFields

public java.util.Set<SearchSourceBuilder.ScriptField> getScriptFields()

setScriptFields

public InnerHitBuilder setScriptFields(java.util.Set<SearchSourceBuilder.ScriptField> scriptFields)

addScriptField

public InnerHitBuilder addScriptField(java.lang.String name,
                                      Script script)

getFetchSourceContext

public FetchSourceContext getFetchSourceContext()

setFetchSourceContext

public InnerHitBuilder setFetchSourceContext(FetchSourceContext fetchSourceContext)

getSorts

public java.util.List<SortBuilder<?>> getSorts()

setSorts

public InnerHitBuilder setSorts(java.util.List<SortBuilder<?>> sorts)

addSort

public InnerHitBuilder addSort(SortBuilder<?> sort)

getHighlightBuilder

public HighlightBuilder getHighlightBuilder()

setHighlightBuilder

public InnerHitBuilder setHighlightBuilder(HighlightBuilder highlightBuilder)

build

public InnerHitsContext.BaseInnerHits build(SearchContext parentSearchContext,
                                            InnerHitsContext innerHitsContext)
                                     throws java.io.IOException

Throws:

java.io.IOException

inlineInnerHits

public void inlineInnerHits(java.util.Map<java.lang.String,InnerHitBuilder> innerHits)

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 o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fromXContent

public static InnerHitBuilder fromXContent(QueryParseContext context)
                                    throws java.io.IOException

Throws:

java.io.IOException

extractInnerHits

public static void extractInnerHits(QueryBuilder query,
                                    java.util.Map<java.lang.String,InnerHitBuilder> innerHitBuilders)