org.dspace.app.util.CollectionDropDown 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.
The newest version!
/**
 * 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.util;

import java.sql.SQLException;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;

import org.dspace.content.Collection;
import org.dspace.content.Community;
import org.dspace.content.factory.ContentServiceFactory;
import org.dspace.content.service.CommunityService;
import org.dspace.core.Context;
import org.dspace.services.ConfigurationService;
import org.dspace.services.factory.DSpaceServicesFactory;

/**
 * Utility class for lists of collections.
 */

public class CollectionDropDown {

    private static final CommunityService communityService = ContentServiceFactory.getInstance().getCommunityService();

    /**
     * Default constructor
     */
    private CollectionDropDown() { }

    /**
     * Get full path starting from a top-level community via subcommunities down to a collection.
     * The full path will not be truncated.
     *
     * @param context The relevant DSpace Context.
     * @param col     Get full path for this collection
     * @return Full path to the collection
     * @throws SQLException if database error
     */
    public static String collectionPath(Context context, Collection col) throws SQLException {
        return CollectionDropDown.collectionPath(context, col, 0);
    }

    /**
     * Get full path starting from a top-level community via subcommunities down to a collection.
     * The full cat will be truncated to the specified number of characters and prepended with an ellipsis.
     *
     * @param context  The relevant DSpace Context.
     * @param col      Get full path for this collection
     * @param maxchars Truncate the full path to maxchar characters. 0 means do not truncate.
     * @return Full path to the collection (truncated)
     * @throws SQLException if database error
     */
    public static String collectionPath(Context context, Collection col, int maxchars)
            throws SQLException {
        ConfigurationService configurationService
                = DSpaceServicesFactory.getInstance().getConfigurationService();
        String separator = configurationService.getProperty("subcommunity.separator");
        if (separator == null) {
            separator = " > ";
        }

        List getCom = null;
        StringBuffer name = new StringBuffer("");
        getCom = communityService.getAllParents(context, col); // all communities containing given collection
        for (Community com : getCom) {
            name.insert(0, com.getName() + separator);
        }

        name.append(col.getName());

        if (maxchars != 0) {
            int len = name.length();
            if (len > maxchars) {
                name = new StringBuffer(name.substring(len - (maxchars - 1), len));
                name.insert(0, "\u2026"); // prepend with an ellipsis (cut from left)
            }
        }

        return name.toString();
    }

    /**
     * Annotates an array of collections with their respective full paths (@see #collectionPath() method in this class).
     *
     * @param context     The relevant DSpace Context.
     * @param collections An array of collections to annotate with their hierarchical paths.
     *                    The array and all its entries must be non-null.
     * @return A sorted array of collection path entries (essentially collection/path pairs).
     * @throws SQLException In case there are problems annotating a collection with its path.
     */
    public static CollectionPathEntry[] annotateWithPaths(Context context, List collections)
        throws SQLException {
        CollectionPathEntry[] result = new CollectionPathEntry[collections.size()];
        for (int i = 0; i < collections.size(); i++) {
            Collection collection = collections.get(i);
            CollectionPathEntry entry = new CollectionPathEntry(collection, collectionPath(context, collection));
            result[i] = entry;
        }
        Arrays.sort(result);
        return result;
    }

    /**
     * A helper class to hold (collection, full path) pairs. Instances of the helper class are sortable:
     * two instances will be compared first on their full path and if those are equal,
     * the comparison will fall back to comparing collection IDs.
     */
    public static class CollectionPathEntry implements Comparable {
        public Collection collection;
        public String path;

        public CollectionPathEntry(Collection collection, String path) {
            this.collection = collection;
            this.path = path;
        }

        @Override
        public int compareTo(CollectionPathEntry other) {
            if (!this.path.equals(other.path)) {
                return this.path.compareTo(other.path);
            }
            return this.collection.getID().compareTo(other.collection.getID());
        }

        @Override
        public boolean equals(Object o) {
            return o != null && o instanceof CollectionPathEntry && this.compareTo((CollectionPathEntry) o) == 0;
        }

        @Override
        public int hashCode() {
            return Objects.hash(path, collection.getID());
        }
    }
}