org.kitodo.api.dataformat.MediaUnit.java Source code

Introduction

Here is the source code for org.kitodo.api.dataformat.MediaUnit.java

Source

/*
 * (c) Kitodo. Key to digital objects e. V. <contact@kitodo.org>
 *
 * This file is part of the Kitodo project.
 *
 * It is licensed under GNU General Public License version 3 or later.
 *
 * For the full copyright and license information, please read the
 * GPL3-License.txt file that was distributed with this source code.
 */

package org.kitodo.api.dataformat;

import java.net.URI;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;

import org.apache.commons.io.FilenameUtils;
import org.kitodo.api.Metadata;

public class MediaUnit implements Parent<MediaUnit> {
    /**
     * The subordinate media units of this media unit, which form the media unit
     * tree. The order of the substructures is subordinate media units by the
     * order of the {@code <div>} elements in the
     * {@code <structMap TYPE="PHYSICAL">} in the METS file.
     */
    private List<MediaUnit> children = new LinkedList<>();

    /**
     * Each media unit can be available in different variants, for each of which
     * a media file is available. This is in this map.
     */
    private Map<MediaVariant, URI> mediaFiles = new HashMap<>();

    /**
     * The meta-data for this media unit. This media unit can be described with
     * any meta-data.
     */
    private Collection<Metadata> metadata = new HashSet<>();

    /**
     * Sequence number of the media unit. The playback order of the media units
     * when referenced from an included structural element is determined by this
     * attribute (not by the order of the references).
     */
    private int order;

    /**
     * A human readable label for the order of this media unit. This need not be
     * directly related to the order number. Examples of order labels could be
     * I, II, III, IV, V, -, 1, 2, 3?, meanwhile the order would be 1, 2, 3,
     * 4, 5, 6, 7, 8, 9?.
     */
    private String orderlabel;

    /**
     * The type of the media unit.
     */
    private String type;

    /**
     * Returns the subordinate media units associated with this media unit.
     *
     * @return the subordinate media units
     */
    @Override
    public List<MediaUnit> getChildren() {
        return children;
    }

    /**
     * Returns the map of available media variants with the corresponding media
     * file URIs.
     *
     * @return available media variants with corresponding media file URIs
     */
    public Map<MediaVariant, URI> getMediaFiles() {
        return mediaFiles;
    }

    /**
     * Returns the meta-data on this structure.
     *
     * @return the meta-data
     */
    public Collection<Metadata> getMetadata() {
        return metadata;
    }

    /**
     * Returns the order number for this media unit.
     *
     * @return the order number
     */
    public int getOrder() {
        return order;
    }

    /**
     * Sets the order number for this media unit.
     *
     * @param order
     *            order number to set
     */
    public void setOrder(int order) {
        this.order = order;
    }

    /**
     * Returns the order label for this media unit.
     *
     * @return the order label
     */
    public String getOrderlabel() {
        return orderlabel;
    }

    /**
     * Sets the order label for this media unit.
     *
     * @param orderlabel
     *            order label to set
     */
    public void setOrderlabel(String orderlabel) {
        this.orderlabel = orderlabel;
    }

    /**
     * Returns the type of this media unit.
     *
     * @return the type
     */
    public String getType() {
        return type;
    }

    /**
     * Sets the type of this media unit.
     *
     * @param type
     *            type to set
     */
    public void setType(String type) {
        this.type = type;
    }

    @Override
    public String toString() {
        String fileName = "No file (";
        if (!mediaFiles.isEmpty()) {
            URI uri = mediaFiles.entrySet().iterator().next().getValue();
            fileName = FilenameUtils.getBaseName(uri.getPath()).concat(" (");
        }
        if (Objects.nonNull(type)) {
            fileName = type + ' ' + fileName;
        }
        return mediaFiles.keySet().stream().map(MediaVariant::getUse)
                .collect(Collectors.joining(", ", fileName, ")"));
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((mediaFiles == null) ? 0 : mediaFiles.hashCode());
        result = prime * result + order;
        result = prime * result + ((orderlabel == null) ? 0 : orderlabel.hashCode());
        result = prime * result + (Objects.isNull(type) ? 0 : type.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof MediaUnit)) {
            return false;
        }
        MediaUnit other = (MediaUnit) obj;
        if (mediaFiles == null) {
            if (other.mediaFiles != null) {
                return false;
            }
        } else if (!mediaFiles.equals(other.mediaFiles)) {
            return false;
        }
        if (order != other.order) {
            return false;
        }
        if (orderlabel == null) {
            if (other.orderlabel != null) {
                return false;
            }
        } else if (!orderlabel.equals(other.orderlabel)) {
            return false;
        }
        if (Objects.isNull(type)) {
            return !Objects.nonNull(other.type);
        } else {
            return type.equals(other.type);
        }
    }
}