ProductContent.java

/**
 * Copyright (c) 2009 - 2012 Red Hat, Inc.
 *
 * This software is licensed to you under the GNU General Public License,
 * version 2 (GPLv2). There is NO WARRANTY for this software, express or
 * implied, including the implied warranties of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv2
 * along with this software; if not, see
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 * Red Hat trademarks are not licensed under GPLv2. No permission is
 * granted to use or replicate Red Hat trademarks that are incorporated
 * in this software or its documentation.
 */
package org.candlepin.model;

import org.candlepin.model.dto.ProductContentData;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

import org.hibernate.annotations.Parent;

import java.io.Serializable;

import javax.persistence.Embeddable;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.validation.constraints.NotNull;
import javax.xml.bind.annotation.XmlTransient;



/**
 * ProductContent
 */
@Embeddable
public class ProductContent extends AbstractHibernateObject {
    /** Name of the table backing this object in the database */
    public static final String DB_TABLE = "cp2_product_content";

    @Parent
    @NotNull
    private Product product;

    @ManyToOne
    @JoinColumn(name = "content_uuid", nullable = false)
    @NotNull
    private Content content;

    private boolean enabled;

    public ProductContent() {
        // Intentionally left empty
    }

    public ProductContent(Product product, Content content, boolean enabled) {
        this.setContent(content);
        this.setProduct(product);
        this.setEnabled(enabled);
    }

    @Override
    @XmlTransient
    public Serializable getId() {
        return null; // return new ProductContentKey(this.productUuid, this.contentUuid);
    }

    /**
     * @param content the content to set
     */
    public void setContent(Content content) {
        this.content = content;
    }

    /**
     * @return the content
     */
    public Content getContent() {
        return content;
    }

    /**
     * @param product the product to set
     */
    public void setProduct(Product product) {
        this.product = product;
    }

    /**
     * @return the product
     */
    @XmlTransient
    public Product getProduct() {
        return product;
    }

    /**
     * @param enabled the enabled to set
     */
    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    /**
     * @return the enabled
     */
    public boolean isEnabled() {
        return enabled;
    }

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

        if (obj instanceof ProductContent) {
            ProductContent that = (ProductContent) obj;

            // Impl note:
            // Product is not included in this calculation because it only exists in this object to
            // properly map products to content -- it should not be used for comparing two
            // instances.

            return new EqualsBuilder()
                .append(this.content, that.content)
                .append(this.enabled, that.enabled)
                .isEquals();
        }

        return false;
    }

    @Override
    public int hashCode() {
        // Impl note:
        // Product is not included in this calculation because it only exists in this object to
        // properly map products to content -- it should not be used for comparing two
        // instances.

        return new HashCodeBuilder(3, 23)
            .append(this.content)
            .append(this.enabled)
            .toHashCode();
    }

    /**
     * Calculates and returns a version hash for this entity. This method operates much like the
     * hashCode method, except that it is more accurate and should have fewer collisions.
     *
     * @return
     *  a version hash for this entity
     */
    public int getEntityVersion() {
        int hash = 17;

        hash = 7 * hash + (this.content != null ? this.content.getEntityVersion() : 0);
        hash = 7 * hash + (this.enabled ? 1 : 0);

        return hash;
    }

    /**
     * Determines whether or not this entity would be changed if the given DTO were applied to this
     * object.
     *
     * @param dto
     *  The product content DTO to check for changes
     *
     * @throws IllegalArgumentException
     *  if dto is null
     *
     * @return
     *  true if this product content would be changed by the given DTO; false otherwise
     */
    public boolean isChangedBy(ProductContentData dto) {
        if (dto == null) {
            throw new IllegalArgumentException("dto is null");
        }

        if (dto.isEnabled() != null && !dto.isEnabled().equals(this.enabled)) {
            return true;
        }

        if (dto.getContent() != null) {
            if (this.content == null || this.content.isChangedBy(dto.getContent())) {
                return true;
            }
        }

        // Impl note:
        // Product content DTOs do not contain product information

        return false;
    }

    /**
     * Returns a DTO representing this entity.
     *
     * @return
     *  a DTO representing this entity
     */
    public ProductContentData toDTO() {
        return new ProductContentData(this);
    }

    public String toString() {
        return String.format(
            "ProductContent [product = %s, content = %s, enabled = %s]",
            this.getProduct(), this.getContent(), this.isEnabled()
        );
    }
}