org.elasticsearch.index.fielddata

Class MultiGeoPointValues

java.lang.Object

org.elasticsearch.index.fielddata.MultiGeoPointValues

public abstract class MultiGeoPointValues
extends Object

A stateful lightweight per document set of GeoPoint values. To iterate over values in a document use the following pattern:

   GeoPointValues values = ..;
   values.setDocId(docId);
   final int numValues = values.count();
   for (int i = 0; i < numValues; i++) {
       GeoPoint value = values.valueAt(i);
       // process value
   }
 

The set of values associated with a document might contain duplicates and comes in a non-specified order.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiGeoPointValues() Creates a new MultiGeoPointValues instance

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	count() Return the number of geo points the current document has.
abstract void	setDocument(int docId) Sets iteration to the specified docID.
abstract GeoPoint	valueAt(int i) Return the i-th value associated with the current document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiGeoPointValues

protected MultiGeoPointValues()

Creates a new MultiGeoPointValues instance

Method Detail

setDocument

public abstract void setDocument(int docId)

Sets iteration to the specified docID.

Parameters:

docId - document ID

See Also:

valueAt(int), count()

count

public abstract int count()

Return the number of geo points the current document has.

valueAt

public abstract GeoPoint valueAt(int i)

Return the i-th value associated with the current document. Behavior is undefined when i is undefined or greater than or equal to count(). Note: the returned GeoPoint might be shared across invocations.

Returns:

the next value for the current docID set to setDocument(int).