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; import java.util.EnumMap; import java.util.Map; import javax.persistence.CascadeType; import javax.persistence.Entity; import javax.persistence.FetchType; import javax.persistence.JoinColumn; import javax.persistence.MapKey; import javax.persistence.OneToMany; import javax.persistence.OneToOne; import javax.persistence.Transient; import org.apache.commons.lang.builder.CompareToBuilder; import org.apache.commons.lang3.builder.EqualsBuilder; import org.apache.commons.lang3.builder.HashCodeBuilder; import org.hibernate.annotations.ForeignKey; import com.fiveamsolutions.nci.commons.audit.Auditable; /** * Class that represents the local cache of the NES Organization service Organization object. */ @Entity(name = "organization") @SuppressWarnings("unused") // private get/setters required by Hibernate public class Organization extends AbstractOrganizationData implements Auditable, Comparable<Organization> { private static final long serialVersionUID = 1L; private Map<OrganizationRoleType, AbstractOrganizationRole> roles = new EnumMap<OrganizationRoleType, AbstractOrganizationRole>( OrganizationRoleType.class); private AbstractExternalData externalData; /** * Returns the map of roles for this organization. * * @return the roles. */ @OneToMany(mappedBy = "organization", cascade = CascadeType.ALL, fetch = FetchType.EAGER) @MapKey(name = "roleType") public Map<OrganizationRoleType, AbstractOrganizationRole> getRoles() { return roles; } private void setRoles(Map<OrganizationRoleType, AbstractOrganizationRole> roles) { this.roles = roles; } /** * Adds a new role to this organization. * * @param role the new role. */ public void addRole(AbstractOrganizationRole role) { if (getRoles().containsKey(role.getRoleType())) { throw new IllegalArgumentException( "Organization already contains a role of type " + role.getRoleType()); } role.setOrganization(this); getRoles().put(role.getRoleType(), role); } /** * Adds a new role to this organization. * * @param type the type of the new role * @return the new role. */ public AbstractOrganizationRole createRole(OrganizationRoleType type) { AbstractOrganizationRole role; switch (type) { case CLINICAL_LABORATORY: role = new ClinicalLaboratory(); break; case IRB: role = new InstitutionalReviewBoard(); break; case PRACTICE_SITE: role = new PracticeSite(); break; default: throw new IllegalArgumentException("Unsupported type: " + type); } addRole(role); return role; } /** * Gets the role corresponding to the type given. * * @param type get role for this type. * @return the role or null if none exists. */ public AbstractOrganizationRole getRole(OrganizationRoleType type) { return getRoles().get(type); } @Override public int compareTo(Organization t) { return new CompareToBuilder().append(getName(), t.getName()) .append(getPostalAddress(), t.getPostalAddress()).toComparison(); } @Override public boolean equals(Object other) { if (!(other instanceof Organization)) { return false; } Organization otherOrganization = (Organization) other; return new EqualsBuilder().append(getId(), otherOrganization.getId()) .append(getName(), otherOrganization.getName()).append(getEmail(), otherOrganization.getEmail()) .append(getPhoneNumber(), otherOrganization.getPhoneNumber()) .append(getPostalAddress(), otherOrganization.getPostalAddress()).isEquals(); } @Override public int hashCode() { return new HashCodeBuilder().append(getId()).append(getName()).append(getEmail()).append(getPhoneNumber()) .append(getPostalAddress()).toHashCode(); } @OneToOne(cascade = CascadeType.ALL) @JoinColumn(name = "external_data_id") @ForeignKey(name = "organization_external_data_fkey") public AbstractExternalData getExternalData() { return externalData; } public void setExternalData(AbstractExternalData externalData) { this.externalData = externalData; } @Transient public String getExternalId() { return getExternalData() != null ? getExternalData().getExternalId() : null; } /** * @return whether the organization has a record in the external service. */ public boolean hasExternalRecord() { return getExternalData() != null; } /** * @return a snapshot copy of the Organization's data. */ OrganizationSnapshot createSnapshot() { OrganizationSnapshot snapshot = new OrganizationSnapshot(); snapshot.setCtepId(getCtepId()); snapshot.setEmail(getEmail()); snapshot.setName(getName()); snapshot.setExternalId(getExternalId()); snapshot.setPhoneNumber(getPhoneNumber()); snapshot.setCurationStatus(getCurationStatus()); snapshot.setPostalAddress(getPostalAddress()); return snapshot; } }