PatternTokenizer Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.LexicalTokenizer
  • • com.azure.search.documents.indexes.models.PatternTokenizer

public final class PatternTokenizer
extends LexicalTokenizer

Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.

Constructor Summary

Constructor	Description
PatternTokenizer(String name)	Creates an instance of PatternTokenizer class.

Method Summary

Modifier and Type	Method and Description
static PatternTokenizer	fromJson(JsonReader jsonReader) Reads an instance of PatternTokenizer from the JsonReader.
List<RegexFlags>	getFlags() Get the flags property: Regular expression flags.
Integer	getGroup() Get the group property: The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of tokenizer.
String	getPattern() Get the pattern property: A regular expression pattern to match token separators.
PatternTokenizer	setFlags(List<RegexFlags> flags) Set the flags property: Regular expression flags.
PatternTokenizer	setFlags(RegexFlags[] flags) Set the flags property: Regular expression flags.
PatternTokenizer	setGroup(Integer group) Set the group property: The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens.
PatternTokenizer	setPattern(String pattern) Set the pattern property: A regular expression pattern to match token separators.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from LexicalTokenizer

fromJson getName getOdataType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PatternTokenizer

public PatternTokenizer(String name)

Creates an instance of PatternTokenizer class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static PatternTokenizer fromJson(JsonReader jsonReader)

Reads an instance of PatternTokenizer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PatternTokenizer if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getFlags

public List<RegexFlags> getFlags()

Get the flags property: Regular expression flags.

Returns:

the flags value.

getGroup

public Integer getGroup()

Get the group property: The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1.

Returns:

the group value.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of tokenizer.

Overrides:

PatternTokenizer.getOdataType()

Returns:

the odataType value.

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.

setFlags

public PatternTokenizer setFlags(List<RegexFlags> flags)

Set the flags property: Regular expression flags.

Parameters:

flags - the flags value to set.

Returns:

the PatternTokenizer object itself.

setFlags

public PatternTokenizer setFlags(RegexFlags[] flags)

Set the flags property: Regular expression flags.

Parameters:

flags - the flags value to set.

Returns:

the PatternTokenizer object itself.

setGroup

public PatternTokenizer setGroup(Integer group)

Set the group property: The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1.

Parameters:

group - the group value to set.

Returns:

the PatternTokenizer object itself.

setPattern

public PatternTokenizer 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 PatternTokenizer object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PatternTokenizer.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException