com.azure.search.documents.indexes.models

Class PatternAnalyzer

java.lang.Object

com.azure.search.documents.indexes.models.LexicalAnalyzer

com.azure.search.documents.indexes.models.PatternAnalyzer

public final class PatternAnalyzer
extends LexicalAnalyzer

Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.

Constructor Summary

Constructors

Constructor and Description
PatternAnalyzer(String name) Constructor of PatternAnalyzer.

Method Summary

Modifier and Type	Method and Description
Boolean	areLowerCaseTerms() Get the lowerCaseTerms property: A value indicating whether terms should be lower-cased.
List<RegexFlags>	getFlags() Get the flags property: Regular expression flags.
String	getPattern() Get the pattern property: A regular expression pattern to match token separators.
List<String>	getStopwords() Get the stopwords property: A list of stopwords.
PatternAnalyzer	setFlags(List<RegexFlags> flags) Set the flags property: Regular expression flags.
PatternAnalyzer	setFlags(RegexFlags... flags) Set the flags property: Regular expression flags.
PatternAnalyzer	setLowerCaseTerms(Boolean lowerCaseTerms) Set the lowerCaseTerms property: A value indicating whether terms should be lower-cased.
PatternAnalyzer	setPattern(String pattern) Set the pattern property: A regular expression pattern to match token separators.
PatternAnalyzer	setStopwords(List<String> stopwords) Set the stopwords property: A list of stopwords.
PatternAnalyzer	setStopwords(String... stopwords) Set the stopwords property: A list of stopwords.

Methods inherited from class com.azure.search.documents.indexes.models.LexicalAnalyzer

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternAnalyzer

public PatternAnalyzer(String name)

Constructor of PatternAnalyzer.

Parameters:

name - The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

Method Detail

areLowerCaseTerms

public Boolean areLowerCaseTerms()

Get the lowerCaseTerms property: A value indicating whether terms should be lower-cased. Default is true.

Returns:

the lowerCaseTerms value.

setLowerCaseTerms

public PatternAnalyzer setLowerCaseTerms(Boolean lowerCaseTerms)

Set the lowerCaseTerms property: A value indicating whether terms should be lower-cased. Default is true.

Parameters:

lowerCaseTerms - the lowerCaseTerms value to set.

Returns:

the PatternAnalyzer object itself.

getPattern

public String getPattern()

Get the pattern property: A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters.

Returns:

the pattern value.

setPattern

public PatternAnalyzer setPattern(String pattern)

Set the pattern property: A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters.

Parameters:

pattern - the pattern value to set.

Returns:

the PatternAnalyzer object itself.

getFlags

public List<RegexFlags> getFlags()

Get the flags property: Regular expression flags.

Returns:

the flags value.

setFlags

public PatternAnalyzer setFlags(RegexFlags... flags)

Set the flags property: Regular expression flags.

Parameters:

flags - the flags value to set.

Returns:

the PatternAnalyzer object itself.

setFlags

public PatternAnalyzer setFlags(List<RegexFlags> flags)

Set the flags property: Regular expression flags.

Parameters:

flags - the flags value to set.

Returns:

the PatternAnalyzer object itself.

getStopwords

public List<String> getStopwords()

Get the stopwords property: A list of stopwords.

Returns:

the stopwords value.

setStopwords

public PatternAnalyzer setStopwords(String... stopwords)

Set the stopwords property: A list of stopwords.

Parameters:

stopwords - the stopwords value to set.

Returns:

the PatternAnalyzer object itself.

setStopwords

public PatternAnalyzer setStopwords(List<String> stopwords)

Set the stopwords property: A list of stopwords.

Parameters:

stopwords - the stopwords value to set.

Returns:

the PatternAnalyzer object itself.