Field Detail

• text

  protected Text text

• offset

  protected int offset

• length

  protected int length

• options

  protected List<O extends Suggest.Suggestion.Entry.Option> options

Constructor Detail

• Entry

  public Entry(Text text,
               int offset,
               int length)

• Entry

  public Entry()

Method Detail

• addOption

  public void addOption(O option)

• sort

  protected void sort(Comparator<O> comparator)

• reduce

  protected <T extends Suggest.Suggestion.Entry<O>> Suggest.Suggestion.Entry<O> reduce(List<T> toReduce)

• merge

  protected void merge(Suggest.Suggestion.Entry<O> other)

  Merge any extra fields for this subtype.

• getText

  public Text getText()

  Returns:

  the text (analyzed by suggest analyzer) originating from the suggest text. Usually this is a single term.

• getOffset

  public int getOffset()

  Returns:

  the start offset (not analyzed) for this entry in the suggest text.

• getLength

  public int getLength()

  Returns:

  the length (not analyzed) for this entry in the suggest text.

• iterator

  public Iterator<O> iterator()

• getOptions

  public List<O> getOptions()

  Returns:

  The suggested options for this particular suggest entry. If there are no suggested terms then an empty list is returned.

• equals

  public boolean equals(Object o)

• hashCode

  public int hashCode()

• readFrom

  public void readFrom(StreamInput in)
                throws IOException

  Specified by:

  readFrom in interface  Streamable

  Throws:

  IOException

• newOption

  protected O newOption()

• writeTo

  public void writeTo(StreamOutput out)
               throws IOException

  Specified by:

  writeTo in interface  Streamable

  Throws:

  IOException

• toXContent

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

  Specified by:

  toXContent in interface  ToXContent

  Throws:

  IOException