/*
 * Copyright 2018-2023 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.entityresolution.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * An object which defines the list of matching rules to run and has a field <code>Rules</code>, which is a list of rule
 * objects.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/RuleBasedProperties"
 *      target="_top">AWS API Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RuleBasedProperties implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel. When
     * choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an attribute type. For
     * example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches,
     * the two profiles are matched on the Email type. When choosing <code>ONE_TO_ONE</code> the system can only match
     * if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the
     * value of the Email field of Profile B matches, the two profiles are matched on the Email type.
     * </p>
     */
    private String attributeMatchingModel;
    /**
     * <p>
     * A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.
     * </p>
     */
    private java.util.List<Rule> rules;

    /**
     * <p>
     * You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel. When
     * choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an attribute type. For
     * example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches,
     * the two profiles are matched on the Email type. When choosing <code>ONE_TO_ONE</code> the system can only match
     * if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the
     * value of the Email field of Profile B matches, the two profiles are matched on the Email type.
     * </p>
     * 
     * @param attributeMatchingModel
     *        You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel.
     *        When choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an
     *        attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail
     *        field of Profile B matches, the two profiles are matched on the Email type. When choosing
     *        <code>ONE_TO_ONE</code> the system can only match if the sub-types are exact matches. For example, only
     *        when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the
     *        two profiles are matched on the Email type.
     * @see AttributeMatchingModel
     */

    public void setAttributeMatchingModel(String attributeMatchingModel) {
        this.attributeMatchingModel = attributeMatchingModel;
    }

    /**
     * <p>
     * You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel. When
     * choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an attribute type. For
     * example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches,
     * the two profiles are matched on the Email type. When choosing <code>ONE_TO_ONE</code> the system can only match
     * if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the
     * value of the Email field of Profile B matches, the two profiles are matched on the Email type.
     * </p>
     * 
     * @return You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel.
     *         When choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an
     *         attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail
     *         field of Profile B matches, the two profiles are matched on the Email type. When choosing
     *         <code>ONE_TO_ONE</code> the system can only match if the sub-types are exact matches. For example, only
     *         when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the
     *         two profiles are matched on the Email type.
     * @see AttributeMatchingModel
     */

    public String getAttributeMatchingModel() {
        return this.attributeMatchingModel;
    }

    /**
     * <p>
     * You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel. When
     * choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an attribute type. For
     * example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches,
     * the two profiles are matched on the Email type. When choosing <code>ONE_TO_ONE</code> the system can only match
     * if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the
     * value of the Email field of Profile B matches, the two profiles are matched on the Email type.
     * </p>
     * 
     * @param attributeMatchingModel
     *        You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel.
     *        When choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an
     *        attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail
     *        field of Profile B matches, the two profiles are matched on the Email type. When choosing
     *        <code>ONE_TO_ONE</code> the system can only match if the sub-types are exact matches. For example, only
     *        when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the
     *        two profiles are matched on the Email type.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see AttributeMatchingModel
     */

    public RuleBasedProperties withAttributeMatchingModel(String attributeMatchingModel) {
        setAttributeMatchingModel(attributeMatchingModel);
        return this;
    }

    /**
     * <p>
     * You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel. When
     * choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an attribute type. For
     * example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches,
     * the two profiles are matched on the Email type. When choosing <code>ONE_TO_ONE</code> the system can only match
     * if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the
     * value of the Email field of Profile B matches, the two profiles are matched on the Email type.
     * </p>
     * 
     * @param attributeMatchingModel
     *        You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel.
     *        When choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an
     *        attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail
     *        field of Profile B matches, the two profiles are matched on the Email type. When choosing
     *        <code>ONE_TO_ONE</code> the system can only match if the sub-types are exact matches. For example, only
     *        when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the
     *        two profiles are matched on the Email type.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see AttributeMatchingModel
     */

    public RuleBasedProperties withAttributeMatchingModel(AttributeMatchingModel attributeMatchingModel) {
        this.attributeMatchingModel = attributeMatchingModel.toString();
        return this;
    }

    /**
     * <p>
     * A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.
     * </p>
     * 
     * @return A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.
     */

    public java.util.List<Rule> getRules() {
        return rules;
    }

    /**
     * <p>
     * A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.
     * </p>
     * 
     * @param rules
     *        A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.
     */

    public void setRules(java.util.Collection<Rule> rules) {
        if (rules == null) {
            this.rules = null;
            return;
        }

        this.rules = new java.util.ArrayList<Rule>(rules);
    }

    /**
     * <p>
     * A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.
     * </p>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setRules(java.util.Collection)} or {@link #withRules(java.util.Collection)} if you want to override the
     * existing values.
     * </p>
     * 
     * @param rules
     *        A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RuleBasedProperties withRules(Rule... rules) {
        if (this.rules == null) {
            setRules(new java.util.ArrayList<Rule>(rules.length));
        }
        for (Rule ele : rules) {
            this.rules.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.
     * </p>
     * 
     * @param rules
     *        A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RuleBasedProperties withRules(java.util.Collection<Rule> rules) {
        setRules(rules);
        return this;
    }

    /**
     * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
     * redacted from this string using a placeholder value.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getAttributeMatchingModel() != null)
            sb.append("AttributeMatchingModel: ").append(getAttributeMatchingModel()).append(",");
        if (getRules() != null)
            sb.append("Rules: ").append(getRules());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof RuleBasedProperties == false)
            return false;
        RuleBasedProperties other = (RuleBasedProperties) obj;
        if (other.getAttributeMatchingModel() == null ^ this.getAttributeMatchingModel() == null)
            return false;
        if (other.getAttributeMatchingModel() != null && other.getAttributeMatchingModel().equals(this.getAttributeMatchingModel()) == false)
            return false;
        if (other.getRules() == null ^ this.getRules() == null)
            return false;
        if (other.getRules() != null && other.getRules().equals(this.getRules()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getAttributeMatchingModel() == null) ? 0 : getAttributeMatchingModel().hashCode());
        hashCode = prime * hashCode + ((getRules() == null) ? 0 : getRules().hashCode());
        return hashCode;
    }

    @Override
    public RuleBasedProperties clone() {
        try {
            return (RuleBasedProperties) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.entityresolution.model.transform.RuleBasedPropertiesMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}