Package org.elasticsearch.common.document

Class DocumentField

java.lang.Object

org.elasticsearch.common.document.DocumentField

All Implemented Interfaces:

Iterable<Object>, Writeable, ToXContent, ToXContentFragment

public class DocumentField
extends Object
implements Writeable, ToXContentFragment, 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.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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
DocumentField(String name, List<Object> values)
DocumentField(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static DocumentField	fromXContent(XContentParser parser)
String	getName()	The name of the field.
<V> V	getValue()	The first value of the hit.
List<Object>	getValues()	The field values.
int	hashCode()
boolean	isMetadataField()
Iterator<Object>	iterator()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, 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 java.lang.Iterable

forEach, spliterator

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

isFragment

Constructor Detail

DocumentField

public DocumentField(StreamInput in)
              throws IOException

Throws:

IOException

DocumentField

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

Method Detail

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.

isMetadataField

public boolean isMetadataField()

Returns:

The field is a metadata field

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>

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 XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static DocumentField fromXContent(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