Package org.elasticsearch.common.document

Class DocumentField

java.lang.Object

org.elasticsearch.common.document.DocumentField

All Implemented Interfaces:

Iterable<Object>, Writeable

public class DocumentField
extends Object
implements Writeable, Iterable<Object>

A single field name and values part of SearchHit and GetResult.

See Also:

• SearchHit
• GetResult

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
DocumentField(String name, List<Object> values)
DocumentField(String name, List<Object> values, List<Object> ignoredValues)
DocumentField(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static DocumentField	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
List<Object>	getIgnoredValues()	The field's ignored values as an immutable list.
org.elasticsearch.xcontent.ToXContentFragment	getIgnoredValuesWriter()
String	getName()	The name of the field.
org.elasticsearch.xcontent.ToXContentFragment	getValidValuesWriter()
<V> V	getValue()	The first value of the hit.
List<Object>	getValues()	The field values.
int	hashCode()
Iterator<Object>	iterator()
String	toString()
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 java.lang.Iterable

forEach, spliterator

Constructor Details

DocumentField

public DocumentField(StreamInput in)
              throws IOException

Throws:

IOException

DocumentField

public DocumentField(String name,
 List<Object> values)

DocumentField

public DocumentField(String name,
 List<Object> values,
 List<Object> ignoredValues)

Method Details

getName

public String getName()

The name of the field.

getValue

public <V> V getValue()

The first value of the hit.

getValues

public List<Object> getValues()

The field values.

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>

getIgnoredValues

public List<Object> getIgnoredValues()

The field's ignored values as an immutable list.

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

getValidValuesWriter

public org.elasticsearch.xcontent.ToXContentFragment getValidValuesWriter()

getIgnoredValuesWriter

public org.elasticsearch.xcontent.ToXContentFragment getIgnoredValuesWriter()

fromXContent

public static DocumentField fromXContent(org.elasticsearch.xcontent.XContentParser parser)
                                  throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object