DigitalObject.java

/*******************************************************************************
 * Copyright 2006 - 2014 Vienna University of Technology,  
 * Department of Software Technology and Interactive Systems, IFS
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This work originates from the Planets project, co-funded by the European Union under the Sixth Framework Programme.
 ******************************************************************************/
package eu.scape_project.planning.model;

import java.io.Serializable;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.DiscriminatorColumn;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Inheritance;
import javax.persistence.OneToOne;
import javax.validation.constraints.Pattern;

import org.hibernate.validator.constraints.Length;

/**
 * This class represents a file, or more generally a digital object, that has
 * been uploaded by the user and shall be stored in the database.
 * 
 * @author Hannes Kulovits
 */
@Entity
@Inheritance
@DiscriminatorColumn(name = "type")
@DiscriminatorValue("DO")
public class DigitalObject implements Serializable, ITouchable {

    private static final long serialVersionUID = -163440832511570828L;

    @Id
    @GeneratedValue
    protected int id;

    /**
     * This is the persistent identifier of the object, it is compliant with the
     * syntax of Fedora persistent identifiers {@link https
     * ://wiki.duraspace.org/display/FEDORA35/Fedora+Identifiers}
     */
    @Pattern(regexp = "^([A-Za-z0-9]|-|\\.)+:(([A-Za-z0-9])|-|\\.|~|_|(%[0-9A-F]{2}))+$")
    protected String pid;

    /**
     * Name of the object.
     */
    protected String fullname = "";

    /**
     * In most cases this is the mime-type of the object.
     */
    protected String contentType = "";

    @OneToOne(cascade = CascadeType.ALL)
    protected ChangeLog changeLog = new ChangeLog();

    @OneToOne(cascade = CascadeType.ALL)
    protected ByteStream data = new ByteStream();

    @Length(max = 2000000)
    @Column(length = 2000000)
    protected String jhoveXMLString;

    @Length(max = 2000000)
    @Column(length = 2000000)
    protected String fitsXMLString;

    @OneToOne(cascade = CascadeType.ALL)
    protected XcdlDescription xcdlDescription = null;

    /**
     * Detailed information about the sample record's format.
     */
    @OneToOne(cascade = CascadeType.ALL)
    protected FormatInfo formatInfo = new FormatInfo();

    /**
     * Method responsible for indicating if the DigitalObject contains data.
     * 
     * @return true if the upload contains data
     */
    public boolean isDataExistent() {
        // pid indicates associated data
        if (pid != null && !pid.equals("")) {
            return true;
        }

        // if no pid is set check the bytestream directly.
        return data.isDataExistent();
    }

    /**
     * Assigns relevant values from the provided {@code source} to this object.
     * 
     * @param source
     *            the source of the values
     */
    public void assignValues(DigitalObject source) {
        contentType = source.getContentType();
        fullname = source.getFullname();
        data = source.getData().clone();
        pid = source.getPid();
        fitsXMLString = source.getFitsXMLString();
        formatInfo.assignValues(source.getFormatInfo());
        jhoveXMLString = source.getJhoveXMLString();
        xcdlDescription = source.getXcdlDescription();
    }

    /**
     * Creates a copy of this object assigning relevant values.
     * 
     * @return a copy of this object
     * 
     * @see assignValues(DigitalObject)
     */
    @Override
    public DigitalObject clone() {
        DigitalObject u = new DigitalObject();
        u.assignValues(this);
        return u;
    }

    /**
     * @see ITouchable#isChanged()
     */
    @Override
    public boolean isChanged() {
        return changeLog.isAltered();
    }

    /**
     * @see ITouchable#touch()
     */
    @Override
    public void touch() {
        changeLog.touch();
    }

    /**
     * @see ITouchable#handleChanges(IChangesHandler)
     */
    @Override
    public void handleChanges(IChangesHandler h) {
        h.visit(this);
        formatInfo.handleChanges(h);
        if (xcdlDescription != null) {
            xcdlDescription.handleChanges(h);
        }
    }

    /**
     * Checks only the ID, if it exists, otherwise checks object identity.
     */
    @Override
    public boolean equals(Object o) {
        if (o == this) {
            return true;
        }

        if (o instanceof DigitalObject) {
            int id2 = ((DigitalObject) o).getId();
            return ((id != 0) && (id == id2));
        }

        return false;
    }

    @Override
    public int hashCode() {
        return new Long(id).hashCode();
    }

    /**
     * Returns the size of this object in mebibyte.
     * 
     * @return the size in MB
     */
    public double getSizeInMB() {
        return (Math.round(getSizeInBytes() / (1024.0d * 1024.0d / 100.0d)) / 100.0d);
    }

    /**
     * Sets the size of this object in bytes.
     * 
     * @param sizeInBytes
     *            the size in bytes
     */
    public void setSizeInBytes(final long sizeInBytes) {
        this.data.setSize(sizeInBytes);
    }

    /**
     * Returns the size of this objects data in bytes.
     * 
     * @return the size in bytes
     */
    public long getSizeInBytes() {
        return data.getSize();
    }

    // ---------- getter/setter ----------

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getPid() {
        return pid;
    }

    public void setPid(String pid) {
        this.pid = pid;
    }

    public String getFullname() {
        return fullname;
    }

    public void setFullname(String fullname) {
        this.fullname = fullname;
    }

    public String getContentType() {
        return contentType;
    }

    public void setContentType(String contentType) {
        this.contentType = contentType;
    }

    public ChangeLog getChangeLog() {
        return changeLog;
    }

    public void setChangeLog(ChangeLog value) {
        changeLog = value;
    }

    public ByteStream getData() {
        return data;
    }

    public void setData(ByteStream data) {
        this.data = data;
    }

    public String getJhoveXMLString() {
        return jhoveXMLString;
    }

    public void setJhoveXMLString(String jhoveXMLString) {
        this.jhoveXMLString = jhoveXMLString;
    }

    public String getFitsXMLString() {
        return fitsXMLString;
    }

    public void setFitsXMLString(String fitsXMLString) {
        this.fitsXMLString = fitsXMLString;
    }

    public XcdlDescription getXcdlDescription() {
        return xcdlDescription;
    }

    public void setXcdlDescription(XcdlDescription xcdlDescription) {
        this.xcdlDescription = xcdlDescription;
    }

    public FormatInfo getFormatInfo() {
        return formatInfo;
    }

    public void setFormatInfo(FormatInfo value) {
        formatInfo = value;
    }

}