AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudSearch::Model::AnalysisOptions Class Reference

#include <AnalysisOptions.h>

Public Member Functions

 AnalysisOptions ()
 
 AnalysisOptions (const Aws::Utils::Xml::XmlNode &xmlNode)
 
AnalysisOptionsoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetSynonyms () const
 
bool SynonymsHasBeenSet () const
 
void SetSynonyms (const Aws::String &value)
 
void SetSynonyms (Aws::String &&value)
 
void SetSynonyms (const char *value)
 
AnalysisOptionsWithSynonyms (const Aws::String &value)
 
AnalysisOptionsWithSynonyms (Aws::String &&value)
 
AnalysisOptionsWithSynonyms (const char *value)
 
const Aws::StringGetStopwords () const
 
bool StopwordsHasBeenSet () const
 
void SetStopwords (const Aws::String &value)
 
void SetStopwords (Aws::String &&value)
 
void SetStopwords (const char *value)
 
AnalysisOptionsWithStopwords (const Aws::String &value)
 
AnalysisOptionsWithStopwords (Aws::String &&value)
 
AnalysisOptionsWithStopwords (const char *value)
 
const Aws::StringGetStemmingDictionary () const
 
bool StemmingDictionaryHasBeenSet () const
 
void SetStemmingDictionary (const Aws::String &value)
 
void SetStemmingDictionary (Aws::String &&value)
 
void SetStemmingDictionary (const char *value)
 
AnalysisOptionsWithStemmingDictionary (const Aws::String &value)
 
AnalysisOptionsWithStemmingDictionary (Aws::String &&value)
 
AnalysisOptionsWithStemmingDictionary (const char *value)
 
const Aws::StringGetJapaneseTokenizationDictionary () const
 
bool JapaneseTokenizationDictionaryHasBeenSet () const
 
void SetJapaneseTokenizationDictionary (const Aws::String &value)
 
void SetJapaneseTokenizationDictionary (Aws::String &&value)
 
void SetJapaneseTokenizationDictionary (const char *value)
 
AnalysisOptionsWithJapaneseTokenizationDictionary (const Aws::String &value)
 
AnalysisOptionsWithJapaneseTokenizationDictionary (Aws::String &&value)
 
AnalysisOptionsWithJapaneseTokenizationDictionary (const char *value)
 
const AlgorithmicStemmingGetAlgorithmicStemming () const
 
bool AlgorithmicStemmingHasBeenSet () const
 
void SetAlgorithmicStemming (const AlgorithmicStemming &value)
 
void SetAlgorithmicStemming (AlgorithmicStemming &&value)
 
AnalysisOptionsWithAlgorithmicStemming (const AlgorithmicStemming &value)
 
AnalysisOptionsWithAlgorithmicStemming (AlgorithmicStemming &&value)
 

Detailed Description

Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

See Also:

AWS API Reference

Definition at line 33 of file AnalysisOptions.h.

Constructor & Destructor Documentation

◆ AnalysisOptions() [1/2]

Aws::CloudSearch::Model::AnalysisOptions::AnalysisOptions ( )

◆ AnalysisOptions() [2/2]

Aws::CloudSearch::Model::AnalysisOptions::AnalysisOptions ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AlgorithmicStemmingHasBeenSet()

bool Aws::CloudSearch::Model::AnalysisOptions::AlgorithmicStemmingHasBeenSet ( ) const
inline

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

Definition at line 386 of file AnalysisOptions.h.

◆ GetAlgorithmicStemming()

const AlgorithmicStemming& Aws::CloudSearch::Model::AnalysisOptions::GetAlgorithmicStemming ( ) const
inline

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

Definition at line 376 of file AnalysisOptions.h.

◆ GetJapaneseTokenizationDictionary()

const Aws::String& Aws::CloudSearch::Model::AnalysisOptions::GetJapaneseTokenizationDictionary ( ) const
inline

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.

Definition at line 309 of file AnalysisOptions.h.

◆ GetStemmingDictionary()

const Aws::String& Aws::CloudSearch::Model::AnalysisOptions::GetStemmingDictionary ( ) const
inline

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.

Definition at line 230 of file AnalysisOptions.h.

◆ GetStopwords()

const Aws::String& Aws::CloudSearch::Model::AnalysisOptions::GetStopwords ( ) const
inline

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.

Definition at line 163 of file AnalysisOptions.h.

◆ GetSynonyms()

const Aws::String& Aws::CloudSearch::Model::AnalysisOptions::GetSynonyms ( ) const
inline

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.

Definition at line 56 of file AnalysisOptions.h.

◆ JapaneseTokenizationDictionaryHasBeenSet()

bool Aws::CloudSearch::Model::AnalysisOptions::JapaneseTokenizationDictionaryHasBeenSet ( ) const
inline

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.

Definition at line 317 of file AnalysisOptions.h.

◆ operator=()

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::CloudSearch::Model::AnalysisOptions::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::CloudSearch::Model::AnalysisOptions::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ SetAlgorithmicStemming() [1/2]

void Aws::CloudSearch::Model::AnalysisOptions::SetAlgorithmicStemming ( const AlgorithmicStemming value)
inline

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

Definition at line 396 of file AnalysisOptions.h.

◆ SetAlgorithmicStemming() [2/2]

void Aws::CloudSearch::Model::AnalysisOptions::SetAlgorithmicStemming ( AlgorithmicStemming &&  value)
inline

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

Definition at line 406 of file AnalysisOptions.h.

◆ SetJapaneseTokenizationDictionary() [1/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetJapaneseTokenizationDictionary ( const Aws::String value)
inline

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.

Definition at line 325 of file AnalysisOptions.h.

◆ SetJapaneseTokenizationDictionary() [2/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetJapaneseTokenizationDictionary ( Aws::String &&  value)
inline

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.

Definition at line 333 of file AnalysisOptions.h.

◆ SetJapaneseTokenizationDictionary() [3/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetJapaneseTokenizationDictionary ( const char *  value)
inline

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.

Definition at line 341 of file AnalysisOptions.h.

◆ SetStemmingDictionary() [1/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetStemmingDictionary ( const Aws::String value)
inline

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.

Definition at line 250 of file AnalysisOptions.h.

◆ SetStemmingDictionary() [2/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetStemmingDictionary ( Aws::String &&  value)
inline

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.

Definition at line 260 of file AnalysisOptions.h.

◆ SetStemmingDictionary() [3/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetStemmingDictionary ( const char *  value)
inline

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.

Definition at line 270 of file AnalysisOptions.h.

◆ SetStopwords() [1/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetStopwords ( const Aws::String value)
inline

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.

Definition at line 179 of file AnalysisOptions.h.

◆ SetStopwords() [2/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetStopwords ( Aws::String &&  value)
inline

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.

Definition at line 187 of file AnalysisOptions.h.

◆ SetStopwords() [3/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetStopwords ( const char *  value)
inline

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.

Definition at line 195 of file AnalysisOptions.h.

◆ SetSynonyms() [1/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetSynonyms ( const Aws::String value)
inline

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.

Definition at line 84 of file AnalysisOptions.h.

◆ SetSynonyms() [2/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetSynonyms ( Aws::String &&  value)
inline

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.

Definition at line 98 of file AnalysisOptions.h.

◆ SetSynonyms() [3/3]

void Aws::CloudSearch::Model::AnalysisOptions::SetSynonyms ( const char *  value)
inline

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.

Definition at line 112 of file AnalysisOptions.h.

◆ StemmingDictionaryHasBeenSet()

bool Aws::CloudSearch::Model::AnalysisOptions::StemmingDictionaryHasBeenSet ( ) const
inline

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.

Definition at line 240 of file AnalysisOptions.h.

◆ StopwordsHasBeenSet()

bool Aws::CloudSearch::Model::AnalysisOptions::StopwordsHasBeenSet ( ) const
inline

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.

Definition at line 171 of file AnalysisOptions.h.

◆ SynonymsHasBeenSet()

bool Aws::CloudSearch::Model::AnalysisOptions::SynonymsHasBeenSet ( ) const
inline

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.

Definition at line 70 of file AnalysisOptions.h.

◆ WithAlgorithmicStemming() [1/2]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithAlgorithmicStemming ( const AlgorithmicStemming value)
inline

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

Definition at line 416 of file AnalysisOptions.h.

◆ WithAlgorithmicStemming() [2/2]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithAlgorithmicStemming ( AlgorithmicStemming &&  value)
inline

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

Definition at line 426 of file AnalysisOptions.h.

◆ WithJapaneseTokenizationDictionary() [1/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithJapaneseTokenizationDictionary ( const Aws::String value)
inline

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.

Definition at line 349 of file AnalysisOptions.h.

◆ WithJapaneseTokenizationDictionary() [2/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithJapaneseTokenizationDictionary ( Aws::String &&  value)
inline

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.

Definition at line 357 of file AnalysisOptions.h.

◆ WithJapaneseTokenizationDictionary() [3/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithJapaneseTokenizationDictionary ( const char *  value)
inline

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.

Definition at line 365 of file AnalysisOptions.h.

◆ WithStemmingDictionary() [1/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithStemmingDictionary ( const Aws::String value)
inline

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.

Definition at line 280 of file AnalysisOptions.h.

◆ WithStemmingDictionary() [2/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithStemmingDictionary ( Aws::String &&  value)
inline

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.

Definition at line 290 of file AnalysisOptions.h.

◆ WithStemmingDictionary() [3/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithStemmingDictionary ( const char *  value)
inline

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.

Definition at line 300 of file AnalysisOptions.h.

◆ WithStopwords() [1/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithStopwords ( const Aws::String value)
inline

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.

Definition at line 203 of file AnalysisOptions.h.

◆ WithStopwords() [2/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithStopwords ( Aws::String &&  value)
inline

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.

Definition at line 211 of file AnalysisOptions.h.

◆ WithStopwords() [3/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithStopwords ( const char *  value)
inline

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.

Definition at line 219 of file AnalysisOptions.h.

◆ WithSynonyms() [1/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithSynonyms ( const Aws::String value)
inline

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.

Definition at line 126 of file AnalysisOptions.h.

◆ WithSynonyms() [2/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithSynonyms ( Aws::String &&  value)
inline

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.

Definition at line 140 of file AnalysisOptions.h.

◆ WithSynonyms() [3/3]

AnalysisOptions& Aws::CloudSearch::Model::AnalysisOptions::WithSynonyms ( const char *  value)
inline

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.

Definition at line 154 of file AnalysisOptions.h.


The documentation for this class was generated from the following file: