com.greenpepper.server.domain.Requirement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of greenpepper-remote-agent Show documentation
The newest version!
package com.greenpepper.server.domain;

import java.util.HashSet;
import java.util.Set;

import javax.persistence.CascadeType;
import javax.persistence.Entity;
import javax.persistence.OneToMany;
import javax.persistence.Table;
import javax.persistence.Transient;
import javax.persistence.UniqueConstraint;

import com.greenpepper.server.GreenPepperServerErrorKey;
import com.greenpepper.server.GreenPepperServerException;

/**
 * Requirement Class.
 * 
 * Copyright (c) 2006 Pyxis technologies inc. All Rights Reserved.
 *
 * @author JCHUET
 * @version $Id: $Id
 */

@Entity
@Table(name="REQUIREMENT", uniqueConstraints = {@UniqueConstraint(columnNames={"NAME", "REPOSITORY_ID"})})
@SuppressWarnings("serial")
public class Requirement extends Document
{
    protected Set references = new HashSet();
    
    /**
     * 
newInstance.
     *
     * @param name a {@link java.lang.String} object.
     * @return a {@link com.greenpepper.server.domain.Requirement} object.
     */
    public static Requirement newInstance(String name)
    {
        Requirement requirement = new Requirement();
        requirement.setName(name);
        return requirement;
    }

    /**
     * Getter for the field references.
     *
     * @return a {@link java.util.Set} object.
     */
    @OneToMany(mappedBy="requirement", cascade=CascadeType.ALL)
    public Set getReferences()
    {
        return references;
    }

    /**
     * Setter for the field references.
     *
     * @param references a {@link java.util.Set} object.
     */
    public void setReferences(Set references)
    {
        this.references = references;
    }

    /**
     * removeReference.
     *
     * @param reference a {@link com.greenpepper.server.domain.Reference} object.
     * @throws com.greenpepper.server.GreenPepperServerException if any.
     */
    public void removeReference(Reference reference) throws GreenPepperServerException
    {
        if(!references.contains(reference))
        {
            throw new GreenPepperServerException( GreenPepperServerErrorKey.REFERENCE_NOT_FOUND, "Reference not found");
        }

        references.remove(reference);
        reference.setRequirement(null);
    }
    
    /**
     * getSummary.
     *
     * @return a {@link com.greenpepper.server.domain.RequirementSummary} object.
     */
    @Transient
    public RequirementSummary getSummary()
    {
        RequirementSummary summary = new RequirementSummary();
        for(Reference ref : references)
        {
            if(ref.getLastExecution() != null)
            {
                summary.addErrors(ref.getLastExecution().getErrors());
                summary.addException(ref.getLastExecution().hasException());
                summary.addFailures(ref.getLastExecution().getFailures());
                summary.addSuccess(ref.getLastExecution().getSuccess());
                summary.addErrors(ref.getLastExecution().getErrors());
            }
        }
        
        summary.setReferencesSize(references.size());
        return summary;
    }

    /** {@inheritDoc} */
    public boolean equals(Object o)
    {
        if (super.equals(o))
        {
            return o instanceof Requirement;
        }

        return false;
    }
}