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 gov.nih.nci.firebird.common.FirebirdConstants; import java.util.Date; import javax.persistence.Column; import javax.persistence.DiscriminatorValue; import javax.persistence.Entity; import javax.persistence.JoinColumn; import javax.persistence.ManyToOne; import javax.persistence.Transient; import org.apache.commons.lang.ObjectUtils; import org.apache.commons.lang.builder.CompareToBuilder; import org.apache.commons.lang.builder.EqualsBuilder; import org.apache.commons.lang.builder.HashCodeBuilder; import org.hibernate.annotations.ForeignKey; import org.hibernate.validator.Length; import org.hibernate.validator.NotNull; import com.google.common.base.Joiner; import com.google.common.collect.Lists; /** * Medical License. */ @Entity @DiscriminatorValue("MEDICAL_LICENSE") public class MedicalLicense extends AbstractCredential<MedicalLicense> { private static final long serialVersionUID = 1L; static final int STATE_LENGTH = 2; static final int COUNTRY_LENGTH = 3; private MedicalLicenseType licenseType; private String licenseId; private String state; private String country = FirebirdConstants.US_COUNTRY_CODE; /** * optional ctor. * * @param profile owner profile. * @param expirationDate expiration date * @param licenseId license id. * @param state state * @param country country * @param type the type of the license */ @SuppressWarnings({ "PMD.ExcessiveParameterList", "ucd" }) // convenience constructor used in tests public MedicalLicense(InvestigatorProfile profile, Date expirationDate, String licenseId, String state, String country, MedicalLicenseType type) { super(profile, null, expirationDate, null); this.licenseType = type; this.licenseId = licenseId; this.state = state; this.country = country; } /** * default ctor. */ public MedicalLicense() { // no-op } /** * @return {@link CredentialType#MEDICAL_LICENSE} */ @Transient @Override public CredentialType getType() { return CredentialType.MEDICAL_LICENSE; } /** * @return license id */ @NotNull @Column(name = "license_id") public String getLicenseId() { return licenseId; } /** * @param licenseId license id */ public void setLicenseId(String licenseId) { this.licenseId = licenseId; } /** * @return String in the form format of state, country. If one is null then just the other is returned without the * comma. */ @Transient public String getStateAndCountryString() { return Joiner.on(", ").skipNulls().join(Lists.newArrayList(getState(), getCountry())); } /** * @return state where obtained */ @Length(min = STATE_LENGTH, max = STATE_LENGTH) @Column(length = STATE_LENGTH) public String getState() { return state; } /** * @param state state where obtained. */ public void setState(String state) { this.state = state; } /** * @return 3-letter country code for country where obtained. */ @NotNull @Length(min = COUNTRY_LENGTH, max = COUNTRY_LENGTH) @Column(length = COUNTRY_LENGTH) public String getCountry() { return country; } /** * @param country 3-letter country code for country where obtained */ public void setCountry(String country) { this.country = country; } /** * @return the licenseType */ @ManyToOne @JoinColumn(name = "license_type_id") @ForeignKey(name = "license_licensetype_fkey") @NotNull public MedicalLicenseType getLicenseType() { return licenseType; } /** * @param licenseType the licenseType to set */ public void setLicenseType(MedicalLicenseType licenseType) { this.licenseType = licenseType; } @Override public boolean equals(Object obj) { if (!(obj instanceof MedicalLicense)) { return false; } MedicalLicense incLicense = (MedicalLicense) obj; return new EqualsBuilder().appendSuper(super.equals(obj)).append(licenseType, incLicense.licenseType) .append(state, incLicense.state).append(country, incLicense.country).isEquals(); } @Override public int hashCode() { return new HashCodeBuilder().appendSuper(super.hashCode()).append(licenseType).append(state).append(country) .toHashCode(); } @Override public int compareTo(MedicalLicense o) { return new CompareToBuilder().append(getLicenseType(), o.getLicenseType()).append(country, o.country) .append(state, o.state).toComparison(); } @Override boolean isDuplicateCredential(AbstractCredential<?> credential) { if (credential instanceof MedicalLicense) { MedicalLicense license = (MedicalLicense) credential; return ObjectUtils.equals(getLicenseType(), license.getLicenseType()) && ObjectUtils.equals(getState(), license.getState()) && ObjectUtils.equals(getCountry(), license.getCountry()); } else { return false; } } @Override public MedicalLicenseSnapshot createSnapshot() { MedicalLicenseSnapshot snapshot = new MedicalLicenseSnapshot(); copyCommonData(snapshot); snapshot.setCountry(getCountry()); snapshot.setLicenseId(getLicenseId()); snapshot.setLicenseType(getLicenseType()); snapshot.setState(getState()); return snapshot; } }