Package org.elasticsearch.common.document

Class DocumentField

java.lang.Object

org.elasticsearch.common.document.DocumentField

All Implemented Interfaces:

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

public class DocumentField
extends java.lang.Object
implements Streamable, ToXContentFragment, java.lang.Iterable<java.lang.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

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static DocumentField	fromXContent(XContentParser parser)
java.lang.String	getName()	The name of the field.
<V> V	getValue()	The first value of the hit.
java.util.List<java.lang.Object>	getValues()	The field values.
int	hashCode()
boolean	isMetadataField()
java.util.Iterator<java.lang.Object>	iterator()
static DocumentField	readDocumentField(StreamInput in)
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

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

isFragment

Constructor Detail

DocumentField

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

Method Detail

getName

public java.lang.String getName()

The name of the field.

getValue

public <V> V getValue()

The first value of the hit.

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>

readDocumentField

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

fromXContent

public static DocumentField fromXContent(XContentParser parser)
                                  throws java.io.IOException

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object