com.amazonaws.services.cloudsearchv2.model

Class AnalysisScheme

java.lang.Object

com.amazonaws.services.cloudsearchv2.model.AnalysisScheme

All Implemented Interfaces:

Serializable

public class AnalysisScheme
extends Object
implements Serializable

Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms , Stopwords , StemmingDictionary , and AlgorithmicStemming .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnalysisScheme()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
AnalysisOptions	getAnalysisOptions() Synonyms, stopwords, and stemming options for an analysis scheme.
String	getAnalysisSchemeLanguage() An IETF RFC 4646 language code or mul for multiple languages.
String	getAnalysisSchemeName() A string that represents the name of an index field.
int	hashCode()
void	setAnalysisOptions(AnalysisOptions analysisOptions) Synonyms, stopwords, and stemming options for an analysis scheme.
void	setAnalysisSchemeLanguage(AnalysisSchemeLanguage analysisSchemeLanguage) An IETF RFC 4646 language code or mul for multiple languages.
void	setAnalysisSchemeLanguage(String analysisSchemeLanguage) An IETF RFC 4646 language code or mul for multiple languages.
void	setAnalysisSchemeName(String analysisSchemeName) A string that represents the name of an index field.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AnalysisScheme	withAnalysisOptions(AnalysisOptions analysisOptions) Synonyms, stopwords, and stemming options for an analysis scheme.
AnalysisScheme	withAnalysisSchemeLanguage(AnalysisSchemeLanguage analysisSchemeLanguage) An IETF RFC 4646 language code or mul for multiple languages.
AnalysisScheme	withAnalysisSchemeLanguage(String analysisSchemeLanguage) An IETF RFC 4646 language code or mul for multiple languages.
AnalysisScheme	withAnalysisSchemeName(String analysisSchemeName) A string that represents the name of an index field.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalysisScheme

public AnalysisScheme()

Method Detail

getAnalysisSchemeName

public String getAnalysisSchemeName()

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Returns:

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

setAnalysisSchemeName

public void setAnalysisSchemeName(String analysisSchemeName)

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

analysisSchemeName - A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

withAnalysisSchemeName

public AnalysisScheme withAnalysisSchemeName(String analysisSchemeName)

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

analysisSchemeName - A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Returns:

A reference to this updated object so that method calls can be chained together.

getAnalysisSchemeLanguage

public String getAnalysisSchemeLanguage()

An IETF RFC 4646 language code or mul for multiple languages.

Constraints:
Allowed Values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant

Returns:

An IETF RFC 4646 language code or mul for multiple languages.

See Also:

AnalysisSchemeLanguage

setAnalysisSchemeLanguage

public void setAnalysisSchemeLanguage(String analysisSchemeLanguage)

An IETF RFC 4646 language code or mul for multiple languages.

Constraints:
Allowed Values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant

Parameters:

analysisSchemeLanguage - An IETF RFC 4646 language code or mul for multiple languages.

See Also:

AnalysisSchemeLanguage

withAnalysisSchemeLanguage

public AnalysisScheme withAnalysisSchemeLanguage(String analysisSchemeLanguage)

An IETF RFC 4646 language code or mul for multiple languages.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant

Parameters:

analysisSchemeLanguage - An IETF RFC 4646 language code or mul for multiple languages.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AnalysisSchemeLanguage

setAnalysisSchemeLanguage

public void setAnalysisSchemeLanguage(AnalysisSchemeLanguage analysisSchemeLanguage)

An IETF RFC 4646 language code or mul for multiple languages.

Constraints:
Allowed Values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant

Parameters:

analysisSchemeLanguage - An IETF RFC 4646 language code or mul for multiple languages.

See Also:

AnalysisSchemeLanguage

withAnalysisSchemeLanguage

public AnalysisScheme withAnalysisSchemeLanguage(AnalysisSchemeLanguage analysisSchemeLanguage)

An IETF RFC 4646 language code or mul for multiple languages.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant

Parameters:

analysisSchemeLanguage - An IETF RFC 4646 language code or mul for multiple languages.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AnalysisSchemeLanguage

getAnalysisOptions

public AnalysisOptions getAnalysisOptions()

Synonyms, stopwords, and stemming options for an analysis scheme.

Returns:

Synonyms, stopwords, and stemming options for an analysis scheme.

setAnalysisOptions

public void setAnalysisOptions(AnalysisOptions analysisOptions)

Synonyms, stopwords, and stemming options for an analysis scheme.

Parameters:

analysisOptions - Synonyms, stopwords, and stemming options for an analysis scheme.

withAnalysisOptions

public AnalysisScheme withAnalysisOptions(AnalysisOptions analysisOptions)

Synonyms, stopwords, and stemming options for an analysis scheme.

Returns a reference to this object so that method calls can be chained together.

Parameters:

analysisOptions - Synonyms, stopwords, and stemming options for an analysis scheme.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object