Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class NestedQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<NestedQueryBuilder>

org.elasticsearch.index.query.NestedQueryBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, QueryBuilder, Rewriteable<QueryBuilder>, ToXContent, ToXContentObject

public class NestedQueryBuilder
extends AbstractQueryBuilder<NestedQueryBuilder>

Nested Class Summary

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

Modifier and Type	Field	Description
static final boolean	DEFAULT_IGNORE_UNMAPPED	The default value for ignore_unmapped.
static final String	NAME

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
NestedQueryBuilder(String path, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode)
NestedQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(NestedQueryBuilder that)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
void	extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)	For internal usage only! Extracts the inner hits from the query tree.
static NestedQueryBuilder	fromXContent(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
final String	getWriteableName()	Returns the name of the writeable object
boolean	ignoreUnmapped()	Gets whether the query builder will ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the path is unmapped.
NestedQueryBuilder	ignoreUnmapped(boolean ignoreUnmapped)	Sets whether the query builder should ignore unmapped paths (and run a MatchNoDocsQuery in place of this query) or throw an exception if the path is unmapped.
InnerHitBuilder	innerHit()	Returns inner hit definition in the scope of this query and reusing the defined type and query.
NestedQueryBuilder	innerHit(InnerHitBuilder innerHitBuilder)
static org.apache.lucene.search.join.ScoreMode	parseScoreMode(String scoreModeString)
QueryBuilder	query()	Returns the nested query to execute.
org.apache.lucene.search.join.ScoreMode	scoreMode()	Returns how the scores from the matching child documents are mapped into the nested parent document.
static String	scoreModeAsString(org.apache.lucene.search.join.ScoreMode scoreMode)

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doSearchRewrite, equals, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_IGNORE_UNMAPPED

public static final boolean DEFAULT_IGNORE_UNMAPPED

The default value for ignore_unmapped.

See Also:

• Constant Field Values

Constructor Details

NestedQueryBuilder

public NestedQueryBuilder(String path,
 QueryBuilder query,
 org.apache.lucene.search.join.ScoreMode scoreMode)

NestedQueryBuilder

public NestedQueryBuilder(StreamInput in)
                   throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<NestedQueryBuilder>

Throws:

IOException

query

public QueryBuilder query()

Returns the nested query to execute.

innerHit

public InnerHitBuilder innerHit()

Returns inner hit definition in the scope of this query and reusing the defined type and query.

innerHit

public NestedQueryBuilder innerHit(InnerHitBuilder innerHitBuilder)

scoreMode

public org.apache.lucene.search.join.ScoreMode scoreMode()

Returns how the scores from the matching child documents are mapped into the nested parent document.

ignoreUnmapped

public NestedQueryBuilder ignoreUnmapped(boolean ignoreUnmapped)

Sets whether the query builder should ignore unmapped paths (and run a MatchNoDocsQuery in place of this query) or throw an exception if the path is unmapped.

ignoreUnmapped

public boolean ignoreUnmapped()

Gets whether the query builder will ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the path is unmapped.

doXContent

protected void doXContent(XContentBuilder builder,
 ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<NestedQueryBuilder>

Throws:

IOException

fromXContent

public static NestedQueryBuilder fromXContent(XContentParser parser)
                                       throws IOException

Throws:

IOException

parseScoreMode

public static org.apache.lucene.search.join.ScoreMode parseScoreMode(String scoreModeString)

scoreModeAsString

public static String scoreModeAsString(org.apache.lucene.search.join.ScoreMode scoreMode)

getWriteableName

public final String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

doEquals

protected boolean doEquals(NestedQueryBuilder that)

Description copied from class: AbstractQueryBuilder

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

Specified by:

doEquals in class AbstractQueryBuilder<NestedQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<NestedQueryBuilder>

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<NestedQueryBuilder>

Throws:

IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<NestedQueryBuilder>

Throws:

IOException

extractInnerHitBuilders

public void extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)

Description copied from class: AbstractQueryBuilder

For internal usage only! Extracts the inner hits from the query tree. While it extracts inner hits, child inner hits are inlined into the inner hit builder they belong to.

Overrides:

extractInnerHitBuilders in class AbstractQueryBuilder<NestedQueryBuilder>

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to