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 javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.FetchType; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.JoinColumn; import javax.persistence.ManyToOne; import org.hibernate.annotations.Cascade; import org.hibernate.annotations.CascadeType; import org.hibernate.annotations.ForeignKey; import org.hibernate.validator.Length; import org.hibernate.validator.NotEmpty; import org.hibernate.validator.NotNull; import com.fiveamsolutions.nci.commons.audit.Auditable; /** * File data. */ @Entity(name = "firebird_file") public class FirebirdFile implements Auditable, Cloneable { /** * length of the file description field. */ public static final int DESCRIPTION_LENGTH = 1024; private static final long serialVersionUID = 1L; private Long id; private static final int LENGTH = 254; private AbstractByteDataSource byteDataSource; private String name; private String contentType; private String description; private Date uploadDate = new Date(); private int length; /** * Default constructor. */ public FirebirdFile() { // do nothing } /** * Constructor. * @param data the gzip compressed data * @param uncompressedLength length of data before gzip compression * @param fileName the file name * @param contentType the content type * @param description file description * * PMD.ArrayIsStoredDirectly for the byte[] that will be the content of the {@link LobHolder} */ @SuppressWarnings("PMD.ArrayIsStoredDirectly") public FirebirdFile(byte[] data, int uncompressedLength, String fileName, String contentType, String description) { this.byteDataSource = new LobHolder(data); this.name = fileName; this.contentType = contentType; this.length = uncompressedLength; this.description = description; } @Id @GeneratedValue(strategy = GenerationType.AUTO) @Override public Long getId() { return id; } /** * @param id db id to set */ public void setId(Long id) { this.id = id; } /** * @return the byteDataSource */ @NotNull @ManyToOne(fetch = FetchType.LAZY) @JoinColumn(name = "byte_data_source_id") @Cascade(value = { CascadeType.ALL, CascadeType.DELETE_ORPHAN }) @ForeignKey(name = "byte_data_source_fkey") public AbstractByteDataSource getByteDataSource() { return byteDataSource; } /** * @param byteDataSource the byteDataSource to set */ public void setByteDataSource(AbstractByteDataSource byteDataSource) { this.byteDataSource = byteDataSource; } /** * @return the name */ @Length(max = LENGTH) @Column(name = "file_name") @NotEmpty public String getName() { return name; } /** * @param name the name to set */ public void setName(String name) { this.name = name; } /** * @return the contentType */ @Length(max = LENGTH) @Column(name = "content_type") @NotEmpty public String getContentType() { return contentType; } /** * @param contentType the contentType to set */ public void setContentType(String contentType) { this.contentType = contentType; } /** * @return uploadDate of creation. */ @Column(name = "upload_date") public Date getUploadDate() { return uploadDate; } /** * @param date date of file upload. */ public void setUploadDate(Date date) { this.uploadDate = date; } /** * @return the length of the (uncompressed) data stream. */ @Column(name = "length") public int getLength() { return length; } @SuppressWarnings({ "unused", "PMD.UnusedPrivateMethod" }) private void setLength(int length) { this.length = length; } /** * @return file description. */ @Length(max = DESCRIPTION_LENGTH) @Column(length = DESCRIPTION_LENGTH) public String getDescription() { return description; } /** * @param description file description. */ public void setDescription(String description) { this.description = description; } /** * @return a copy without Ids. */ public FirebirdFile createCopy() { FirebirdFile file = new FirebirdFile(null, getLength(), getName(), getContentType(), getDescription()); file.setByteDataSource(new LobHolder(getByteDataSource().getData())); return file; } }