Class AnalysisOptions
- All Implemented Interfaces:
Serializable
,Cloneable
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton.A JSON object that contains a collection of string:value pairs that each map a term to its stem.A JSON array of terms to ignore during indexing and searching.A JSON object that defines synonym groups and aliases.int
hashCode()
void
setAlgorithmicStemming
(AlgorithmicStemming algorithmicStemming) The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.void
setAlgorithmicStemming
(String algorithmicStemming) The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.void
setJapaneseTokenizationDictionary
(String japaneseTokenizationDictionary) A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton.void
setStemmingDictionary
(String stemmingDictionary) A JSON object that contains a collection of string:value pairs that each map a term to its stem.void
setStopwords
(String stopwords) A JSON array of terms to ignore during indexing and searching.void
setSynonyms
(String synonyms) A JSON object that defines synonym groups and aliases.toString()
Returns a string representation of this object; useful for testing and debugging.withAlgorithmicStemming
(AlgorithmicStemming algorithmicStemming) The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.withAlgorithmicStemming
(String algorithmicStemming) The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.withJapaneseTokenizationDictionary
(String japaneseTokenizationDictionary) A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton.withStemmingDictionary
(String stemmingDictionary) A JSON object that contains a collection of string:value pairs that each map a term to its stem.withStopwords
(String stopwords) A JSON array of terms to ignore during indexing and searching.withSynonyms
(String synonyms) A JSON object that defines synonym groups and aliases.
-
Constructor Details
-
AnalysisOptions
public AnalysisOptions()
-
-
Method Details
-
setSynonyms
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
- Parameters:
synonyms
- A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
-
getSynonyms
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
- Returns:
- A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
-
withSynonyms
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
- Parameters:
synonyms
- A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStopwords
A JSON array of terms to ignore during indexing and searching. For example,
["a", "an", "the", "of"]
. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.- Parameters:
stopwords
- A JSON array of terms to ignore during indexing and searching. For example,["a", "an", "the", "of"]
. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
-
getStopwords
A JSON array of terms to ignore during indexing and searching. For example,
["a", "an", "the", "of"]
. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.- Returns:
- A JSON array of terms to ignore during indexing and searching.
For example,
["a", "an", "the", "of"]
. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
-
withStopwords
A JSON array of terms to ignore during indexing and searching. For example,
["a", "an", "the", "of"]
. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.- Parameters:
stopwords
- A JSON array of terms to ignore during indexing and searching. For example,["a", "an", "the", "of"]
. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStemmingDictionary
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example,
{"term1": "stem1", "term2": "stem2", "term3": "stem3"}
. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.- Parameters:
stemmingDictionary
- A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example,{"term1": "stem1", "term2": "stem2", "term3": "stem3"}
. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
-
getStemmingDictionary
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example,
{"term1": "stem1", "term2": "stem2", "term3": "stem3"}
. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.- Returns:
- A JSON object that contains a collection of string:value pairs
that each map a term to its stem. For example,
{"term1": "stem1", "term2": "stem2", "term3": "stem3"}
. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
-
withStemmingDictionary
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example,
{"term1": "stem1", "term2": "stem2", "term3": "stem3"}
. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.- Parameters:
stemmingDictionary
- A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example,{"term1": "stem1", "term2": "stem2", "term3": "stem3"}
. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setJapaneseTokenizationDictionary
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
- Parameters:
japaneseTokenizationDictionary
- A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
-
getJapaneseTokenizationDictionary
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
- Returns:
- A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
-
withJapaneseTokenizationDictionary
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
- Parameters:
japaneseTokenizationDictionary
- A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAlgorithmicStemming
The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide- Parameters:
algorithmicStemming
- The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide- See Also:
-
getAlgorithmicStemming
The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide- Returns:
- The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide - See Also:
-
withAlgorithmicStemming
The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide- Parameters:
algorithmicStemming
- The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAlgorithmicStemming
The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide- Parameters:
algorithmicStemming
- The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide- See Also:
-
withAlgorithmicStemming
The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide- Parameters:
algorithmicStemming
- The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-