com.azure.search.documents.indexes.models

Class AnalyzedTokenInfo

java.lang.Object

com.azure.search.documents.indexes.models.AnalyzedTokenInfo

public final class AnalyzedTokenInfo
extends Object

Information about a token returned by an analyzer.

Constructor Summary

Constructors

Constructor and Description
AnalyzedTokenInfo(String token, int startOffset, int endOffset, int position) Constructor of AnalyzedTokenInfo.

Method Summary

Modifier and Type	Method and Description
int	getEndOffset() Get the endOffset property: The index of the last character of the token in the input text.
int	getPosition() Get the position property: The position of the token in the input text relative to other tokens.
int	getStartOffset() Get the startOffset property: The index of the first character of the token in the input text.
String	getToken() Get the token property: The token returned by the analyzer.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzedTokenInfo

public AnalyzedTokenInfo(String token,
                         int startOffset,
                         int endOffset,
                         int position)

Constructor of AnalyzedTokenInfo.

Parameters:

token - The token returned by the analyzer.

startOffset - The index of the first character of the token in the input text.

endOffset - The index of the last character of the token in the input text.

position - The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other.

Method Detail

getToken

public String getToken()

Get the token property: The token returned by the analyzer.

Returns:

the token value.

getStartOffset

public int getStartOffset()

Get the startOffset property: The index of the first character of the token in the input text.

Returns:

the startOffset value.

getEndOffset

public int getEndOffset()

Get the endOffset property: The index of the last character of the token in the input text.

Returns:

the endOffset value.

getPosition

public int getPosition()

Get the position property: The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other.

Returns:

the position value.