Module org.apache.lucene.highlighter

Package org.apache.lucene.search.uhighlight

Class TokenStreamOffsetStrategy.TokenStreamOffsetsEnum

java.lang.Object

org.apache.lucene.search.uhighlight.OffsetsEnum

org.apache.lucene.search.uhighlight.TokenStreamOffsetStrategy.TokenStreamOffsetsEnum

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<OffsetsEnum>

Enclosing class:

TokenStreamOffsetStrategy

private static class TokenStreamOffsetStrategy.TokenStreamOffsetsEnum
extends OffsetsEnum

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.uhighlight.OffsetsEnum

OffsetsEnum.MultiOffsetsEnum, OffsetsEnum.OfMatchesIterator, OffsetsEnum.OfMatchesIteratorWithSubs, OffsetsEnum.OfPostings

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final CharTermAttribute	charTermAtt
(package private) int	currentMatch
(package private) final BytesRef[]	matchDescriptions
(package private) final CharArrayMatcher[]	matchers
(package private) final OffsetAttribute	offsetAtt
(package private) TokenStream	stream

Fields inherited from class org.apache.lucene.search.uhighlight.OffsetsEnum

EMPTY

Constructor Summary

Constructors

Constructor	Description
TokenStreamOffsetsEnum(TokenStream ts, CharArrayMatcher[] matchers)

Method Summary

Modifier and Type	Method	Description
void	close()
int	endOffset()
int	freq()	An estimate of the number of occurrences of this term/OffsetsEnum.
BytesRef	getTerm()	The term at this position.
boolean	nextPosition()	Advances to the next position and returns true, or if can't then returns false.
int	startOffset()

Methods inherited from class org.apache.lucene.search.uhighlight.OffsetsEnum

compareTo, toString

Methods inherited from class java.lang.Object

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

Field Details

stream

TokenStream stream

matchers

final CharArrayMatcher[] matchers

charTermAtt

final CharTermAttribute charTermAtt

offsetAtt

final OffsetAttribute offsetAtt

currentMatch

int currentMatch

matchDescriptions

final BytesRef[] matchDescriptions

Constructor Details

TokenStreamOffsetsEnum

TokenStreamOffsetsEnum(TokenStream ts,
 CharArrayMatcher[] matchers)
                throws IOException

Throws:

IOException

Method Details

nextPosition

public boolean nextPosition()
                     throws IOException

Description copied from class: OffsetsEnum

Advances to the next position and returns true, or if can't then returns false. Note that the initial state of this class is not positioned.

Specified by:

nextPosition in class OffsetsEnum

Throws:

IOException

freq

public int freq()
         throws IOException

Description copied from class: OffsetsEnum

An estimate of the number of occurrences of this term/OffsetsEnum.

Specified by:

freq in class OffsetsEnum

Throws:

IOException

startOffset

public int startOffset()
                throws IOException

Specified by:

startOffset in class OffsetsEnum

Throws:

IOException

endOffset

public int endOffset()
              throws IOException

Specified by:

endOffset in class OffsetsEnum

Throws:

IOException

getTerm

public BytesRef getTerm()
                 throws IOException

Description copied from class: OffsetsEnum

The term at this position. This BytesRef is safe to continue to refer to, even after we move to the next position.

Specified by:

getTerm in class OffsetsEnum

Throws:

IOException

See Also:

• Passage.getMatchTerms()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OffsetsEnum

Throws:

IOException