Package io.goobi.viewer.managedbeans

Class CollectionViewBean

java.lang.Object

io.goobi.viewer.managedbeans.CollectionViewBean

All Implemented Interfaces:

Serializable

@Named
@SessionScoped
public class CollectionViewBean
extends Object
implements Serializable

Creates and stored CollectionViews for a session.

Author:

florian

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CollectionViewBean()

Method Summary

Modifier and Type	Method	Description
CollectionView	getCollection(CMSCollectionContent content)	Get the CollectionView of the given content item in the given page.
CollectionView	getCollection(CMSCollectionContent content, int collectionBaseLevels, boolean openExpanded, boolean displayParents, boolean ignoreHierarchy)	Deprecated.
CollectionView	getCollection(CMSCollectionContent content, int collectionBaseLevels, boolean openExpanded, boolean displayParents, boolean ignoreHierarchy, String topVisibleElement)	Deprecated.
CollectionView	getCollection(CMSCollectionContent content, String topVisibleElement)	getCollection.
static String	getCollectionId(CMSCollectionContent content)	getCollectionId.
Optional<CollectionView>	getCollectionIfStored(CMSCollectionContent content)	getCollectionIfStored.
List<CollectionView>	getCollections(String field)	get a list of all CollectionViews with the given solr field which are already loaded via getCollection(CMSCollectionContent, int, boolean, boolean, boolean).
Map<String,CollectionResult>	getColletionMap(CMSCollectionContent content)	getColletionMap.
List<CollectionView>	getLoadedCollectionsForPage(CMSPage page)	getLoadedCollectionsForPage.
List<jakarta.faces.model.SelectItem>	getPossibleBaseCollectionList(CMSCollectionContent content)	Queries Solr for a list of all values of the set collectionField which my serve as a collection.
List<jakarta.faces.model.SelectItem>	getPossibleIgnoreCollectionList(CMSCollectionContent content, boolean includeSubcollections)	Queries Solr for a list of all values of the set collectionField which my serve as a collection.
CollectionView	initializeCollection(CMSCollectionContent content, int numBaseLevels, boolean openExpanded, boolean displayParents, boolean ignoreHierarchy, String topVisibleElement)	Deprecated.
CollectionView	initializeCollection(CMSCollectionContent content, String topVisibleElement)	Creates a collection view object from the item's collection related properties.
void	invalidate()	invalidate.
boolean	removeCollection(CMSCollectionContent content)	removeCollection.
void	removeCollectionsForPage(CMSPage page)	removeCollectionsForPage.

Methods inherited from class java.lang.Object

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

Constructor Details

CollectionViewBean

public CollectionViewBean()

Method Details

getCollection

public CollectionView getCollection(CMSCollectionContent content)
                             throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Get the CollectionView of the given content item in the given page. If the view hasn't been initialized yet, do so and add it to the Bean's CollectionView map

Parameters:

content - a CMSCollectionContent instance providing the base data for this collection

Returns:

The CollectionView or null if no matching ContentItem was found

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getCollection

@Deprecated(since="24.08")
public CollectionView getCollection(CMSCollectionContent content,
 int collectionBaseLevels,
 boolean openExpanded,
 boolean displayParents,
 boolean ignoreHierarchy)
                             throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Deprecated.

Throws:

PresentationException

IndexUnreachableException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getCollection

public CollectionView getCollection(CMSCollectionContent content,
 String topVisibleElement)
                             throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getCollection.

Parameters:

content - a CMSCollectionContent object

topVisibleElement - a String object

Returns:

a CollectionView object

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException - if any.

getCollection

@Deprecated(since="24.08")
public CollectionView getCollection(CMSCollectionContent content,
 int collectionBaseLevels,
 boolean openExpanded,
 boolean displayParents,
 boolean ignoreHierarchy,
 String topVisibleElement)
                             throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Deprecated.

Throws:

PresentationException

IndexUnreachableException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getCollectionId

public static String getCollectionId(CMSCollectionContent content)

getCollectionId.

Parameters:

content - a CMSCollectionContent object

Returns:

a String object

getCollectionIfStored

public Optional<CollectionView> getCollectionIfStored(CMSCollectionContent content)

getCollectionIfStored.

Parameters:

content - a CMSCollectionContent object

Returns:

a Optional object

removeCollection

public boolean removeCollection(CMSCollectionContent content)

removeCollection.

Parameters:

content - a CMSCollectionContent object

Returns:

a boolean

initializeCollection

@Deprecated(since="24.08")
public CollectionView initializeCollection(CMSCollectionContent content,
 int numBaseLevels,
 boolean openExpanded,
 boolean displayParents,
 boolean ignoreHierarchy,
 String topVisibleElement)
                                    throws PresentationException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
IndexUnreachableException

Deprecated.

Throws:

PresentationException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

IndexUnreachableException

initializeCollection

public CollectionView initializeCollection(CMSCollectionContent content,
 String topVisibleElement)
                                    throws PresentationException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
IndexUnreachableException

Creates a collection view object from the item's collection related properties.

Parameters:

content - a CMSCollectionContent object

topVisibleElement - a String object

Returns:

a CollectionView object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getPossibleIgnoreCollectionList

public List<jakarta.faces.model.SelectItem> getPossibleIgnoreCollectionList(CMSCollectionContent content,
 boolean includeSubcollections)
                                                                     throws IndexUnreachableException

Queries Solr for a list of all values of the set collectionField which my serve as a collection.

Parameters:

content - a CMSCollectionContent object

includeSubcollections -

Returns:

a List object.

Throws:

IndexUnreachableException - if any.

getPossibleBaseCollectionList

public List<jakarta.faces.model.SelectItem> getPossibleBaseCollectionList(CMSCollectionContent content)
                                                                   throws IndexUnreachableException

Queries Solr for a list of all values of the set collectionField which my serve as a collection.

Parameters:

content -

Returns:

a List object.

Throws:

IndexUnreachableException - if any.

getColletionMap

public Map<String,CollectionResult> getColletionMap(CMSCollectionContent content)
                                             throws IndexUnreachableException

getColletionMap.

Parameters:

content - a CMSCollectionContent object

Returns:

Map<String, CollectionResult>

Throws:

IndexUnreachableException

removeCollectionsForPage

public void removeCollectionsForPage(CMSPage page)

removeCollectionsForPage.

Parameters:

page - a CMSPage object

getLoadedCollectionsForPage

public List<CollectionView> getLoadedCollectionsForPage(CMSPage page)

getLoadedCollectionsForPage.

Parameters:

page - a CMSPage object

Returns:

a List object

getCollections

public List<CollectionView> getCollections(String field)

get a list of all CollectionViews with the given solr field which are already loaded via getCollection(CMSCollectionContent, int, boolean, boolean, boolean).

Parameters:

field - The solr field the collection is based on

Returns:

a List object.

invalidate

public void invalidate()

invalidate.