129 строки
9.9 KiB
YAML
129 строки
9.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.KeepTokenFilter"
|
|
fullName: "com.azure.search.documents.indexes.models.KeepTokenFilter"
|
|
name: "KeepTokenFilter"
|
|
nameWithType: "KeepTokenFilter"
|
|
summary: "A token filter that only keeps tokens with text contained in a specified list of words."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter?alt=com.azure.search.documents.indexes.models.TokenFilter&text=TokenFilter\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter.fromJson(com.azure.json.JsonReader)?alt=com.azure.search.documents.indexes.models.TokenFilter.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter.getName()?alt=com.azure.search.documents.indexes.models.TokenFilter.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter.getOdataType()?alt=com.azure.search.documents.indexes.models.TokenFilter.getOdataType&text=getOdataType\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.TokenFilter.toJson(com.azure.json.JsonWriter)?alt=com.azure.search.documents.indexes.models.TokenFilter.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 **KeepTokenFilter**</br> extends <xref href=\"com.azure.search.documents.indexes.models.TokenFilter?alt=com.azure.search.documents.indexes.models.TokenFilter&text=TokenFilter\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.KeepTokenFilter.KeepTokenFilter(java.lang.String,java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.search.documents.indexes.models.KeepTokenFilter.KeepTokenFilter(String name, List<String> keepWords)"
|
|
name: "KeepTokenFilter(String name, List<String> keepWords)"
|
|
nameWithType: "KeepTokenFilter.KeepTokenFilter(String name, List<String> keepWords)"
|
|
summary: "Creates an instance of Keep<wbr>Token<wbr>Filter 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>"
|
|
- description: "the keepWords value to set."
|
|
name: "keepWords"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public KeepTokenFilter(String name, List<String> keepWords)"
|
|
desc: "Creates an instance of KeepTokenFilter class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.KeepTokenFilter.areLowerCaseKeepWords()"
|
|
fullName: "com.azure.search.documents.indexes.models.KeepTokenFilter.areLowerCaseKeepWords()"
|
|
name: "areLowerCaseKeepWords()"
|
|
nameWithType: "KeepTokenFilter.areLowerCaseKeepWords()"
|
|
summary: "Get the lower<wbr>Case<wbr>Keep<wbr>Words property: A value indicating whether to lower case all words first."
|
|
syntax: "public Boolean areLowerCaseKeepWords()"
|
|
desc: "Get the lowerCaseKeepWords property: A value indicating whether to lower case all words first. Default is false."
|
|
returns:
|
|
description: "the lowerCaseKeepWords value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.KeepTokenFilter.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.KeepTokenFilter.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "KeepTokenFilter.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Keep<wbr>Token<wbr>Filter 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 KeepTokenFilter 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 KeepTokenFilter from the JsonReader."
|
|
returns:
|
|
description: "An instance of KeepTokenFilter 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.KeepTokenFilter?alt=com.azure.search.documents.indexes.models.KeepTokenFilter&text=KeepTokenFilter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.KeepTokenFilter.getKeepWords()"
|
|
fullName: "com.azure.search.documents.indexes.models.KeepTokenFilter.getKeepWords()"
|
|
name: "getKeepWords()"
|
|
nameWithType: "KeepTokenFilter.getKeepWords()"
|
|
summary: "Get the keep<wbr>Words property: The list of words to keep."
|
|
syntax: "public List<String> getKeepWords()"
|
|
desc: "Get the keepWords property: The list of words to keep."
|
|
returns:
|
|
description: "the keepWords value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.search.documents.indexes.models.KeepTokenFilter.getOdataType()"
|
|
fullName: "com.azure.search.documents.indexes.models.KeepTokenFilter.getOdataType()"
|
|
name: "getOdataType()"
|
|
nameWithType: "KeepTokenFilter.getOdataType()"
|
|
summary: "Get the odata<wbr>Type property: A URI fragment specifying the type of token filter."
|
|
overridden: "com.azure.search.documents.indexes.models.TokenFilter.getOdataType()"
|
|
syntax: "public String getOdataType()"
|
|
desc: "Get the odataType property: A URI fragment specifying the type of token filter."
|
|
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.KeepTokenFilter.setLowerCaseKeepWords(java.lang.Boolean)"
|
|
fullName: "com.azure.search.documents.indexes.models.KeepTokenFilter.setLowerCaseKeepWords(Boolean lowerCaseKeepWords)"
|
|
name: "setLowerCaseKeepWords(Boolean lowerCaseKeepWords)"
|
|
nameWithType: "KeepTokenFilter.setLowerCaseKeepWords(Boolean lowerCaseKeepWords)"
|
|
summary: "Set the lower<wbr>Case<wbr>Keep<wbr>Words property: A value indicating whether to lower case all words first."
|
|
parameters:
|
|
- description: "the lowerCaseKeepWords value to set."
|
|
name: "lowerCaseKeepWords"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public KeepTokenFilter setLowerCaseKeepWords(Boolean lowerCaseKeepWords)"
|
|
desc: "Set the lowerCaseKeepWords property: A value indicating whether to lower case all words first. Default is false."
|
|
returns:
|
|
description: "the KeepTokenFilter object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.KeepTokenFilter?alt=com.azure.search.documents.indexes.models.KeepTokenFilter&text=KeepTokenFilter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.KeepTokenFilter.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.KeepTokenFilter.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "KeepTokenFilter.toJson(JsonWriter jsonWriter)"
|
|
overridden: "com.azure.search.documents.indexes.models.TokenFilter.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: "A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.1
|