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.Date; import java.util.Set; import javax.persistence.CascadeType; import javax.persistence.DiscriminatorValue; import javax.persistence.Entity; import javax.persistence.EnumType; import javax.persistence.Enumerated; import javax.persistence.JoinColumn; import javax.persistence.ManyToOne; import javax.persistence.OneToMany; import javax.persistence.Transient; 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.Cascade; import org.hibernate.annotations.ForeignKey; import org.hibernate.validator.NotNull; import com.google.common.collect.Sets; /** * Certificate. */ @Entity @DiscriminatorValue("CERTIFICATE") public class TrainingCertificate extends AbstractCredential<TrainingCertificate> implements Certificate { private static final long serialVersionUID = 1L; private CertificateType certificateType; private FirebirdFile file; private Set<SubmittedTrainingCertificate> submittedCertificates = Sets.newHashSet(); /** * @param profile owner profile. * @param effectiveDate credential effective date. * @param expirationDate credential expiration date. * @param certType certificate type . * @param file certificate file. */ @SuppressWarnings({ "PMD.ExcessiveParameterList", "ucd" }) // convenience constructor used in tests public TrainingCertificate(InvestigatorProfile profile, Date effectiveDate, Date expirationDate, CertificateType certType, FirebirdFile file) { super(profile, effectiveDate, expirationDate, null); this.certificateType = certType; this.file = file; } /** * default ctor. */ public TrainingCertificate() { // no-op } /** * @return {@link CredentialType#CERTIFICATE} */ @Transient @Override public CredentialType getType() { return CredentialType.CERTIFICATE; } @Enumerated(EnumType.STRING) @NotNull @Override public CertificateType getCertificateType() { return certificateType; } /** * @param certType certificate type */ public void setCertificateType(CertificateType certType) { this.certificateType = certType; } @ManyToOne(cascade = { CascadeType.PERSIST, CascadeType.MERGE, CascadeType.REFRESH }) @Cascade(org.hibernate.annotations.CascadeType.SAVE_UPDATE) @JoinColumn(name = "file_id") @ForeignKey(name = "certificate_firebird_file_fkey") @NotNull @Override public FirebirdFile getFile() { return file; } /** * @return the set of submitted certificates. */ @OneToMany(mappedBy = "originalCertificate") public Set<SubmittedTrainingCertificate> getSubmittedCertificates() { return submittedCertificates; } @SuppressWarnings({ "PMD.UnusedPrivateMethod", "unused" }) private void setSubmittedCertificates(Set<SubmittedTrainingCertificate> submittedCertificates) { this.submittedCertificates = submittedCertificates; } /** * @param file certificate file. */ public void setFile(FirebirdFile file) { this.file = file; } /** * Nullifies all Immutable Certificate references to this Certificate. */ public void unLinkSubmittedCertificates() { for (SubmittedTrainingCertificate submittedCertificate : getSubmittedCertificates()) { submittedCertificate.removeLinkToOrginalCertificate(); } getSubmittedCertificates().clear(); } @Override public boolean equals(Object obj) { if (!(obj instanceof TrainingCertificate)) { return false; } if (this == obj) { return true; } TrainingCertificate cred = (TrainingCertificate) obj; return new EqualsBuilder().appendSuper(super.equals(obj)) .append(getFile().getName(), cred.getFile().getName()) .append(getCertificateType(), cred.getCertificateType()).isEquals(); } @Override public int hashCode() { return new HashCodeBuilder().appendSuper(super.hashCode()).append(getCertificateType()).toHashCode(); } @Override public int compareTo(TrainingCertificate o) { return new CompareToBuilder().append(getCertificateType(), o.getCertificateType()) .append(getFile().getName(), o.getFile().getName()).append(getEffectiveDate(), o.getEffectiveDate()) .append(getExpirationDate(), o.getExpirationDate()).append(getIssuer(), o.getIssuer()) .toComparison(); } @Override public TrainingCertificateSnapshot createSnapshot() { TrainingCertificateSnapshot snapshot = new TrainingCertificateSnapshot(); copyCommonData(snapshot); snapshot.setCertificateType(getCertificateType()); snapshot.setFile(getFile()); return snapshot; } }