gov.nih.nci.cabig.caaers.domain.AbstractIdentifiableDomainObject.java Source code

Introduction

Here is the source code for gov.nih.nci.cabig.caaers.domain.AbstractIdentifiableDomainObject.java

Source

/*******************************************************************************
 * Copyright SemanticBits, Northwestern University and Akaza Research
 * 
 * Distributed under the OSI-approved BSD 3-Clause License.
 * See http://ncip.github.com/caaers/LICENSE.txt for details.
 ******************************************************************************/
package gov.nih.nci.cabig.caaers.domain;

import gov.nih.nci.cabig.ctms.domain.AbstractMutableDomainObject;

import java.util.ArrayList;
import java.util.List;

import javax.persistence.MappedSuperclass;
import javax.persistence.Transient;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Subclass of.
 *
 * {@link AbstractMutableDomainObject> that implements {@link gov.nih.nci.cabig.caaers.domain.IdentifiableByAssignedIdentifers}.
 * @author Rhett Sutphin
 */
@MappedSuperclass
public abstract class AbstractIdentifiableDomainObject extends AbstractMutableDomainObject
        implements IdentifiableByAssignedIdentifers {

    /** The Constant log. */
    private static final Log log = LogFactory.getLog(AbstractIdentifiableDomainObject.class);

    /** The identifiers. */
    private List<Identifier> identifiers = new ArrayList<Identifier>();

    /** The primary identifier value. */
    private String primaryIdentifierValue;

    // //// LOGIC

    /* (non-Javadoc)
     * @see gov.nih.nci.cabig.caaers.domain.IdentifiableByAssignedIdentifers#getPrimaryIdentifier()
     */
    @Transient
    public Identifier getPrimaryIdentifier() {
        if (log.isDebugEnabled()) {
            log.debug("Searching for primary identifier in " + getIdentifiers());
        }
        for (Identifier identifier : getIdentifiers()) {
            if (identifier.isPrimary()) {
                return identifier;
            }
        }
        // TODO: this should probably be fatal (i.e., it should be validated at entry time)
        log.warn(getClass().getName() + '#' + getId() + " does not have a primary identifier");
        return null;
    }

    /*
     * Used as a property that survive Reduction
     * 
     * @See CreateAdverseEventAjaxFacade #matchParticipants, matchStudies
     */
    /**
     * Sets the primary identifier value.
     *
     * @param primaryIdentifierValue the new primary identifier value
     */
    @Transient
    public void setPrimaryIdentifierValue(String primaryIdentifierValue) {
        this.primaryIdentifierValue = primaryIdentifierValue;
    }

    /*
     * Used as a property that survive Reduction
     * 
     * @See CreateAdverseEventAjaxFacade #matchParticipants, matchStudies
     */
    /**
     * Gets the primary identifier value.
     *
     * @return the primary identifier value
     */
    @Transient
    public String getPrimaryIdentifierValue() {
        if (this.primaryIdentifierValue == null) {
            Identifier identifier = getPrimaryIdentifier();
            if (identifier != null) {
                setPrimaryIdentifierValue(identifier.getValue());
            }
        }
        return this.primaryIdentifierValue;
    }

    /* (non-Javadoc)
     * @see gov.nih.nci.cabig.caaers.domain.IdentifiableByAssignedIdentifers#getSecondaryIdentifiers()
     */
    @Transient
    public List<Identifier> getSecondaryIdentifiers() {
        Identifier primary = getPrimaryIdentifier();
        List<Identifier> others = new ArrayList<Identifier>(getIdentifiers());
        others.remove(primary);
        return others;
    }

    /**
     * Adds the identifier.
     *
     * @param newIdentifier the new identifier
     */
    public void addIdentifier(final Identifier newIdentifier) {
        getIdentifiers().add(newIdentifier);
    }

    // //// BEAN PROPERTIES

    /**
     * Subclasses will need to override this method to attach an appropriate JoinColumn annotation.
     *
     * @return the identifiers
     */
    @Transient
    public List<Identifier> getIdentifiers() {
        return identifiers;
    }

    /* (non-Javadoc)
     * @see gov.nih.nci.cabig.caaers.domain.IdentifiableByAssignedIdentifers#setIdentifiers(java.util.List)
     */
    public void setIdentifiers(final List<Identifier> identifiers) {
        this.identifiers = identifiers;
    }

    /*
    * This is common for participant and study , make the first instance of primary indicators hold
    * and set the rest to false
    *
    */
    /**
     * First primary indicator in identifiers.
     */
    @Transient
    public void firstPrimaryIndicatorInIdentifiers() {

        boolean isPrimaryIndicatorAvailable = Boolean.FALSE;
        for (Identifier identifier : getIdentifiers()) {
            if (identifier.getPrimaryIndicator() && !isPrimaryIndicatorAvailable) {
                isPrimaryIndicatorAvailable = Boolean.TRUE;
            } else {
                identifier.setPrimaryIndicator(Boolean.FALSE);
            }

        }
    }
}