Package org.dspace.contentreport

Class FilteredCollections

java.lang.Object

org.dspace.contentreport.FilteredCollections

All Implemented Interfaces:

Serializable

public class FilteredCollections
extends Object
implements Serializable

This class represents the complete result of a Filtered Collections report query. In addition to the list of FilteredCollection entries, it contains the lazily computed summary to be included in the completed report.

Author:

Jean-François Morin (Université Laval)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FilteredCollections()

Method Summary

Modifier and Type	Method	Description
void	addCollection(FilteredCollection coll)	Adds a FilteredCollectionRest object to this report.
List<FilteredCollection>	getCollections()	Returns a defensive copy of the collections included in this report.
FilteredCollection	getSummary()	Returns the report summary.
static FilteredCollections	of(Collection<FilteredCollection> collections)	Shortcut method that builds a FilteredCollectionsRest instance from its building blocks.
void	setCollections(List<FilteredCollection> collections)	Sets all collections for this report.

Methods inherited from class java.lang.Object

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

Constructor Details

FilteredCollections

public FilteredCollections()

Method Details

of

public static FilteredCollections of(Collection<FilteredCollection> collections)

Shortcut method that builds a FilteredCollectionsRest instance from its building blocks.

Parameters:

collections - a list of FilteredCollectionRest instances

Returns:

a FilteredCollectionsRest instance built from the provided parameters

getCollections

public List<FilteredCollection> getCollections()

Returns a defensive copy of the collections included in this report.

Returns:

the collections included in this report

addCollection

public void addCollection(FilteredCollection coll)

Adds a FilteredCollectionRest object to this report.

Parameters:

coll - FilteredCollectionRest to add to this report

setCollections

public void setCollections(List<FilteredCollection> collections)

Sets all collections for this report. The contents are copied into this object's internal list, which is protected against further tampering with the provided list.

Parameters:

collections - Values that replace the current ones

getSummary

public FilteredCollection getSummary()

Returns the report summary. If the summary has not been computed yet and/or the report includes non-sealed collections, it will be regenerated.

Returns:

the generated report summary