Package org.elasticsearch.search

Class SearchHit.NestedIdentity

java.lang.Object
org.elasticsearch.search.SearchHit.NestedIdentity
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
Enclosing class:
SearchHit
public static final class SearchHit.NestedIdentity extends Object implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment
Encapsulates the nested identity of a hit.

  • Nested Class Summary

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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
    NestedIdentity(String field, int offset, SearchHit.NestedIdentity child)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static SearchHit.NestedIdentity
    fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
     
    SearchHit.NestedIdentity
    getChild()
    Returns the next child nested level if there is any, otherwise null is returned.
    Text
    getField()
    Returns the nested field in the source this hit originates from
    int
    getOffset()
    Returns the offset in the nested array of objects in the source this hit
    int
    hashCode()
     
    String
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    void
    writeTo(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

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

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

    isFragment

  • Constructor Details

  • Method Details

    • getField

      public Text 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

      public SearchHit.NestedIdentity getChild()
      Returns the next child nested level if there is any, otherwise null is returned. In the case of mappings with multiple levels of nested object fields

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • fromXContent

      public static SearchHit.NestedIdentity fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object