com.azure.search.documents.indexes.models

Class AnalyzeTextOptions

java.lang.Object

com.azure.search.documents.indexes.models.AnalyzeTextOptions

public final class AnalyzeTextOptions
extends Object

Specifies some text and analysis components used to break that text into tokens.

Constructor Summary

Constructors

Constructor and Description
AnalyzeTextOptions(String text, LexicalAnalyzerName analyzerName) Constructor to AnalyzeTextOptions which takes analyzerName.
AnalyzeTextOptions(String text, LexicalTokenizerName tokenizerName) Constructor to AnalyzeTextOptions which takes tokenizerName.

Method Summary

Modifier and Type	Method and Description
LexicalAnalyzerName	getAnalyzerName() Get the analyzer property: The name of the analyzer to use to break the given text.
List<CharFilterName>	getCharFilters() Get the charFilters property: An optional list of character filters to use when breaking the given text.
String	getText() Get the text property: The text to break into tokens.
List<TokenFilterName>	getTokenFilters() Get the tokenFilters property: An optional list of token filters to use when breaking the given text.
LexicalTokenizerName	getTokenizerName() Get the tokenizer property: The name of the tokenizer to use to break the given text.
AnalyzeTextOptions	setCharFilters(CharFilterName... charFilters) Set the charFilters property: An optional list of character filters to use when breaking the given text.
AnalyzeTextOptions	setTokenFilters(TokenFilterName... tokenFilters) Set the tokenFilters property: An optional list of token filters to use when breaking the given text.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzeTextOptions

public AnalyzeTextOptions(String text,
                          LexicalAnalyzerName analyzerName)

Constructor to AnalyzeTextOptions which takes analyzerName.

Parameters:

text - The text break into tokens.

analyzerName - The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive. Possible values include: 'ArMicrosoft', 'ArLucene', 'HyLucene', 'BnMicrosoft', 'EuLucene', 'BgMicrosoft', 'BgLucene', 'CaMicrosoft', 'CaLucene', 'ZhHansMicrosoft', 'ZhHansLucene', 'ZhHantMicrosoft', 'ZhHantLucene', 'HrMicrosoft', 'CsMicrosoft', 'CsLucene', 'DaMicrosoft', 'DaLucene', 'NlMicrosoft', 'NlLucene', 'EnMicrosoft', 'EnLucene', 'EtMicrosoft', 'FiMicrosoft', 'FiLucene', 'FrMicrosoft', 'FrLucene', 'GlLucene', 'DeMicrosoft', 'DeLucene', 'ElMicrosoft', 'ElLucene', 'GuMicrosoft', 'HeMicrosoft', 'HiMicrosoft', 'HiLucene', 'HuMicrosoft', 'HuLucene', 'IsMicrosoft', 'IdMicrosoft', 'IdLucene', 'GaLucene', 'ItMicrosoft', 'ItLucene', 'JaMicrosoft', 'JaLucene', 'KnMicrosoft', 'KoMicrosoft', 'KoLucene', 'LvMicrosoft', 'LvLucene', 'LtMicrosoft', 'MlMicrosoft', 'MsMicrosoft', 'MrMicrosoft', 'NbMicrosoft', 'NoLucene', 'FaLucene', 'PlMicrosoft', 'PlLucene', 'PtBrMicrosoft', 'PtBrLucene', 'PtPtMicrosoft', 'PtPtLucene', 'PaMicrosoft', 'RoMicrosoft', 'RoLucene', 'RuMicrosoft', 'RuLucene', 'SrCyrillicMicrosoft', 'SrLatinMicrosoft', 'SkMicrosoft', 'SlMicrosoft', 'EsMicrosoft', 'EsLucene', 'SvMicrosoft', 'SvLucene', 'TaMicrosoft', 'TeMicrosoft', 'ThMicrosoft', 'ThLucene', 'TrMicrosoft', 'TrLucene', 'UkMicrosoft', 'UrMicrosoft', 'ViMicrosoft', 'StandardLucene', 'StandardAsciiFoldingLucene', 'Keyword', 'Pattern', 'Simple', 'Stop', 'Whitespace'.

AnalyzeTextOptions

public AnalyzeTextOptions(String text,
                          LexicalTokenizerName tokenizerName)

Constructor to AnalyzeTextOptions which takes tokenizerName.

Parameters:

text - The text break into tokens.

tokenizerName - The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive. Possible values include: 'Classic', 'EdgeNGram', 'Keyword', 'Letter', 'Lowercase', 'MicrosoftLanguageTokenizer', 'MicrosoftLanguageStemmingTokenizer', 'NGram', 'PathHierarchy', 'Pattern', 'Standard', 'UaxUrlEmail', 'Whitespace'.

Method Detail

getText

public String getText()

Get the text property: The text to break into tokens.

Returns:

the text value.

getAnalyzerName

public LexicalAnalyzerName getAnalyzerName()

Get the analyzer property: The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive. Possible values include: 'ArMicrosoft', 'ArLucene', 'HyLucene', 'BnMicrosoft', 'EuLucene', 'BgMicrosoft', 'BgLucene', 'CaMicrosoft', 'CaLucene', 'ZhHansMicrosoft', 'ZhHansLucene', 'ZhHantMicrosoft', 'ZhHantLucene', 'HrMicrosoft', 'CsMicrosoft', 'CsLucene', 'DaMicrosoft', 'DaLucene', 'NlMicrosoft', 'NlLucene', 'EnMicrosoft', 'EnLucene', 'EtMicrosoft', 'FiMicrosoft', 'FiLucene', 'FrMicrosoft', 'FrLucene', 'GlLucene', 'DeMicrosoft', 'DeLucene', 'ElMicrosoft', 'ElLucene', 'GuMicrosoft', 'HeMicrosoft', 'HiMicrosoft', 'HiLucene', 'HuMicrosoft', 'HuLucene', 'IsMicrosoft', 'IdMicrosoft', 'IdLucene', 'GaLucene', 'ItMicrosoft', 'ItLucene', 'JaMicrosoft', 'JaLucene', 'KnMicrosoft', 'KoMicrosoft', 'KoLucene', 'LvMicrosoft', 'LvLucene', 'LtMicrosoft', 'MlMicrosoft', 'MsMicrosoft', 'MrMicrosoft', 'NbMicrosoft', 'NoLucene', 'FaLucene', 'PlMicrosoft', 'PlLucene', 'PtBrMicrosoft', 'PtBrLucene', 'PtPtMicrosoft', 'PtPtLucene', 'PaMicrosoft', 'RoMicrosoft', 'RoLucene', 'RuMicrosoft', 'RuLucene', 'SrCyrillicMicrosoft', 'SrLatinMicrosoft', 'SkMicrosoft', 'SlMicrosoft', 'EsMicrosoft', 'EsLucene', 'SvMicrosoft', 'SvLucene', 'TaMicrosoft', 'TeMicrosoft', 'ThMicrosoft', 'ThLucene', 'TrMicrosoft', 'TrLucene', 'UkMicrosoft', 'UrMicrosoft', 'ViMicrosoft', 'StandardLucene', 'StandardAsciiFoldingLucene', 'Keyword', 'Pattern', 'Simple', 'Stop', 'Whitespace'.

Returns:

the analyzer value.

getTokenizerName

public LexicalTokenizerName getTokenizerName()

Get the tokenizer property: The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive. Possible values include: 'Classic', 'EdgeNGram', 'Keyword', 'Letter', 'Lowercase', 'MicrosoftLanguageTokenizer', 'MicrosoftLanguageStemmingTokenizer', 'NGram', 'PathHierarchy', 'Pattern', 'Standard', 'UaxUrlEmail', 'Whitespace'.

Returns:

the tokenizer value.

getTokenFilters

public List<TokenFilterName> getTokenFilters()

Get the tokenFilters property: An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter.

Returns:

the tokenFilters value.

setTokenFilters

public AnalyzeTextOptions setTokenFilters(TokenFilterName... tokenFilters)

Set the tokenFilters property: An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter.

Parameters:

tokenFilters - the tokenFilters value to set.

Returns:

the AnalyzeRequest object itself.

getCharFilters

public List<CharFilterName> getCharFilters()

Get the charFilters property: An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter.

Returns:

the charFilters value.

setCharFilters

public AnalyzeTextOptions setCharFilters(CharFilterName... charFilters)

Set the charFilters property: An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter.

Parameters:

charFilters - the charFilters value to set.

Returns:

the AnalyzeRequest object itself.