org.dspace.app.util

Class CollectionDropDown

java.lang.Object

org.dspace.app.util.CollectionDropDown

public class CollectionDropDown
extends java.lang.Object

Utility class for lists of collections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionDropDown.CollectionPathEntry A helper class to hold (collection, full path) pairs.

Constructor Summary

Constructors

Constructor and Description
CollectionDropDown()

Method Summary

Methods

Modifier and Type	Method and Description
static CollectionDropDown.CollectionPathEntry[]	annotateWithPaths(Collection[] collections) Annotates an array of collections with their respective full paths (@see #collectionPath() method in this class).
static java.lang.String	collectionPath(Collection col) Get full path starting from a top-level community via subcommunities down to a collection.
static java.lang.String	collectionPath(Collection col, int maxchars) Get full path starting from a top-level community via subcommunities down to a collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionDropDown

public CollectionDropDown()

Method Detail

collectionPath

public static java.lang.String collectionPath(Collection col)
                                       throws java.sql.SQLException

Get full path starting from a top-level community via subcommunities down to a collection. The full path will not be truncated.

Parameters:

col - Get full path for this collection

Returns:

Full path to the collection

Throws:

java.sql.SQLException

collectionPath

public static java.lang.String collectionPath(Collection col,
                              int maxchars)
                                       throws java.sql.SQLException

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.

Parameters:

col - Get full path for this collection

maxchars - Truncate the full path to maxchar characters. 0 means do not truncate.

Returns:

Full path to the collection (truncated)

Throws:

java.sql.SQLException

annotateWithPaths

public static CollectionDropDown.CollectionPathEntry[] annotateWithPaths(Collection[] collections)
                                                                  throws java.sql.SQLException

Annotates an array of collections with their respective full paths (@see #collectionPath() method in this class).

Parameters:

collections - An array of collections to annotate with their hierarchical paths. The array and all its entries must be non-null.

Returns:

A sorted array of collection path entries (essentially collection/path pairs).

Throws:

java.sql.SQLException - In case there are problems annotating a collection with its path.