Package io.goobi.viewer.model.cms.pages.content.types

Class CMSMediaContent

java.lang.Object

io.goobi.viewer.model.cms.pages.content.CMSContent

io.goobi.viewer.model.cms.pages.content.types.CMSMediaContent

All Implemented Interfaces:

CMSMediaHolder, Comparable<CMSMediaContent>

Direct Known Subclasses:

CMSDocumentContent

@Entity
public class CMSMediaContent
extends CMSContent
implements CMSMediaHolder, Comparable<CMSMediaContent>

Constructor Summary

Constructors

Constructor	Description
CMSMediaContent()
CMSMediaContent(CMSMediaContent orig)

Method Summary

Modifier and Type	Method	Description
int	compareTo(CMSMediaContent arg0)
CMSContent	copy()
boolean	equals(Object arg0)
List<File>	exportHtmlFragment(String outputFolderPath, String namingScheme)	Writes HTML fragment value as file for re-indexing.
String	getBackendComponentName()
String	getData(Integer w, Integer h)
String	getMediaDescription()	getMediaDescription.
String	getMediaFilter()	A regular expression determining which filenames are shown in the media list and may be uploaded
CMSMediaItem	getMediaItem()	getMediaItem.
CategorizableTranslatedSelectable<CMSMediaItem>	getMediaItemWrapper()	getMediaItemWrapper.
CMSMediaItemMetadata	getMediaMetadata()	getMediaMetadata.
String	getMediaName()	getMediaName.
String	getMediaType()
String	getMediaTypes()	A string representing the allowed media formates for a user.
String	getUrl()
String	getUrl(String width, String height)
String	handlePageLoad(boolean resetResults, CMSComponent component)	Method to call when loading a CMSPage including this content item
int	hashCode()
boolean	hasMediaItem()	hasMediaItem.
boolean	isEmpty()
void	setMediaItem(CMSMediaItem item)	setMediaItem.

Methods inherited from class io.goobi.viewer.model.cms.pages.content.CMSContent

getBackendComponentLibrary, getData, getId, getItemId, getOwningComponent, getOwningPage, isRequired, setId, setItemId, setOwningComponent, setRequired

Methods inherited from class java.lang.Object

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

Constructor Details

CMSMediaContent

public CMSMediaContent()

CMSMediaContent

public CMSMediaContent(CMSMediaContent orig)

Method Details

getBackendComponentName

public String getBackendComponentName()

Specified by:

getBackendComponentName in class CMSContent

setMediaItem

public void setMediaItem(CMSMediaItem item)

Description copied from interface: CMSMediaHolder

setMediaItem.

Specified by:

setMediaItem in interface CMSMediaHolder

Parameters:

item - a CMSMediaItem object.

getMediaItem

public CMSMediaItem getMediaItem()

Description copied from interface: CMSMediaHolder

getMediaItem.

Specified by:

getMediaItem in interface CMSMediaHolder

Returns:

a CMSMediaItem object.

getMediaFilter

public String getMediaFilter()

Description copied from interface: CMSMediaHolder

A regular expression determining which filenames are shown in the media list and may be uploaded

Specified by:

getMediaFilter in interface CMSMediaHolder

Returns:

a String object.

getMediaTypes

public String getMediaTypes()

Description copied from interface: CMSMediaHolder

A string representing the allowed media formates for a user. Should be a comma separated list of format names or filename suffixes

Specified by:

getMediaTypes in interface CMSMediaHolder

Returns:

String

hasMediaItem

public boolean hasMediaItem()

Description copied from interface: CMSMediaHolder

hasMediaItem.

Specified by:

hasMediaItem in interface CMSMediaHolder

Returns:

a boolean.

getMediaItemWrapper

public CategorizableTranslatedSelectable<CMSMediaItem> getMediaItemWrapper()

Description copied from interface: CMSMediaHolder

getMediaItemWrapper.

Specified by:

getMediaItemWrapper in interface CMSMediaHolder

Returns:

a CategorizableTranslatedSelectable object.

getUrl

public String getUrl()
              throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getMediaType

public String getMediaType()

getUrl

public String getUrl(String width,
 String height)
              throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

copy

public CMSContent copy()

Specified by:

copy in class CMSContent

exportHtmlFragment

public List<File> exportHtmlFragment(String outputFolderPath,
 String namingScheme)
                              throws IOException,
ViewerConfigurationException

Description copied from class: CMSContent

Writes HTML fragment value as file for re-indexing. HTML/text fragments are exported directly. Attached media items are exported as long as their content type is one of the supported text document formats.

Specified by:

exportHtmlFragment in class CMSContent

Parameters:

outputFolderPath - a String object.

namingScheme - a String object.

Returns:

Exported Files

Throws:

IOException - if any.

ViewerConfigurationException

handlePageLoad

public String handlePageLoad(boolean resetResults,
 CMSComponent component)
                      throws PresentationException

Description copied from class: CMSContent

Method to call when loading a CMSPage including this content item

Specified by:

handlePageLoad in class CMSContent

Returns:

a JSF action response

Throws:

PresentationException

getMediaName

public String getMediaName()

getMediaName.

Returns:

a String object.

getMediaDescription

public String getMediaDescription()

getMediaDescription.

Returns:

a String object.

getMediaMetadata

public CMSMediaItemMetadata getMediaMetadata()

getMediaMetadata.

Returns:

The media item metadata object of the current language associated with the contentItem with the given itemId. May return null if no such item exists

getData

public String getData(Integer w,
 Integer h)

Specified by:

getData in class CMSContent

Returns:

a string representing this contentItem for use in frontend-components. May be an empty string for content with no clear String representation

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class CMSContent

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object arg0)

Overrides:

equals in class Object

compareTo

public int compareTo(CMSMediaContent arg0)

Specified by:

compareTo in interface Comparable<CMSMediaContent>