AnalyzeTextOptions Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.6.4
  • java.lang.Object
    • com.azure.search.documents.indexes.models.AnalyzeTextOptions

public final class AnalyzeTextOptions

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

Constructor Summary

Constructor 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 name 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 name 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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

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.

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.

Method Details

getAnalyzerName

public LexicalAnalyzerName getAnalyzerName()

Get the analyzer name property: The name of the analyzer to use to break the given text.

Returns:

the analyzer value.

getCharFilters

public List getCharFilters()

Get the charFilters property: An optional list of character filters to use when breaking the given text.

Returns:

the charFilters value.

getText

public String getText()

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

Returns:

the text value.

getTokenFilters

public List getTokenFilters()

Get the tokenFilters property: An optional list of token filters to use when breaking the given text.

Returns:

the tokenFilters value.

getTokenizerName

public LexicalTokenizerName getTokenizerName()

Get the tokenizer name property: The name of the tokenizer to use to break the given text.

Returns:

the tokenizer value.

setCharFilters

public AnalyzeTextOptions setCharFilters(CharFilterName[] charFilters)

Set the charFilters property: An optional list of character filters to use when breaking the given text.

Parameters:

charFilters - the charFilters value to set.

Returns:

the AnalyzeRequest object itself.

setTokenFilters

public AnalyzeTextOptions setTokenFilters(TokenFilterName[] tokenFilters)

Set the tokenFilters property: An optional list of token filters to use when breaking the given text.

Parameters:

tokenFilters - the tokenFilters value to set.

Returns:

the AnalyzeRequest object itself.

Applies to