com.amazonaws.services.cloudsearch.model.SourceDataMap Maven / Gradle / Ivy
/*
* 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.cloudsearch.model;
import java.io.Serializable;
/**
*
* Specifies how to map source attribute values to custom values when populating an IndexField .
*
*/
@Deprecated
public class SourceDataMap implements Serializable {
/**
* The name of the document source field to add to this
* IndexField.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-z][a-z0-9_]*
*/
private String sourceName;
/**
* The default value to use if the source attribute is not specified in a
* document. Optional.
*
* Constraints:
* Length: 0 - 1024
*/
private String defaultValue;
/**
* A map that translates source field values to custom values.
*/
private java.util.Map cases;
/**
* The name of the document source field to add to this
* IndexField.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-z][a-z0-9_]*
*
* @return The name of the document source field to add to this
* IndexField.
*/
public String getSourceName() {
return sourceName;
}
/**
* The name of the document source field to add to this
* IndexField.
*
* Constraints:
* Length: 1 - 64
* Pattern: [a-z][a-z0-9_]*
*
* @param sourceName The name of the document source field to add to this
* IndexField.
*/
public void setSourceName(String sourceName) {
this.sourceName = sourceName;
}
/**
* The name of the document source field to add to this
* IndexField.
*
* 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 sourceName The name of the document source field to add to this
* IndexField.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public SourceDataMap withSourceName(String sourceName) {
this.sourceName = sourceName;
return this;
}
/**
* The default value to use if the source attribute is not specified in a
* document. Optional.
*
* Constraints:
* Length: 0 - 1024
*
* @return The default value to use if the source attribute is not specified in a
* document. Optional.
*/
public String getDefaultValue() {
return defaultValue;
}
/**
* The default value to use if the source attribute is not specified in a
* document. Optional.
*
* Constraints:
* Length: 0 - 1024
*
* @param defaultValue The default value to use if the source attribute is not specified in a
* document. Optional.
*/
public void setDefaultValue(String defaultValue) {
this.defaultValue = defaultValue;
}
/**
* The default value to use if the source attribute is not specified in a
* document. Optional.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 1024
*
* @param defaultValue The default value to use if the source attribute is not specified in a
* document. Optional.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public SourceDataMap withDefaultValue(String defaultValue) {
this.defaultValue = defaultValue;
return this;
}
/**
* A map that translates source field values to custom values.
*
* @return A map that translates source field values to custom values.
*/
public java.util.Map getCases() {
if (cases == null) {
cases = new java.util.HashMap();
}
return cases;
}
/**
* A map that translates source field values to custom values.
*
* @param cases A map that translates source field values to custom values.
*/
public void setCases(java.util.Map cases) {
this.cases = cases;
}
/**
* A map that translates source field values to custom values.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param cases A map that translates source field values to custom values.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public SourceDataMap withCases(java.util.Map cases) {
setCases(cases);
return this;
}
/**
* A map that translates source field values to custom values.
*
* The method adds a new key-value pair into Cases parameter, and returns
* a reference to this object so that method calls can be chained
* together.
*
* @param key The key of the entry to be added into Cases.
* @param value The corresponding value of the entry to be added into Cases.
*/
public SourceDataMap addCasesEntry(String key, String value) {
if (null == this.cases) {
this.cases = new java.util.HashMap();
}
if (this.cases.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.cases.put(key, value);
return this;
}
/**
* Removes all the entries added into Cases.
*
* Returns a reference to this object so that method calls can be chained together.
*/
public SourceDataMap clearCasesEntries() {
this.cases = null;
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 (getSourceName() != null) sb.append("SourceName: " + getSourceName() + ",");
if (getDefaultValue() != null) sb.append("DefaultValue: " + getDefaultValue() + ",");
if (getCases() != null) sb.append("Cases: " + getCases() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSourceName() == null) ? 0 : getSourceName().hashCode());
hashCode = prime * hashCode + ((getDefaultValue() == null) ? 0 : getDefaultValue().hashCode());
hashCode = prime * hashCode + ((getCases() == null) ? 0 : getCases().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof SourceDataMap == false) return false;
SourceDataMap other = (SourceDataMap)obj;
if (other.getSourceName() == null ^ this.getSourceName() == null) return false;
if (other.getSourceName() != null && other.getSourceName().equals(this.getSourceName()) == false) return false;
if (other.getDefaultValue() == null ^ this.getDefaultValue() == null) return false;
if (other.getDefaultValue() != null && other.getDefaultValue().equals(this.getDefaultValue()) == false) return false;
if (other.getCases() == null ^ this.getCases() == null) return false;
if (other.getCases() != null && other.getCases().equals(this.getCases()) == false) return false;
return true;
}
}