org.dspace.app.itemmarking.ItemMarkingAvailabilityBitstreamStrategy 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.app.itemmarking;

import java.io.UnsupportedEncodingException;
import java.sql.SQLException;
import java.util.List;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.dspace.app.util.Util;
import org.dspace.content.Bitstream;
import org.dspace.content.Bundle;
import org.dspace.content.Item;
import org.dspace.content.service.ItemService;
import org.dspace.core.Constants;
import org.dspace.core.Context;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * This is an item marking Strategy class that tries to mark an item availability
 * based on the existence of bitstreams within the ORIGINAL bundle.
 *
 * @author Kostas Stamatis
 */
public class ItemMarkingAvailabilityBitstreamStrategy implements ItemMarkingExtractor {

    private String availableImageName;
    private String nonAvailableImageName;

    @Autowired(required = true)
    protected ItemService itemService;

    private static final Logger LOG = LogManager.getLogger();

    public ItemMarkingAvailabilityBitstreamStrategy() {
    }

    @Override
    public ItemMarkingInfo getItemMarkingInfo(Context context, Item item)
        throws SQLException {

        List bundles = itemService.getBundles(item, "ORIGINAL");
        if (bundles.isEmpty()) {
            ItemMarkingInfo markInfo = new ItemMarkingInfo();
            markInfo.setImageName(nonAvailableImageName);

            return markInfo;
        } else {
            Bundle originalBundle = bundles.iterator().next();
            if (originalBundle.getBitstreams().isEmpty()) {
                ItemMarkingInfo markInfo = new ItemMarkingInfo();
                markInfo.setImageName(nonAvailableImageName);

                return markInfo;
            } else {
                Bitstream bitstream = originalBundle.getBitstreams().get(0);

                ItemMarkingInfo signInfo = new ItemMarkingInfo();
                signInfo.setImageName(availableImageName);
                signInfo.setTooltip(bitstream.getName());


                String bsLink = "";

                bsLink = bsLink + "bitstream/"
                    + item.getHandle() + "/"
                    + bitstream.getSequenceID() + "/";

                try {
                    bsLink = bsLink + Util.encodeBitstreamName(bitstream.getName(), Constants.DEFAULT_ENCODING);
                } catch (UnsupportedEncodingException e) {
                    LOG.warn("DSpace uses an unsupported encoding", e);
                }

                signInfo.setLink(bsLink);

                return signInfo;
            }
        }
    }

    public void setAvailableImageName(String availableImageName) {
        this.availableImageName = availableImageName;
    }

    public void setNonAvailableImageName(String nonAvailableImageName) {
        this.nonAvailableImageName = nonAvailableImageName;
    }
}