Java tutorial
/** * The software subject to this notice and license includes both human readable * source code form and machine readable, binary, object code form. The NCI OCR * Software was developed in conjunction with the National Cancer Institute * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent * government employees are authors, any rights in such works shall be subject * to Title 17 of the United States Code, section 105. * * This NCI OCR Software License (the License) is between NCI and You. You (or * Your) shall mean a person or an entity, and all other entities that control, * are controlled by, or are under common control with the entity. Control for * purposes of this definition means (i) the direct or indirect power to cause * the direction or management of such entity, whether by contract or otherwise, * or (ii) ownership of fifty percent (50%) or more of the outstanding shares, * or (iii) beneficial ownership of such entity. * * This License is granted provided that You agree to the conditions described * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up, * no-charge, irrevocable, transferable and royalty-free right and license in * its rights in the NCI OCR Software to (i) use, install, access, operate, * execute, copy, modify, translate, market, publicly display, publicly perform, * and prepare derivative works of the NCI OCR Software; (ii) distribute and * have distributed to and by third parties the NCI OCR Software and any * modifications and derivative works thereof; and (iii) sublicense the * foregoing rights set out in (i) and (ii) to third parties, including the * right to license such rights to further third parties. For sake of clarity, * and not by way of limitation, NCI shall have no right of accounting or right * of payment from You or Your sub-licensees for the rights granted under this * License. This License is granted at no charge to You. * * Your redistributions of the source code for the Software must retain the * above copyright notice, this list of conditions and the disclaimer and * limitation of liability of Article 6, below. Your redistributions in object * code form must reproduce the above copyright notice, this list of conditions * and the disclaimer of Article 6 in the documentation and/or other materials * provided with the distribution, if any. * * Your end-user documentation included with the redistribution, if any, must * include the following acknowledgment: This product includes software * developed by 5AM and the National Cancer Institute. If You do not include * such end-user documentation, You shall include this acknowledgment in the * Software itself, wherever such third-party acknowledgments normally appear. * * You may not use the names "The National Cancer Institute", "NCI", or "5AM" * to endorse or promote products derived from this Software. This License does * not authorize You to use any trademarks, service marks, trade names, logos or * product names of either NCI or 5AM, except as required to comply with the * terms of this License. * * For sake of clarity, and not by way of limitation, You may incorporate this * Software into Your proprietary programs and into any third party proprietary * programs. However, if You incorporate the Software into third party * proprietary programs, You agree that You are solely responsible for obtaining * any permission from such third parties required to incorporate the Software * into such third party proprietary programs and for informing Your * sub-licensees, including without limitation Your end-users, of their * obligation to secure any required permissions from such third parties before * incorporating the Software into such third party proprietary software * programs. In the event that You fail to obtain such permissions, You agree * to indemnify NCI for any claims against NCI by such third parties, except to * the extent prohibited by law, resulting from Your failure to obtain such * permissions. * * For sake of clarity, and not by way of limitation, You may add Your own * copyright statement to Your modifications and to the derivative works, and * You may provide additional or different license terms and conditions in Your * sublicenses of modifications of the Software, or any derivative works of the * Software as a whole, provided Your use, reproduction, and distribution of the * Work otherwise complies with the conditions stated in this License. * * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package gov.nih.nci.firebird.data.user; import gov.nih.nci.firebird.data.InvestigatorProfile; import java.util.ArrayList; import java.util.Collections; import java.util.HashSet; import java.util.Iterator; import java.util.List; import java.util.Set; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.JoinColumn; import javax.persistence.OneToMany; import javax.persistence.OneToOne; import javax.persistence.Transient; import org.hibernate.annotations.Cascade; import org.hibernate.annotations.ForeignKey; import com.fiveamsolutions.nci.commons.audit.Auditable; import com.google.common.base.Predicate; import com.google.common.collect.Iterables; /** * Provides access to a user's registration coordinator functionality and roles (if the user is a registration * coordinator). */ @Entity(name = "registration_coordinator_role") public class RegistrationCoordinatorRole implements Auditable { private static final long serialVersionUID = 1L; private Long id; private FirebirdUser user; private Set<ManagedInvestigator> managedInvestigators = new HashSet<ManagedInvestigator>(); RegistrationCoordinatorRole() { // no-arg constructor required by hibernate } RegistrationCoordinatorRole(FirebirdUser user) { setUser(user); } @Id @GeneratedValue(strategy = GenerationType.AUTO) @Override public Long getId() { return id; } /** * @param id ID */ public void setId(Long id) { this.id = id; } /** * @return the user */ @OneToOne(optional = false) @JoinColumn(name = "firebird_user_id") @ForeignKey(name = "registration_coordinator_role_user_fkey") public FirebirdUser getUser() { return user; } private void setUser(FirebirdUser user) { this.user = user; } /** * @return the managedInvestigators */ @OneToMany @JoinColumn(name = "managed_investigator_id") @ForeignKey(name = "managed_investigator_managed_investigator_fkey") @Cascade({ org.hibernate.annotations.CascadeType.ALL, org.hibernate.annotations.CascadeType.DELETE_ORPHAN }) public Set<ManagedInvestigator> getManagedInvestigators() { return managedInvestigators; } @SuppressWarnings("unused") // setter required by hibernate private void setManagedInvestigators(Set<ManagedInvestigator> managedInvestigators) { this.managedInvestigators = managedInvestigators; } /** * @return all investigator profiles that the user has chosen to request coordination privileges for. */ @Transient public List<InvestigatorProfile> getManagedProfiles() { List<InvestigatorProfile> investigators = new ArrayList<InvestigatorProfile>(); for (ManagedInvestigator managedInvestigator : getManagedInvestigators()) { investigators.add(managedInvestigator.getInvestigatorProfile()); } Collections.sort(investigators, InvestigatorProfile.INVESTIGATOR_NAME_COMPARATOR); return investigators; } /** * Add a new managed investigator to this user using the provided investigator. * * @param profile the investigator's profile to coordinate for. * @return the added managed investigator */ public ManagedInvestigator addManagedInvestigator(InvestigatorProfile profile) { ManagedInvestigator managedInvestigator = new ManagedInvestigator(getUser(), profile); if (managedInvestigators.contains(managedInvestigator)) { throw new IllegalArgumentException("managed investigator already exists"); } managedInvestigator.setStatus(ManagedInvestigatorStatus.AWAITING_APPROVAL); managedInvestigators.add(managedInvestigator); profile.getRegistrationCoordinatorMappings().add(managedInvestigator); return managedInvestigator; } /** * Removes a previously added Managed Investigator for the given profile. * * @param profile the profile that corresponds to the individual managed investigator. */ public void removeManagedInvestigator(InvestigatorProfile profile) { for (Iterator<ManagedInvestigator> iter = getManagedInvestigators().iterator(); iter.hasNext();) { ManagedInvestigator managedInvestigator = iter.next(); InvestigatorProfile investigatorProfile = managedInvestigator.getInvestigatorProfile(); if (investigatorProfile.getId().equals(profile.getId())) { investigatorProfile.getRegistrationCoordinatorMappings().remove(managedInvestigator); iter.remove(); return; } } } /** * @return investigator profiles that may be managed by the current user if the user is a registration coordinator. */ @Transient public List<InvestigatorProfile> getApprovedManagedProfiles() { List<InvestigatorProfile> profiles = new ArrayList<InvestigatorProfile>(); for (ManagedInvestigator managedInvestigator : getManagedInvestigators()) { if (managedInvestigator.isApproved()) { profiles.add(managedInvestigator.getInvestigatorProfile()); } } Collections.sort(profiles, InvestigatorProfile.INVESTIGATOR_NAME_COMPARATOR); return profiles; } /** * Returns whether or not this registration coordinator is approved to manage the given investigator's * registrations. * * @param profile investigator profile to manage * @return whether or not this registration coordinator is approved to manage the given investigator's registrations */ @Transient public boolean isApprovedToManageInvestigatorRegistrations(final InvestigatorProfile profile) { return Iterables.any(getManagedInvestigators(), new Predicate<ManagedInvestigator>() { @Override public boolean apply(ManagedInvestigator managedInvestigator) { return managedInvestigator.getInvestigatorProfile().equals(profile) && managedInvestigator.isApproved() && !managedInvestigator.isSuspendedRegistrationAccess(); } }); } }