org.dspace.versioning.VersionHistory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
There is a newer version: 8.0
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.versioning;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
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.OneToMany;
import javax.persistence.OrderBy;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;

import org.apache.commons.collections4.CollectionUtils;
import org.dspace.core.Context;
import org.dspace.core.ReloadableEntity;
import org.hibernate.proxy.HibernateProxyHelper;


/**
 * @author Fabio Bolognesi (fabio at atmire dot com)
 * @author Mark Diggory (markd at atmire dot com)
 * @author Ben Bosman (ben at atmire dot com)
 * @author Pascal-Nicolas Becker (dspace at pascal dash becker dot de)
 */
@Entity
@Table(name = "versionhistory")
public class VersionHistory implements ReloadableEntity {

    @Id
    @Column(name = "versionhistory_id")
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "versionhistory_seq")
    @SequenceGenerator(name = "versionhistory_seq", sequenceName = "versionhistory_seq", allocationSize = 1)
    private Integer id;

    //We use fetchtype eager for versions since we always require our versions when loading the history
    @OneToMany(fetch = FetchType.EAGER, mappedBy = "versionHistory")
    @OrderBy(value = "versionNumber desc")
    private List versions = new ArrayList();

    /**
     * Protected constructor, create object using:
     * {@link org.dspace.versioning.service.VersionHistoryService#create(Context)}
     */
    protected VersionHistory() {

    }

    @Override
    public Integer getID() {
        return id;
    }

    /**
     * Please use
     * {@link org.dspace.versioning.service.VersioningService#getVersionsByHistory(Context, VersionHistory)} instead.
     *
     * To keep version number stables we keep information about deleted Versions.
     * {@code org.dspace.versioning.service.VersioningService#getVersionsByHistory(Context, VersionHistory)
     * VersioningService#getVersionsByHistory} filters
     * such versions and returns only active versions.
     *
     * @return list of versions
     */
    protected List getVersions() {
        return versions;
    }

    void setVersions(List versions) {
        this.versions = versions;
    }

    void addVersionAtStart(Version version) {
        this.versions.add(0, version);
    }

    void removeVersion(Version version) {
        this.versions.remove(version);
    }

    /**
     * Verify if there is a version's item in submission.
     * 
     * @return true if the last version in submission, otherwise false.
     */
    public boolean hasDraftVersion() {
        if (CollectionUtils.isNotEmpty(versions) && Objects.nonNull(versions.get(0).getItem())) {
            return !versions.get(0).getItem().isArchived();
        }
        return false;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        Class objClass = HibernateProxyHelper.getClassWithoutInitializingProxy(o);
        if (!getClass().equals(objClass)) {
            return false;
        }

        final VersionHistory that = (VersionHistory) o;
        return this.getID().equals(that.getID());
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 79 * hash + this.getID();
        return hash;
    }

}