java.lang.Object
org.elasticsearch.search.SearchHit.NestedIdentity
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentFragment
- Enclosing class:
SearchHit
public static final class SearchHit.NestedIdentity
extends Object
implements Writeable, ToXContentFragment
Encapsulates the nested identity of a hit.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested 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.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanextractSource(Source root) Extracts the part of the root source that applies to this particular NestedIdentity, while preserving the enclosing path structure.getChild()Returns the next child nested level if there is any, otherwisenullis returned.getField()Returns the nested field in the source this hit originates fromintReturns the offset in the nested array of objects in the source this hitinthashCode()toString()toXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
NestedIdentity
-
-
Method Details
-
getField
Returns the nested field in the source this hit originates from -
getOffset
public int getOffset()Returns the offset in the nested array of objects in the source this hit -
getChild
Returns the next child nested level if there is any, otherwisenullis returned. In the case of mappings with multiple levels of nested object fields -
extractSource
Extracts the part of the root source that applies to this particular NestedIdentity, while preserving the enclosing path structure. For a root document that looks like this: { "children" : [ { "grandchildren" : [ { "field" : "value1" }, { "field" : "value2" } ] }, { "grandchildren" : [ { "field" : "value3" }, { "field" : "value4" } ] } ] } Extracting the NestedIdentity of the first child and second grandchild results in a source that looks like this: { "children" : { "grandchildren" : { "field" : "value2" } } } If the relevant child source object does not exist in the root, then we returnSource.empty(XContentType) -
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
toString
-
equals
-
hashCode
public int hashCode()
-