org.elasticsearch.search.lookup

Class IndexFieldTerm

java.lang.Object

org.elasticsearch.search.lookup.IndexFieldTerm

All Implemented Interfaces:

Iterable<TermPosition>

public class IndexFieldTerm
extends Object
implements Iterable<TermPosition>

Holds all information on a particular term in a field.

Constructor Summary

Constructors

Constructor and Description
IndexFieldTerm(String term, String fieldName, IndexLookup indexLookup, int flags)

Method Summary

Modifier and Type	Method and Description
long	df()
Iterator<TermPosition>	iterator()
void	setNextDoc(int docId)
protected boolean	shouldRetrieveOffsets()
protected boolean	shouldRetrievePayloads()
protected boolean	shouldRetrievePositions()
int	tf()
long	ttf()
void	validateFlags(int flags2)

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

IndexFieldTerm

public IndexFieldTerm(String term,
                      String fieldName,
                      IndexLookup indexLookup,
                      int flags)

Method Detail

df

public long df()
        throws IOException

Throws:

IOException

ttf

public long ttf()
         throws IOException

Throws:

IOException

setNextDoc

public void setNextDoc(int docId)

shouldRetrievePositions

protected boolean shouldRetrievePositions()

shouldRetrieveOffsets

protected boolean shouldRetrieveOffsets()

shouldRetrievePayloads

protected boolean shouldRetrievePayloads()

tf

public int tf()
       throws IOException

Throws:

IOException

iterator

public Iterator<TermPosition> iterator()

Specified by:

iterator in interface Iterable<TermPosition>

validateFlags

public void validateFlags(int flags2)