Package org.elasticsearch.index.mapper

Class ParseContext.Document

java.lang.Object

org.elasticsearch.index.mapper.ParseContext.Document

All Implemented Interfaces:

Iterable<IndexableField>

Enclosing class:

ParseContext

public static class ParseContext.Document
extends Object
implements Iterable<IndexableField>

Fork of Document with additional functionality.

Constructor Summary

Constructors

Constructor	Description
Document()

Method Summary

Modifier and Type	Method	Description
void	add(IndexableField field)
void	addWithKey(Object key, IndexableField field)	Add fields so that they can later be fetched using getByKey(Object).
String	get(String name)
BytesRef	getBinaryValue(String name)
IndexableField	getByKey(Object key)	Get back fields that have been previously added with addWithKey(Object, IndexableField).
IndexableField	getField(String name)
List<IndexableField>	getFields()
IndexableField[]	getFields(String name)
ParseContext.Document	getParent()	Return the parent document, or null if this is the root document.
String	getPath()	Return the path associated with this document.
String	getPrefix()	Return a prefix that all fields in this document should have.
String[]	getValues(String name)	Returns an array of values of the field specified as the method parameter.
Iterator<IndexableField>	iterator()

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

Document

public Document()

Method Detail

getPath

public String getPath()

Return the path associated with this document.

getPrefix

public String getPrefix()

Return a prefix that all fields in this document should have.

getParent

public ParseContext.Document getParent()

Return the parent document, or null if this is the root document.

iterator

public Iterator<IndexableField> iterator()

Specified by:

iterator in interface Iterable<IndexableField>

getFields

public List<IndexableField> getFields()

add

public void add(IndexableField field)

addWithKey

public void addWithKey(Object key,
                       IndexableField field)

Add fields so that they can later be fetched using getByKey(Object).

getByKey

public IndexableField getByKey(Object key)

Get back fields that have been previously added with addWithKey(Object, IndexableField).

getFields

public IndexableField[] getFields(String name)

getValues

public final String[] getValues(String name)

Returns an array of values of the field specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null. If you want the actual numeric field instances back, use getFields().

Parameters:

name - the name of the field

Returns:

a String[] of field values

getField

public IndexableField getField(String name)

get

public String get(String name)

getBinaryValue

public BytesRef getBinaryValue(String name)