178 строки
14 KiB
YAML
178 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.PatternTokenizer"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer"
|
|
name: "PatternTokenizer"
|
|
nameWithType: "PatternTokenizer"
|
|
summary: "Tokenizer that uses regex pattern matching to construct distinct tokens."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.LexicalTokenizer?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.search.documents.indexes.models.LexicalTokenizer?alt=com.azure.search.documents.indexes.models.LexicalTokenizer&text=LexicalTokenizer\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.LexicalTokenizer.fromJson(com.azure.json.JsonReader)?alt=com.azure.search.documents.indexes.models.LexicalTokenizer.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.LexicalTokenizer.getName()?alt=com.azure.search.documents.indexes.models.LexicalTokenizer.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.LexicalTokenizer.getOdataType()?alt=com.azure.search.documents.indexes.models.LexicalTokenizer.getOdataType&text=getOdataType\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.LexicalTokenizer.toJson(com.azure.json.JsonWriter)?alt=com.azure.search.documents.indexes.models.LexicalTokenizer.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **PatternTokenizer**</br> extends <xref href=\"com.azure.search.documents.indexes.models.LexicalTokenizer?alt=com.azure.search.documents.indexes.models.LexicalTokenizer&text=LexicalTokenizer\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.PatternTokenizer(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.PatternTokenizer(String name)"
|
|
name: "PatternTokenizer(String name)"
|
|
nameWithType: "PatternTokenizer.PatternTokenizer(String name)"
|
|
summary: "Creates an instance of Pattern<wbr>Tokenizer class."
|
|
parameters:
|
|
- description: "the name value to set."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PatternTokenizer(String name)"
|
|
desc: "Creates an instance of PatternTokenizer class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "PatternTokenizer.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Pattern<wbr>Tokenizer from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static PatternTokenizer fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the deserialized JSON object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of PatternTokenizer from the JsonReader."
|
|
returns:
|
|
description: "An instance of PatternTokenizer if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.PatternTokenizer?alt=com.azure.search.documents.indexes.models.PatternTokenizer&text=PatternTokenizer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.getFlags()"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.getFlags()"
|
|
name: "getFlags()"
|
|
nameWithType: "PatternTokenizer.getFlags()"
|
|
summary: "Get the flags property: Regular expression flags."
|
|
syntax: "public List<RegexFlags> getFlags()"
|
|
desc: "Get the flags property: Regular expression flags."
|
|
returns:
|
|
description: "the flags value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.RegexFlags?alt=com.azure.search.documents.indexes.models.RegexFlags&text=RegexFlags\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.getGroup()"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.getGroup()"
|
|
name: "getGroup()"
|
|
nameWithType: "PatternTokenizer.getGroup()"
|
|
summary: "Get the group property: The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens."
|
|
syntax: "public Integer getGroup()"
|
|
desc: "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:
|
|
description: "the group value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.getOdataType()"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.getOdataType()"
|
|
name: "getOdataType()"
|
|
nameWithType: "PatternTokenizer.getOdataType()"
|
|
summary: "Get the odata<wbr>Type property: A URI fragment specifying the type of tokenizer."
|
|
overridden: "com.azure.search.documents.indexes.models.LexicalTokenizer.getOdataType()"
|
|
syntax: "public String getOdataType()"
|
|
desc: "Get the odataType property: A URI fragment specifying the type of tokenizer."
|
|
returns:
|
|
description: "the odataType value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.getPattern()"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.getPattern()"
|
|
name: "getPattern()"
|
|
nameWithType: "PatternTokenizer.getPattern()"
|
|
summary: "Get the pattern property: A regular expression pattern to match token separators."
|
|
syntax: "public String getPattern()"
|
|
desc: "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:
|
|
description: "the pattern value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.setFlags(com.azure.search.documents.indexes.models.RegexFlags...)"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.setFlags(RegexFlags[] flags)"
|
|
name: "setFlags(RegexFlags[] flags)"
|
|
nameWithType: "PatternTokenizer.setFlags(RegexFlags[] flags)"
|
|
summary: "Set the flags property: Regular expression flags."
|
|
parameters:
|
|
- description: "the flags value to set."
|
|
name: "flags"
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.RegexFlags?alt=com.azure.search.documents.indexes.models.RegexFlags&text=RegexFlags\" data-throw-if-not-resolved=\"False\" />[]"
|
|
syntax: "public PatternTokenizer setFlags(RegexFlags[] flags)"
|
|
desc: "Set the flags property: Regular expression flags."
|
|
returns:
|
|
description: "the PatternTokenizer object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.PatternTokenizer?alt=com.azure.search.documents.indexes.models.PatternTokenizer&text=PatternTokenizer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.setFlags(java.util.List<com.azure.search.documents.indexes.models.RegexFlags>)"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.setFlags(List<RegexFlags> flags)"
|
|
name: "setFlags(List<RegexFlags> flags)"
|
|
nameWithType: "PatternTokenizer.setFlags(List<RegexFlags> flags)"
|
|
summary: "Set the flags property: Regular expression flags."
|
|
parameters:
|
|
- description: "the flags value to set."
|
|
name: "flags"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.RegexFlags?alt=com.azure.search.documents.indexes.models.RegexFlags&text=RegexFlags\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public PatternTokenizer setFlags(List<RegexFlags> flags)"
|
|
desc: "Set the flags property: Regular expression flags."
|
|
returns:
|
|
description: "the PatternTokenizer object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.PatternTokenizer?alt=com.azure.search.documents.indexes.models.PatternTokenizer&text=PatternTokenizer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.setGroup(java.lang.Integer)"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.setGroup(Integer group)"
|
|
name: "setGroup(Integer group)"
|
|
nameWithType: "PatternTokenizer.setGroup(Integer group)"
|
|
summary: "Set the group property: The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens."
|
|
parameters:
|
|
- description: "the group value to set."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public PatternTokenizer setGroup(Integer group)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the PatternTokenizer object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.PatternTokenizer?alt=com.azure.search.documents.indexes.models.PatternTokenizer&text=PatternTokenizer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.setPattern(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.setPattern(String pattern)"
|
|
name: "setPattern(String pattern)"
|
|
nameWithType: "PatternTokenizer.setPattern(String pattern)"
|
|
summary: "Set the pattern property: A regular expression pattern to match token separators."
|
|
parameters:
|
|
- description: "the pattern value to set."
|
|
name: "pattern"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PatternTokenizer setPattern(String pattern)"
|
|
desc: "Set the pattern property: A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters."
|
|
returns:
|
|
description: "the PatternTokenizer object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.PatternTokenizer?alt=com.azure.search.documents.indexes.models.PatternTokenizer&text=PatternTokenizer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.PatternTokenizer.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.PatternTokenizer.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "PatternTokenizer.toJson(JsonWriter jsonWriter)"
|
|
overridden: "com.azure.search.documents.indexes.models.LexicalTokenizer.toJson(com.azure.json.JsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.1
|