com.amazonaws.services.cloudsearchv2.model.Expression 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;
/**
*
* A named expression that can be evaluated at search time. Can be used
* for sorting and filtering search results and constructing other
* expressions.
*
*/
public class Expression 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 expressionName;
/**
* The expression to evaluate for sorting while processing a search
* request. The Expression syntax is based on JavaScript
* expressions. For more information, see Configuring Expressions in the Amazon
* CloudSearch Developer Guide.
*
* Constraints:
* Length: 1 - 10240
*/
private String expressionValue;
/**
* 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 getExpressionName() {
return expressionName;
}
/**
* 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 expressionName 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 setExpressionName(String expressionName) {
this.expressionName = expressionName;
}
/**
* 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 expressionName 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 Expression withExpressionName(String expressionName) {
this.expressionName = expressionName;
return this;
}
/**
* The expression to evaluate for sorting while processing a search
* request. The Expression syntax is based on JavaScript
* expressions. For more information, see Configuring Expressions in the Amazon
* CloudSearch Developer Guide.
*
* Constraints:
* Length: 1 - 10240
*
* @return The expression to evaluate for sorting while processing a search
* request. The Expression syntax is based on JavaScript
* expressions. For more information, see Configuring Expressions in the Amazon
* CloudSearch Developer Guide.
*/
public String getExpressionValue() {
return expressionValue;
}
/**
* The expression to evaluate for sorting while processing a search
* request. The Expression syntax is based on JavaScript
* expressions. For more information, see Configuring Expressions in the Amazon
* CloudSearch Developer Guide.
*
* Constraints:
* Length: 1 - 10240
*
* @param expressionValue The expression to evaluate for sorting while processing a search
* request. The Expression syntax is based on JavaScript
* expressions. For more information, see Configuring Expressions in the Amazon
* CloudSearch Developer Guide.
*/
public void setExpressionValue(String expressionValue) {
this.expressionValue = expressionValue;
}
/**
* The expression to evaluate for sorting while processing a search
* request. The Expression syntax is based on JavaScript
* expressions. For more information, see Configuring Expressions in the Amazon
* CloudSearch Developer Guide.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 10240
*
* @param expressionValue The expression to evaluate for sorting while processing a search
* request. The Expression syntax is based on JavaScript
* expressions. For more information, see Configuring Expressions in the Amazon
* CloudSearch Developer Guide.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public Expression withExpressionValue(String expressionValue) {
this.expressionValue = expressionValue;
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 (getExpressionName() != null) sb.append("ExpressionName: " + getExpressionName() + ",");
if (getExpressionValue() != null) sb.append("ExpressionValue: " + getExpressionValue() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getExpressionName() == null) ? 0 : getExpressionName().hashCode());
hashCode = prime * hashCode + ((getExpressionValue() == null) ? 0 : getExpressionValue().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof Expression == false) return false;
Expression other = (Expression)obj;
if (other.getExpressionName() == null ^ this.getExpressionName() == null) return false;
if (other.getExpressionName() != null && other.getExpressionName().equals(this.getExpressionName()) == false) return false;
if (other.getExpressionValue() == null ^ this.getExpressionValue() == null) return false;
if (other.getExpressionValue() != null && other.getExpressionValue().equals(this.getExpressionValue()) == false) return false;
return true;
}
}