Location.java

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is part of dcm4che, an implementation of DICOM(TM) in
 * Java(TM), hosted at https://github.com/gunterze/dcm4che.
 *
 * The Initial Developer of the Original Code is
 * Agfa Healthcare.
 * Portions created by the Initial Developer are Copyright (C) 2011
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * See @authors listed below
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

package org.dcm4chee.archive.entity;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;

import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.PrePersist;
import javax.persistence.Table;

/**
 * @author Damien Evans <damien.daddy@gmail.com>
 * @author Justin Falk <jfalkmu@gmail.com>
 * @author Gunter Zeilinger <gunterze@gmail.com>
 * @author Hermann Czedik-Eysenberg <hermann-agfa@czedik.net>
 * @author Hesham Elbadawi <bsdreko@gmail.com>
 */
@NamedQueries({
        @NamedQuery(
                name = Location.FIND_BY_STATUS_AND_STORAGE_GROUP_IDS,
                query = "SELECT l FROM Location l "
                        + "WHERE l.status = ?1 "
                        + "AND l.createdTime < ?2 "
                        + "AND l.storageSystemGroupID IN (?3)"),
        @NamedQuery(
                name = Location.COUNT_BY_STORAGE_GROUP,
                query = "SELECT COUNT(l) FROM Location l "
                        + "WHERE l.storageSystemGroupID = :storageSystemGroupID"),
        @NamedQuery(
                name = Location.COUNT_BY_STORAGE_GROUP_AND_STORAGE_SYSTEM,
                query = "SELECT COUNT(l) FROM Location l "
                        + "WHERE l.storageSystemGroupID = :storageSystemGroupID "
                        + "AND l.storageSystemID = :storageSystemID"),
        @NamedQuery(
                name = Location.CALCULATE_SUM_DATA_VOLUME_PER_DAY,
                query = "SELECT SUM(l.size) FROM Location l "
                        + "WHERE l.storageSystemGroupID = ?1 "
                        + "AND l.createdTime >= ?2")
})
@Entity
@Table(name = "location")
public class Location implements Serializable {

    private static final long serialVersionUID = -3832203362617593125L;

    public static final String FIND_BY_STATUS_AND_STORAGE_GROUP_IDS = "Location.findByStatusAndStorageGroupIDS";

    public static final String COUNT_BY_STORAGE_GROUP = "Location.countByStorageGroup";

    public static final String COUNT_BY_STORAGE_GROUP_AND_STORAGE_SYSTEM = "Location.countByStorageGroupAndStorageSystem";

    public static final String CALCULATE_SUM_DATA_VOLUME_PER_DAY = "Location.calculateAverageDataVolumePerDay";;

    public enum Status {
        OK, DELETE_FAILED, TO_ARCHIVE, ARCHIVED, ARCHIVE_FAILED, QUERY_FAILED, VERIFY_FAILED
    }

    @Id
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    @Column(name = "pk")
    private long pk;

    @Basic(optional = false)
    @Column(name = "created_time", updatable = false)
    private Date createdTime;

    @Basic(optional = false)
    @Column(name = "storage_group_id", updatable = false)
    private String storageSystemGroupID;

    @Basic(optional = false)
    @Column(name = "storage_id", updatable = false)
    private String storageSystemID;

    @Basic(optional = false)
    @Column(name = "storage_path", updatable = false)
    private String storagePath;

    @Basic(optional = true)
    @Column(name = "entry_name", updatable = false)
    private String entryName;

    @Basic(optional = false)
    @Column(name = "tsuid", updatable = false)
    private String transferSyntaxUID;

    @Basic(optional = true)
    @Column(name = "time_zone", updatable = false)
    private String timeZone;
    
    @Basic(optional = false)
    @Column(name = "object_size", updatable = false)
    private long size;

    @Basic(optional = true)
    @Column(name = "digest", updatable = false)
    private String digest;

    @Basic(optional = true)
    @Column(name = "otherAttsDigest", updatable = false)
    private String otherAttsDigest;
    
    @Basic(optional = false)
    @Enumerated(EnumType.ORDINAL)
    @Column(name = "status", updatable = true)
    private Status status;

    @Basic(optional = false)
    @Column(name = "wo_bulkdata", updatable = false)
    private boolean withoutBulkData;

    @ManyToMany
    @JoinTable(name="rel_instance_location",
            joinColumns={@JoinColumn(name="location_fk", referencedColumnName="pk")},
            inverseJoinColumns={@JoinColumn(name="instance_fk", referencedColumnName="pk")})
    private Collection<Instance> instances;

    public static final class Builder {
        private String storageSystemGroupID;
        private String storageSystemID;
        private String storagePath;
        private String entryName;
        private String transferSyntaxUID;
        private String timeZone;
        private long size;
        private String digest;
        private String otherAttsDigest;
        private Status status = Status.OK;
        private boolean withoutBulkData;

        public Builder storageSystemGroupID(String storageSystemGroupID) {
            this.storageSystemGroupID = storageSystemGroupID;
            return this;
        }

        public Builder storageSystemID(String storageSystemID) {
            this.storageSystemID = storageSystemID;
            return this;
        }

        public Builder storagePath(String storagePath) {
            this.storagePath = storagePath;
            return this;
        }

        public Builder entryName(String entryName) {
            this.entryName = entryName;
            return this;
        }

        public Builder transferSyntaxUID(String transferSyntaxUID) {
            this.transferSyntaxUID = transferSyntaxUID;
            return this;
        }

        public Builder timeZone(String timeZone) {
            this.timeZone = timeZone;
            return this;
        }

        public Builder size(long size) {
            this.size = size;
            return this;
        }

        public Builder otherAttsDigest(String otherAttsDigest) {
            this.otherAttsDigest = otherAttsDigest;
            return this;
        }

        public Builder digest(String digest) {
            this.digest = digest;
            return this;
        }
        
        public Builder status(Status status) {
            this.status = status;
            return this;
        }

        public Builder withoutBulkdata(boolean withoutBulkData) {
            this.withoutBulkData = withoutBulkData;
            return this;
        }

        public Location build() {
            return new Location(this);
        }
    }

    public Location() {}

    private Location(Builder builder) {
        storageSystemGroupID = builder.storageSystemGroupID;
        storageSystemID = builder.storageSystemID;
        storagePath = builder.storagePath;
        entryName = builder.entryName;
        transferSyntaxUID = builder.transferSyntaxUID;
        timeZone = builder.timeZone;
        size = builder.size;
        digest = builder.digest;
        otherAttsDigest = builder.otherAttsDigest;
        status = builder.status;
        withoutBulkData = builder.withoutBulkData;
    }

    @PrePersist
    public void onPrePersist() {
        Date now = new Date();
        createdTime = now;
    }

    public long getPk() {
        return pk;
    }

    public Date getCreatedTime() {
        return createdTime;
    }

    public String getStorageSystemGroupID() {
        return storageSystemGroupID;
    }

    public String getStorageSystemID() {
        return storageSystemID;
    }

    public String getStoragePath() {
        return storagePath;
    }

    public String getEntryName() {
        return entryName;
    }

    public String getTransferSyntaxUID() {
        return transferSyntaxUID;
    }

    public String getTimeZone() {
        return timeZone;
    }

    public long getSize() {
        return size;
    }

    public String getDigest() {
        return digest;
    }

    public String getOtherAttsDigest() {
        return otherAttsDigest;
    }
    
    public Status getStatus() {
        return status;
    }

    public void setStatus(Status status) {
        this.status = status;
    }

    public boolean isWithoutBulkData() {
        return withoutBulkData;
    }

    public void setWithoutBulkData(boolean withoutBulkData) {
        this.withoutBulkData = withoutBulkData;
    }

    public Collection<Instance> getInstances() {
        return instances;
    }

    public void setInstances(Collection<Instance> instances) {
        this.instances = instances;
    }

    public void addInstance(Instance instance) {
        if (instances == null)
            instances = new ArrayList<>(1);
        instances.add(instance);
    }

    @Override
    public String toString() {
        return "Location[pk=" + pk
                + ", groupID=" + storageSystemGroupID
                + ", systemID=" + storageSystemID
                + ", path=" + storagePath
                + ", entry=" + entryName
                + ", tsuid=" + transferSyntaxUID
                + ", size=" + size
                + ", status=" + status
                + ", withoutBulkData=" + withoutBulkData
                + "]";
    }

}