com.amazonaws.services.cloudsearchv2.model.TextArrayOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-osgi Show documentation
Show all versions of aws-java-sdk-osgi Show documentation
The AWS SDK for Java with support for OSGi. The AWS SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).
/*
* Copyright 2011-2016 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;
/**
*
* Options for a field that contains an array of text strings. Present if
* IndexFieldType specifies the field is of type
* text-array. A text-array field is always
* searchable. All options are enabled by default.
*
*/
public class TextArrayOptions implements Serializable, Cloneable {
/**
* A value to use for the field if the field isn't specified for a document.
*/
private String defaultValue;
/**
*
* A list of source fields to map to the field.
*
*/
private String sourceFields;
/**
*
* Whether the contents of the field can be returned in the search results.
*
*/
private Boolean returnEnabled;
/**
*
* Whether highlights can be returned for the field.
*
*/
private Boolean highlightEnabled;
/**
*
* The name of an analysis scheme for a text-array field.
*
*/
private String analysisScheme;
/**
* A value to use for the field if the field isn't specified for a document.
*
* @param defaultValue
* A value to use for the field if the field isn't specified for a
* document.
*/
public void setDefaultValue(String defaultValue) {
this.defaultValue = defaultValue;
}
/**
* A value to use for the field if the field isn't specified for a document.
*
* @return A value to use for the field if the field isn't specified for a
* document.
*/
public String getDefaultValue() {
return this.defaultValue;
}
/**
* A value to use for the field if the field isn't specified for a document.
*
* @param defaultValue
* A value to use for the field if the field isn't specified for a
* document.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TextArrayOptions withDefaultValue(String defaultValue) {
setDefaultValue(defaultValue);
return this;
}
/**
*
* A list of source fields to map to the field.
*
*
* @param sourceFields
* A list of source fields to map to the field.
*/
public void setSourceFields(String sourceFields) {
this.sourceFields = sourceFields;
}
/**
*
* A list of source fields to map to the field.
*
*
* @return A list of source fields to map to the field.
*/
public String getSourceFields() {
return this.sourceFields;
}
/**
*
* A list of source fields to map to the field.
*
*
* @param sourceFields
* A list of source fields to map to the field.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TextArrayOptions withSourceFields(String sourceFields) {
setSourceFields(sourceFields);
return this;
}
/**
*
* Whether the contents of the field can be returned in the search results.
*
*
* @param returnEnabled
* Whether the contents of the field can be returned in the search
* results.
*/
public void setReturnEnabled(Boolean returnEnabled) {
this.returnEnabled = returnEnabled;
}
/**
*
* Whether the contents of the field can be returned in the search results.
*
*
* @return Whether the contents of the field can be returned in the search
* results.
*/
public Boolean getReturnEnabled() {
return this.returnEnabled;
}
/**
*
* Whether the contents of the field can be returned in the search results.
*
*
* @param returnEnabled
* Whether the contents of the field can be returned in the search
* results.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TextArrayOptions withReturnEnabled(Boolean returnEnabled) {
setReturnEnabled(returnEnabled);
return this;
}
/**
*
* Whether the contents of the field can be returned in the search results.
*
*
* @return Whether the contents of the field can be returned in the search
* results.
*/
public Boolean isReturnEnabled() {
return this.returnEnabled;
}
/**
*
* Whether highlights can be returned for the field.
*
*
* @param highlightEnabled
* Whether highlights can be returned for the field.
*/
public void setHighlightEnabled(Boolean highlightEnabled) {
this.highlightEnabled = highlightEnabled;
}
/**
*
* Whether highlights can be returned for the field.
*
*
* @return Whether highlights can be returned for the field.
*/
public Boolean getHighlightEnabled() {
return this.highlightEnabled;
}
/**
*
* Whether highlights can be returned for the field.
*
*
* @param highlightEnabled
* Whether highlights can be returned for the field.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TextArrayOptions withHighlightEnabled(Boolean highlightEnabled) {
setHighlightEnabled(highlightEnabled);
return this;
}
/**
*
* Whether highlights can be returned for the field.
*
*
* @return Whether highlights can be returned for the field.
*/
public Boolean isHighlightEnabled() {
return this.highlightEnabled;
}
/**
*
* The name of an analysis scheme for a text-array field.
*
*
* @param analysisScheme
* The name of an analysis scheme for a text-array
* field.
*/
public void setAnalysisScheme(String analysisScheme) {
this.analysisScheme = analysisScheme;
}
/**
*
* The name of an analysis scheme for a text-array field.
*
*
* @return The name of an analysis scheme for a text-array
* field.
*/
public String getAnalysisScheme() {
return this.analysisScheme;
}
/**
*
* The name of an analysis scheme for a text-array field.
*
*
* @param analysisScheme
* The name of an analysis scheme for a text-array
* field.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TextArrayOptions withAnalysisScheme(String analysisScheme) {
setAnalysisScheme(analysisScheme);
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 (getDefaultValue() != null)
sb.append("DefaultValue: " + getDefaultValue() + ",");
if (getSourceFields() != null)
sb.append("SourceFields: " + getSourceFields() + ",");
if (getReturnEnabled() != null)
sb.append("ReturnEnabled: " + getReturnEnabled() + ",");
if (getHighlightEnabled() != null)
sb.append("HighlightEnabled: " + getHighlightEnabled() + ",");
if (getAnalysisScheme() != null)
sb.append("AnalysisScheme: " + getAnalysisScheme());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TextArrayOptions == false)
return false;
TextArrayOptions other = (TextArrayOptions) obj;
if (other.getDefaultValue() == null ^ this.getDefaultValue() == null)
return false;
if (other.getDefaultValue() != null
&& other.getDefaultValue().equals(this.getDefaultValue()) == false)
return false;
if (other.getSourceFields() == null ^ this.getSourceFields() == null)
return false;
if (other.getSourceFields() != null
&& other.getSourceFields().equals(this.getSourceFields()) == false)
return false;
if (other.getReturnEnabled() == null ^ this.getReturnEnabled() == null)
return false;
if (other.getReturnEnabled() != null
&& other.getReturnEnabled().equals(this.getReturnEnabled()) == false)
return false;
if (other.getHighlightEnabled() == null
^ this.getHighlightEnabled() == null)
return false;
if (other.getHighlightEnabled() != null
&& other.getHighlightEnabled().equals(
this.getHighlightEnabled()) == false)
return false;
if (other.getAnalysisScheme() == null
^ this.getAnalysisScheme() == null)
return false;
if (other.getAnalysisScheme() != null
&& other.getAnalysisScheme().equals(this.getAnalysisScheme()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getDefaultValue() == null) ? 0 : getDefaultValue()
.hashCode());
hashCode = prime
* hashCode
+ ((getSourceFields() == null) ? 0 : getSourceFields()
.hashCode());
hashCode = prime
* hashCode
+ ((getReturnEnabled() == null) ? 0 : getReturnEnabled()
.hashCode());
hashCode = prime
* hashCode
+ ((getHighlightEnabled() == null) ? 0 : getHighlightEnabled()
.hashCode());
hashCode = prime
* hashCode
+ ((getAnalysisScheme() == null) ? 0 : getAnalysisScheme()
.hashCode());
return hashCode;
}
@Override
public TextArrayOptions clone() {
try {
return (TextArrayOptions) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy