Package com.azure.search.documents.indexes.models

Class KeywordMarkerTokenFilter

java.lang.Object

com.azure.search.documents.indexes.models.TokenFilter

com.azure.search.documents.indexes.models.KeywordMarkerTokenFilter

public final class KeywordMarkerTokenFilter
extends TokenFilter

Marks terms as keywords. This token filter is implemented using Apache Lucene.

Constructor Summary

Constructors

Constructor	Description
KeywordMarkerTokenFilter(String name, List<String> keywords)	Constructor of KeywordMarkerTokenFilter.

Method Summary

Modifier and Type	Method	Description
List<String>	getKeywords()	Get the keywords property: A list of words to mark as keywords.
Boolean	isCaseIgnored()	Get the ignoreCase property: A value indicating whether to ignore case.
KeywordMarkerTokenFilter	setCaseIgnored(Boolean caseIgnored)	Set the ignoreCase property: A value indicating whether to ignore case.

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

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordMarkerTokenFilter

public KeywordMarkerTokenFilter(String name,
                                List<String> keywords)

Constructor of KeywordMarkerTokenFilter.

Parameters:

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

keywords - A list of words to mark as keywords.

Method Detail

getKeywords

public List<String> getKeywords()

Get the keywords property: A list of words to mark as keywords.

Returns:

the keywords value.

isCaseIgnored

public Boolean isCaseIgnored()

Get the ignoreCase property: A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false.

Returns:

the ignoreCase value.

setCaseIgnored

public KeywordMarkerTokenFilter setCaseIgnored(Boolean caseIgnored)

Set the ignoreCase property: A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false.

Parameters:

caseIgnored - the ignoreCase value to set.

Returns:

the KeywordMarkerTokenFilter object itself.