Package io.goobi.viewer.managedbeans

Class CmsMediaBean

java.lang.Object

io.goobi.viewer.managedbeans.CmsMediaBean

All Implemented Interfaces:

Serializable

@Named
@SessionScoped
public class CmsMediaBean
extends Object
implements Serializable

CmsMediaBean class.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected UserBean	userBean

Constructor Summary

Constructors

Constructor	Description
CmsMediaBean()	Constructor for CmsMediaBean.

Method Summary

Modifier and Type	Method	Description
CMSMediaItem	createMediaItem()	createMediaItem.
void	deleteMedia(CMSMediaItem item)	deleteMedia.
void	deleteSelectedItems()	Deletes all mediaItems from getMediaItems() which are are marked as selected.
List<CMSMediaItem>	getAllMedia()	getAllMedia.
List<CMSCategory>	getAllMediaCategories()	getAllMediaCategories.
static String	getAllTypes()
static String	getAudioFilter()
static String	getAudioTypes()
TableDataProvider<CategorizableTranslatedSelectable<CMSMediaItem>>	getDataProvider()	Getter for the field dataProvider.
static String	getDocumentFilter()
static String	getDocumentTypes()
static String	getFileName(jakarta.servlet.http.Part filePart)	getFileName.
String	getFilenameFilter()	Getter for the field filenameFilter.
String	getFilter()	Getter for the field filter.
static String	getImageFilter()	getImageFilter.
static String	getImageTypes()
static String	getMediaFileAsString(CMSMediaItem item)	getMediaFileAsString.
static String	getMediaFilter()
List<CategorizableTranslatedSelectable<CMSMediaItem>>	getMediaItems()	getMediaItems.
static String	getMediaPreviewUrl(CMSMediaItem item)	getMediaPreviewUrl.
static String	getMediaUrl(CMSMediaItem item)	getMediaUrl.
static String	getMediaUrl(CMSMediaItem item, String width, String height)	getMediaUrl.
TranslatedSelectable<CMSMediaItem>	getSelectedMediaItem()	Getter for the field selectedMediaItem.
String	getSelectedTag()	Getter for the field selectedTag.
static String	getVideoFilter()
static String	getVideoTypes()
boolean	isAllSelected()	isAllSelected.
boolean	isAudio(CMSMediaItem item)	isAudio.
boolean	isImage(CMSMediaItem item)	isImage.
boolean	isText(CMSMediaItem item)	isText.
boolean	isVideo(CMSMediaItem item)	isVideo.
boolean	needsPaginator()	needsPaginator.
void	reloadMediaList()	reloadMediaList.
void	reloadMediaList(boolean resetCurrentPage)	reloadMediaList.
void	resetData()	Reload all media items, along with the available categories
void	saveMedia(CMSMediaItem media)	saveMedia.
void	saveMedia(CMSMediaItem media, List<Selectable<CMSCategory>> categories)	Save media item, adding or removing the given categories, depending wether they are selected or not. if User.hasPrivilegeForAllSubthemeDiscriminatorValues() is false for the current user and none of the given categories is selected, then don't change the media categories since doing so would break category restrictions
void	saveSelectedItems()	Saves all mediaItems from getMediaItems() which are are marked as selected.
void	saveSelectedMediaItem()	saveSelectedMediaItem.
void	setAllSelected(boolean allSelected)	Setter for the field allSelected.
void	setFilenameFilter(String filter)	Setter for the field filenameFilter.
void	setFilter(String filter)	Setter for the field filter.
void	setSelectedMediaItem(CategorizableTranslatedSelectable<CMSMediaItem> selectedMediaItem)	Setter for the field selectedMediaItem.
void	setSelectedTag(String selectedTag)	Setter for the field selectedTag.
void	toggleSelectedMediaItem(CategorizableTranslatedSelectable<CMSMediaItem> selectedMediaItem)	toggleSelectedMediaItem.

Methods inherited from class java.lang.Object

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

Field Details

userBean

@Inject
protected UserBean userBean

Constructor Details

CmsMediaBean

public CmsMediaBean()

Constructor for CmsMediaBean.

Method Details

resetData

public void resetData()

Reload all media items, along with the available categories

createMediaItem

public CMSMediaItem createMediaItem()

createMediaItem.

Returns:

a CMSMediaItem object.

deleteMedia

public void deleteMedia(CMSMediaItem item)
                 throws DAOException

deleteMedia.

Parameters:

item - a CMSMediaItem object.

Throws:

DAOException - if any.

getAllMedia

public List<CMSMediaItem> getAllMedia()
                               throws DAOException

getAllMedia.

Returns:

a List object.

Throws:

DAOException - if any.

getDataProvider

public TableDataProvider<CategorizableTranslatedSelectable<CMSMediaItem>> getDataProvider()

Getter for the field dataProvider.

Returns:

a TableDataProvider object.

getMediaItems

public List<CategorizableTranslatedSelectable<CMSMediaItem>> getMediaItems()
                                                                    throws DAOException

getMediaItems.

Returns:

a List object.

Throws:

DAOException - if any.

reloadMediaList

public void reloadMediaList()

reloadMediaList.

reloadMediaList

public void reloadMediaList(boolean resetCurrentPage)

reloadMediaList.

Parameters:

resetCurrentPage - a boolean.

deleteSelectedItems

public void deleteSelectedItems()
                         throws DAOException

Deletes all mediaItems from getMediaItems() which are are marked as selected. Reloads the media list

Throws:

DAOException - if any.

saveSelectedItems

public void saveSelectedItems()
                       throws DAOException

Saves all mediaItems from getMediaItems() which are are marked as selected. Reloads the media list

Throws:

DAOException - if any.

getMediaUrl

public static String getMediaUrl(CMSMediaItem item)
                          throws NumberFormatException

getMediaUrl.

Parameters:

item - a CMSMediaItem object.

Returns:

a String object.

Throws:

NumberFormatException - if any.

ViewerConfigurationException - if any.

getMediaUrl

public static String getMediaUrl(CMSMediaItem item,
 String width,
 String height)

getMediaUrl.

Parameters:

item - a CMSMediaItem object.

width - a String object.

height - a String object.

Returns:

a String object.

Throws:

ViewerConfigurationException - if any.

getMediaFileAsString

public static String getMediaFileAsString(CMSMediaItem item)

getMediaFileAsString.

Parameters:

item - a CMSMediaItem object.

Returns:

a String object.

Throws:

ViewerConfigurationException - if any.

getMediaPreviewUrl

public static String getMediaPreviewUrl(CMSMediaItem item)
                                 throws NumberFormatException

getMediaPreviewUrl.

Parameters:

item - a CMSMediaItem object.

Returns:

a String object.

Throws:

NumberFormatException - if any.

ViewerConfigurationException - if any.

isImage

public boolean isImage(CMSMediaItem item)

isImage.

Parameters:

item - a CMSMediaItem object.

Returns:

a boolean.

isVideo

public boolean isVideo(CMSMediaItem item)

isVideo.

Parameters:

item - a CMSMediaItem object.

Returns:

a boolean.

isAudio

public boolean isAudio(CMSMediaItem item)

isAudio.

Parameters:

item - a CMSMediaItem object.

Returns:

a boolean.

isText

public boolean isText(CMSMediaItem item)

isText.

Parameters:

item - a CMSMediaItem object.

Returns:

a boolean.

saveSelectedMediaItem

public void saveSelectedMediaItem()
                           throws DAOException

saveSelectedMediaItem.

Throws:

DAOException - if any.

saveMedia

public void saveMedia(CMSMediaItem media,
 List<Selectable<CMSCategory>> categories)
               throws DAOException

Save media item, adding or removing the given categories, depending wether they are selected or not. if User.hasPrivilegeForAllSubthemeDiscriminatorValues() is false for the current user and none of the given categories is selected, then don't change the media categories since doing so would break category restrictions

Parameters:

media - a CMSMediaItem object.

categories - a List object.

Throws:

DAOException - if any.

saveMedia

public void saveMedia(CMSMediaItem media)
               throws DAOException

saveMedia.

Parameters:

media - a CMSMediaItem object.

Throws:

DAOException - if any.

getFileName

public static String getFileName(jakarta.servlet.http.Part filePart)

getFileName.

Parameters:

filePart - a Part object.

Returns:

a String object.

setSelectedTag

public void setSelectedTag(String selectedTag)

Setter for the field selectedTag.

Parameters:

selectedTag - the selectedTag to set

getSelectedTag

public String getSelectedTag()

Getter for the field selectedTag.

Returns:

the selectedTag

getAllMediaCategories

public List<CMSCategory> getAllMediaCategories()
                                        throws DAOException

getAllMediaCategories.

Returns:

a List object.

Throws:

DAOException - if any.

getImageFilter

public static String getImageFilter()

getImageFilter.

Returns:

a regex matching only filenames ending with one of the supported image format suffixes

getVideoFilter

public static String getVideoFilter()

getAudioFilter

public static String getAudioFilter()

getDocumentFilter

public static String getDocumentFilter()

getMediaFilter

public static String getMediaFilter()

getImageTypes

public static String getImageTypes()

getVideoTypes

public static String getVideoTypes()

getAudioTypes

public static String getAudioTypes()

getDocumentTypes

public static String getDocumentTypes()

getAllTypes

public static String getAllTypes()

getFilter

public String getFilter()

Getter for the field filter.

Returns:

the filter

setFilter

public void setFilter(String filter)

Setter for the field filter.

Parameters:

filter - the filter to set

getFilenameFilter

public String getFilenameFilter()

Getter for the field filenameFilter.

Returns:

the filter

setFilenameFilter

public void setFilenameFilter(String filter)

Setter for the field filenameFilter.

Parameters:

filter - the filter to set

setSelectedMediaItem

public void setSelectedMediaItem(CategorizableTranslatedSelectable<CMSMediaItem> selectedMediaItem)

Setter for the field selectedMediaItem.

Parameters:

selectedMediaItem - the selectedMediaItem to set

toggleSelectedMediaItem

public void toggleSelectedMediaItem(CategorizableTranslatedSelectable<CMSMediaItem> selectedMediaItem)

toggleSelectedMediaItem.

Parameters:

selectedMediaItem - a CategorizableTranslatedSelectable object.

getSelectedMediaItem

public TranslatedSelectable<CMSMediaItem> getSelectedMediaItem()

Getter for the field selectedMediaItem.

Returns:

the selectedMediaItem

setAllSelected

public void setAllSelected(boolean allSelected)

Setter for the field allSelected.

Parameters:

allSelected - the allSelected to set

isAllSelected

public boolean isAllSelected()

isAllSelected.

Returns:

the allSelected

needsPaginator

public boolean needsPaginator()

needsPaginator.

Returns:

true if there is more than one page in the data-provider. False otherwise