org.elasticsearch.search.highlight

Class HighlightField

java.lang.Object

org.elasticsearch.search.highlight.HighlightField

All Implemented Interfaces:

Streamable

public class HighlightField
extends java.lang.Object
implements Streamable

A field highlighted with its highlighted fragments.

Constructor Summary

Constructors

Constructor and Description
HighlightField(java.lang.String name, Text[] fragments)

Method Summary

Modifier and Type	Method and Description
Text[]	fragments() The highlighted fragments.
Text[]	getFragments() The highlighted fragments.
java.lang.String	getName() The name of the field highlighted.
java.lang.String	name() The name of the field highlighted.
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
static HighlightField	readHighlightField(StreamInput in)
java.lang.String	toString()
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HighlightField

public HighlightField(java.lang.String name,
                      Text[] fragments)

Method Detail

name

public java.lang.String name()

The name of the field highlighted.

getName

public java.lang.String getName()

The name of the field highlighted.

fragments

public Text[] fragments()

The highlighted fragments. null if failed to highlight (for example, the field is not stored).

getFragments

public Text[] getFragments()

The highlighted fragments. null if failed to highlight (for example, the field is not stored).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

readHighlightField

public static HighlightField readHighlightField(StreamInput in)
                                         throws java.io.IOException

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

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

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException