org.elasticsearch.search

Class SearchHitField

java.lang.Object

org.elasticsearch.search.SearchHitField

All Implemented Interfaces:

java.lang.Iterable<java.lang.Object>, Streamable

public class SearchHitField
extends java.lang.Object
implements Streamable, java.lang.Iterable<java.lang.Object>

A single field name and values part of a SearchHit.

See Also:

SearchHit

Constructor Summary

Constructors

Constructor and Description
SearchHitField(java.lang.String name, java.util.List<java.lang.Object> values)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() The name of the field.
<T> T	getValue() The first value of the hit.
java.util.List<java.lang.Object>	getValues() The field values.
boolean	isMetadataField()
java.util.Iterator<java.lang.Object>	iterator()
java.lang.String	name() Deprecated. use getName() instead
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
static SearchHitField	readSearchHitField(StreamInput in)
<T> T	value() Deprecated. use getValue() instead
java.util.List<java.lang.Object>	values() Deprecated. use getValues() instead
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, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SearchHitField

public SearchHitField(java.lang.String name,
                      java.util.List<java.lang.Object> values)

Method Detail

name

@Deprecated
public java.lang.String name()

Deprecated. use getName() instead

The name of the field.

getName

public java.lang.String getName()

The name of the field.

value

@Deprecated
public <T> T value()

Deprecated. use getValue() instead

The first value of the hit.

getValue

public <T> T getValue()

The first value of the hit.

values

@Deprecated
public java.util.List<java.lang.Object> values()

Deprecated. use getValues() instead

The field values.

getValues

public java.util.List<java.lang.Object> getValues()

The field values.

isMetadataField

public boolean isMetadataField()

Returns:

The field is a metadata field

iterator

public java.util.Iterator<java.lang.Object> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Object>

readSearchHitField

public static SearchHitField readSearchHitField(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