org.apache.lucene.search.uhighlight

Class OffsetsEnum

java.lang.Object

org.apache.lucene.search.uhighlight.OffsetsEnum

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<OffsetsEnum>

public class OffsetsEnum
extends Object
implements Comparable<OffsetsEnum>, Closeable

Holds the term & PostingsEnum, and info for tracking the occurrences of a term within the text. It is advanced with the underlying postings and is placed in a priority queue by highlightOffsetsEnums based on the start offset.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Constructor and Description
OffsetsEnum(BytesRef term, PostingsEnum postingsEnum)

Method Summary

Modifier and Type	Method and Description
void	close()
int	compareTo(OffsetsEnum other)

Methods inherited from class java.lang.Object

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

Constructor Detail

OffsetsEnum

public OffsetsEnum(BytesRef term,
                   PostingsEnum postingsEnum)
            throws IOException

Throws:

IOException

Method Detail

compareTo

public int compareTo(OffsetsEnum other)

Specified by:

compareTo in interface Comparable<OffsetsEnum>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException