Class AnalysisOptions
- java.lang.Object
-
- com.amazonaws.services.cloudsearchv2.model.AnalysisOptions
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class AnalysisOptions extends Object implements Serializable, Cloneable
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AnalysisOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AnalysisOptions
clone()
boolean
equals(Object obj)
String
getAlgorithmicStemming()
The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.String
getJapaneseTokenizationDictionary()
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton.String
getStemmingDictionary()
A JSON object that contains a collection of string:value pairs that each map a term to its stem.String
getStopwords()
A JSON array of terms to ignore during indexing and searching.String
getSynonyms()
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.AnalysisOptions
withAlgorithmicStemming(AlgorithmicStemming algorithmicStemming)
The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.AnalysisOptions
withAlgorithmicStemming(String algorithmicStemming)
The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.AnalysisOptions
withJapaneseTokenizationDictionary(String japaneseTokenizationDictionary)
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton.AnalysisOptions
withStemmingDictionary(String stemmingDictionary)
A JSON object that contains a collection of string:value pairs that each map a term to its stem.AnalysisOptions
withStopwords(String stopwords)
A JSON array of terms to ignore during indexing and searching.AnalysisOptions
withSynonyms(String synonyms)
A JSON object that defines synonym groups and aliases.
-
-
-
Method Detail
-
setSynonyms
public void setSynonyms(String 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.
- 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
public String 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
public AnalysisOptions withSynonyms(String 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.
- 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
public void setStopwords(String 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.- 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
public String 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
public AnalysisOptions withStopwords(String 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.- 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
public void setStemmingDictionary(String 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.- 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
public String 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
public AnalysisOptions withStemmingDictionary(String 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.- 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
public void setJapaneseTokenizationDictionary(String 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.
- 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
public String 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
public AnalysisOptions withJapaneseTokenizationDictionary(String 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.
- 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
public void setAlgorithmicStemming(String 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- 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:
AlgorithmicStemming
-
getAlgorithmicStemming
public String 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:
AlgorithmicStemming
-
withAlgorithmicStemming
public AnalysisOptions withAlgorithmicStemming(String 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- 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:
AlgorithmicStemming
-
setAlgorithmicStemming
public void setAlgorithmicStemming(AlgorithmicStemming 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- 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:
AlgorithmicStemming
-
withAlgorithmicStemming
public AnalysisOptions withAlgorithmicStemming(AlgorithmicStemming 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- 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:
AlgorithmicStemming
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public AnalysisOptions clone()
-
-