com.amazonaws.services.cloudsearchv2.model.AnalysisScheme Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.cloudsearchv2.model;
import java.io.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 .
*
*/
public class AnalysisScheme implements Serializable {
/**
* 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_]*
*/
private String analysisSchemeName;
/**
* 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, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
*/
private String analysisSchemeLanguage;
/**
* Synonyms, stopwords, and stemming options for an analysis scheme.
*/
private AnalysisOptions analysisOptions;
/**
* 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_]*
*
* @return 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.
*/
public String getAnalysisSchemeName() {
return 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_]*
*
* @param 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.
*/
public void setAnalysisSchemeName(String analysisSchemeName) {
this.analysisSchemeName = 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_]*
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AnalysisScheme withAnalysisSchemeName(String analysisSchemeName) {
this.analysisSchemeName = analysisSchemeName;
return this;
}
/**
* 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, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
*
* @return An IETF
* RFC 4646 language code or mul for multiple languages.
*
* @see AnalysisSchemeLanguage
*/
public String getAnalysisSchemeLanguage() {
return 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, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
*
* @param analysisSchemeLanguage An IETF
* RFC 4646 language code or mul for multiple languages.
*
* @see AnalysisSchemeLanguage
*/
public void setAnalysisSchemeLanguage(String analysisSchemeLanguage) {
this.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, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
*
* @param analysisSchemeLanguage An IETF
* RFC 4646 language code or mul for multiple languages.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see AnalysisSchemeLanguage
*/
public AnalysisScheme withAnalysisSchemeLanguage(String analysisSchemeLanguage) {
this.analysisSchemeLanguage = analysisSchemeLanguage;
return this;
}
/**
* 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, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
*
* @param analysisSchemeLanguage An IETF
* RFC 4646 language code or mul for multiple languages.
*
* @see AnalysisSchemeLanguage
*/
public void setAnalysisSchemeLanguage(AnalysisSchemeLanguage analysisSchemeLanguage) {
this.analysisSchemeLanguage = analysisSchemeLanguage.toString();
}
/**
* 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, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
*
* @param analysisSchemeLanguage An IETF
* RFC 4646 language code or mul for multiple languages.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see AnalysisSchemeLanguage
*/
public AnalysisScheme withAnalysisSchemeLanguage(AnalysisSchemeLanguage analysisSchemeLanguage) {
this.analysisSchemeLanguage = analysisSchemeLanguage.toString();
return this;
}
/**
* Synonyms, stopwords, and stemming options for an analysis scheme.
*
* @return Synonyms, stopwords, and stemming options for an analysis scheme.
*/
public AnalysisOptions getAnalysisOptions() {
return analysisOptions;
}
/**
* Synonyms, stopwords, and stemming options for an analysis scheme.
*
* @param analysisOptions Synonyms, stopwords, and stemming options for an analysis scheme.
*/
public void setAnalysisOptions(AnalysisOptions analysisOptions) {
this.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.
*
* @param analysisOptions Synonyms, stopwords, and stemming options for an analysis scheme.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AnalysisScheme withAnalysisOptions(AnalysisOptions analysisOptions) {
this.analysisOptions = analysisOptions;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAnalysisSchemeName() != null) sb.append("AnalysisSchemeName: " + getAnalysisSchemeName() + ",");
if (getAnalysisSchemeLanguage() != null) sb.append("AnalysisSchemeLanguage: " + getAnalysisSchemeLanguage() + ",");
if (getAnalysisOptions() != null) sb.append("AnalysisOptions: " + getAnalysisOptions() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAnalysisSchemeName() == null) ? 0 : getAnalysisSchemeName().hashCode());
hashCode = prime * hashCode + ((getAnalysisSchemeLanguage() == null) ? 0 : getAnalysisSchemeLanguage().hashCode());
hashCode = prime * hashCode + ((getAnalysisOptions() == null) ? 0 : getAnalysisOptions().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof AnalysisScheme == false) return false;
AnalysisScheme other = (AnalysisScheme)obj;
if (other.getAnalysisSchemeName() == null ^ this.getAnalysisSchemeName() == null) return false;
if (other.getAnalysisSchemeName() != null && other.getAnalysisSchemeName().equals(this.getAnalysisSchemeName()) == false) return false;
if (other.getAnalysisSchemeLanguage() == null ^ this.getAnalysisSchemeLanguage() == null) return false;
if (other.getAnalysisSchemeLanguage() != null && other.getAnalysisSchemeLanguage().equals(this.getAnalysisSchemeLanguage()) == false) return false;
if (other.getAnalysisOptions() == null ^ this.getAnalysisOptions() == null) return false;
if (other.getAnalysisOptions() != null && other.getAnalysisOptions().equals(this.getAnalysisOptions()) == false) return false;
return true;
}
}