Class Media
- java.lang.Object
-
- org.silverpeas.components.gallery.model.Media
-
- All Implemented Interfaces:
Serializable,org.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface,org.silverpeas.core.contribution.model.Contribution,org.silverpeas.core.contribution.model.SilverpeasContent,org.silverpeas.core.contribution.model.WithPermanentLink,org.silverpeas.core.Identifiable,org.silverpeas.core.Instance<org.silverpeas.core.contribution.model.Contribution>,org.silverpeas.core.Nameable,org.silverpeas.core.security.Securable,org.silverpeas.core.SilverpeasResource
- Direct Known Subclasses:
InternalMedia,Streaming
public abstract class Media extends Object implements org.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface, Serializable, org.silverpeas.core.contribution.model.WithPermanentLink
This class represents a Media and provides all the common data.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static org.silverpeas.core.process.io.file.FileBasePathBASE_PATH
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddToAlbums(String... albumIds)Adds the current media to the album represented by specified identifiers.booleancanBeAccessedBy(org.silverpeas.core.admin.user.model.User user)booleanequals(Object o)StringgetApplicationEmbedUrl(MediaResolution mediaResolution)Gets the Application URL thumbnail of the media according the specified media resolution.StringgetApplicationOriginalUrl()Gets the original URL of a media with cache handling.StringgetApplicationThumbnailUrl(MediaResolution mediaResolution)Gets the Application URL thumbnail of the media according the specified media resolution.StringgetAuthor()StringgetContributionType()abstract MediagetCopy()Creates a copy of the instance.DategetCreationDate()org.silverpeas.core.admin.user.model.UsergetCreator()StringgetCreatorId()StringgetCreatorName()StringgetDate()StringgetDescription()StringgetDescription(String language)org.silverpeas.core.io.file.SilverpeasFilegetFile(MediaResolution mediaResolution)Gets the Silverpeas file.abstract org.silverpeas.core.io.file.SilverpeasFilegetFile(MediaResolution mediaResolution, String size)Gets the Silverpeas file.protected org.silverpeas.core.admin.user.model.SilverpeasRolegetHighestUserRole(org.silverpeas.core.admin.user.model.User user)Retrieve highest user roleStringgetIconUrl()StringgetId()StringgetInstanceId()InternalMediagetInternalMedia()Gets the internal media instance if type of the current media isMediaType.PhotoorMediaType.VideoorMediaType.Sound.StringgetKeyWord()Collection<String>getLanguages()DategetLastUpdateDate()StringgetLastUpdatedBy()org.silverpeas.core.admin.user.model.UsergetLastUpdater()StringgetLastUpdaterName()MediaPKgetMediaPK()StringgetName()StringgetName(String language)StringgetPermalink()Gets the permalink of a media.PhotogetPhoto()Gets the photo instance if type of the current media isMediaType.Photo.StringgetSilverCreationDate()StringgetSilverpeasContentId()SoundgetSound()Gets the sound instance if type of the current media isMediaType.Sound.StreaminggetStreaming()Gets the streaming instance if type of the current media isMediaType.Streaming.StringgetTitle()abstract MediaTypegetType()StringgetURL()VideogetVideo()Gets the video instance if type of the current media isMediaType.Video.org.silverpeas.core.date.period.PeriodgetVisibilityPeriod()StringgetWorkspaceSubFolderName()Gets the sub folder name of the media in the Silverpeas workspace.inthashCode()booleanisDownloadable()Indicated if the download is possible.booleanisPreviewable()Indicates if the media is previewable.booleanisVisible()protected booleanisVisible(Date today)voidremoveFromAllAlbums()Removes the current media from all albums which it is attached to.voidsetAuthor(String author)voidsetComponentInstanceId(String instanceId)voidsetCreationDate(Date createDate)voidsetCreator(org.silverpeas.core.admin.user.model.User creator)voidsetCreatorId(String creatorId)voidsetDescription(String description)voidsetIconUrl(String iconUrl)voidsetId(String mediaId)voidsetKeyWord(String keyWord)voidsetLastUpdateDate(Date lastUpdateDate)voidsetLastUpdatedBy(String lastUpdatedBy)voidsetLastUpdater(org.silverpeas.core.admin.user.model.User lastUpdater)voidsetMediaPK(MediaPK mediaPK)voidsetSilverpeasContentId(String silverpeasContentId)voidsetTitle(String title)voidsetToAlbums(String... albumIds)Sets the current media to the album represented by specified identifiers.voidsetVisibilityPeriod(org.silverpeas.core.date.period.Period visibilityPeriod)StringtoString()-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.silverpeas.core.contribution.model.Contribution
getModel, getResourcePath, isIndexable
-
Methods inherited from interface org.silverpeas.core.security.Securable
canBeDeletedBy, canBeFiledInBy, canBeModifiedBy
-
-
-
-
Constructor Detail
-
Media
public Media()
-
Media
protected Media(Media other)
-
-
Method Detail
-
getMediaPK
public MediaPK getMediaPK()
-
setMediaPK
public void setMediaPK(MediaPK mediaPK)
-
setId
public void setId(String mediaId)
-
getId
public String getId()
- Specified by:
getIdin interfaceorg.silverpeas.core.Identifiable- Specified by:
getIdin interfaceorg.silverpeas.core.contribution.model.SilverpeasContent
-
setComponentInstanceId
public void setComponentInstanceId(String instanceId)
-
getInstanceId
public String getInstanceId()
- Specified by:
getInstanceIdin interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
getContributionType
public String getContributionType()
- Specified by:
getContributionTypein interfaceorg.silverpeas.core.contribution.model.Contribution
-
getType
public abstract MediaType getType()
-
getTitle
public String getTitle()
- Specified by:
getTitlein interfaceorg.silverpeas.core.contribution.model.Contribution
-
setTitle
public void setTitle(String title)
-
getDescription
public String getDescription()
- Specified by:
getDescriptionin interfaceorg.silverpeas.core.contribution.model.Contribution- Specified by:
getDescriptionin interfaceorg.silverpeas.core.Nameable
-
setDescription
public void setDescription(String description)
-
getAuthor
public String getAuthor()
-
setAuthor
public void setAuthor(String author)
-
getKeyWord
public String getKeyWord()
-
setKeyWord
public void setKeyWord(String keyWord)
-
getVisibilityPeriod
public org.silverpeas.core.date.period.Period getVisibilityPeriod()
-
setVisibilityPeriod
public void setVisibilityPeriod(org.silverpeas.core.date.period.Period visibilityPeriod)
-
isVisible
public boolean isVisible()
-
isVisible
protected boolean isVisible(Date today)
-
getCreationDate
public Date getCreationDate()
- Specified by:
getCreationDatein interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface- Specified by:
getCreationDatein interfaceorg.silverpeas.core.SilverpeasResource
-
setCreationDate
public void setCreationDate(Date createDate)
-
getCreator
public org.silverpeas.core.admin.user.model.User getCreator()
- Specified by:
getCreatorin interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface- Specified by:
getCreatorin interfaceorg.silverpeas.core.SilverpeasResource
-
setCreator
public void setCreator(org.silverpeas.core.admin.user.model.User creator)
-
getCreatorId
public String getCreatorId()
- Specified by:
getCreatorIdin interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
setCreatorId
public void setCreatorId(String creatorId)
-
getCreatorName
public String getCreatorName()
-
getLastUpdateDate
public Date getLastUpdateDate()
- Specified by:
getLastUpdateDatein interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface- Specified by:
getLastUpdateDatein interfaceorg.silverpeas.core.SilverpeasResource
-
setLastUpdateDate
public void setLastUpdateDate(Date lastUpdateDate)
-
getLastUpdater
public org.silverpeas.core.admin.user.model.User getLastUpdater()
- Specified by:
getLastUpdaterin interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface- Specified by:
getLastUpdaterin interfaceorg.silverpeas.core.SilverpeasResource
-
setLastUpdater
public void setLastUpdater(org.silverpeas.core.admin.user.model.User lastUpdater)
-
getLastUpdatedBy
public String getLastUpdatedBy()
-
setLastUpdatedBy
public void setLastUpdatedBy(String lastUpdatedBy)
-
getLastUpdaterName
public String getLastUpdaterName()
-
canBeAccessedBy
public boolean canBeAccessedBy(org.silverpeas.core.admin.user.model.User user)
- Specified by:
canBeAccessedByin interfaceorg.silverpeas.core.contribution.model.Contribution- Specified by:
canBeAccessedByin interfaceorg.silverpeas.core.security.Securable
-
getWorkspaceSubFolderName
public String getWorkspaceSubFolderName()
Gets the sub folder name of the media in the Silverpeas workspace.- Returns:
- the sub folder name of the media.
-
getPermalink
public String getPermalink()
Gets the permalink of a media.- Specified by:
getPermalinkin interfaceorg.silverpeas.core.contribution.model.WithPermanentLink- Returns:
- the permalink string of a media.
-
isPreviewable
public boolean isPreviewable()
Indicates if the media is previewable.- Returns:
- true if the media is previewable, false otherwise.
-
getApplicationThumbnailUrl
public String getApplicationThumbnailUrl(MediaResolution mediaResolution)
Gets the Application URL thumbnail of the media according the specified media resolution.- Parameters:
mediaResolution- resolution of the media- Returns:
- the URL of media thumbnail.
-
getApplicationEmbedUrl
public String getApplicationEmbedUrl(MediaResolution mediaResolution)
Gets the Application URL thumbnail of the media according the specified media resolution.- Parameters:
mediaResolution-- Returns:
- the URL of media thumbnail.
-
getApplicationOriginalUrl
public String getApplicationOriginalUrl()
Gets the original URL of a media with cache handling.- Returns:
- the URL of the media
-
getFile
public org.silverpeas.core.io.file.SilverpeasFile getFile(MediaResolution mediaResolution)
Gets the Silverpeas file.- Parameters:
mediaResolution- the aimed resolution.- Returns:
- a
SilverpeasFileinstance which could represents also an non existing file.
-
getFile
public abstract org.silverpeas.core.io.file.SilverpeasFile getFile(MediaResolution mediaResolution, String size)
Gets the Silverpeas file.- Parameters:
mediaResolution- the aimed resolution.size- a specific size applied on the aimed resolution, ignored if not defined.- Returns:
- a
SilverpeasFileinstance which could represents also an non existing file.
-
getSilverpeasContentId
public String getSilverpeasContentId()
- Specified by:
getSilverpeasContentIdin interfaceorg.silverpeas.core.contribution.model.SilverpeasContent
-
setSilverpeasContentId
public void setSilverpeasContentId(String silverpeasContentId)
-
setIconUrl
public void setIconUrl(String iconUrl)
-
getIconUrl
public String getIconUrl()
- Specified by:
getIconUrlin interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
isDownloadable
public boolean isDownloadable()
Indicated if the download is possible.- Returns:
- true if download is possible, false otherwise.
-
getURL
public String getURL()
- Specified by:
getURLin interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
getDate
public String getDate()
- Specified by:
getDatein interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
getSilverCreationDate
public String getSilverCreationDate()
- Specified by:
getSilverCreationDatein interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
getName
public String getName()
- Specified by:
getNamein interfaceorg.silverpeas.core.contribution.model.Contribution- Specified by:
getNamein interfaceorg.silverpeas.core.Nameable- Specified by:
getNamein interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
getName
public String getName(String language)
- Specified by:
getNamein interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
getDescription
public String getDescription(String language)
- Specified by:
getDescriptionin interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
getLanguages
public Collection<String> getLanguages()
- Specified by:
getLanguagesin interfaceorg.silverpeas.core.contribution.contentcontainer.content.SilverContentInterface
-
getInternalMedia
public InternalMedia getInternalMedia()
Gets the internal media instance if type of the current media isMediaType.PhotoorMediaType.VideoorMediaType.Sound.- Returns:
- internal media instance, null if media type is not
MediaType.PhotoorMediaType.VideoorMediaType.Sound.
-
getPhoto
public Photo getPhoto()
Gets the photo instance if type of the current media isMediaType.Photo.- Returns:
- photo instance, null if media type is not
MediaType.Photo.
-
getVideo
public Video getVideo()
Gets the video instance if type of the current media isMediaType.Video.- Returns:
- video instance, null if media type is not
MediaType.Video.
-
getSound
public Sound getSound()
Gets the sound instance if type of the current media isMediaType.Sound.- Returns:
- sound instance, null if media type is not
MediaType.Sound.
-
getStreaming
public Streaming getStreaming()
Gets the streaming instance if type of the current media isMediaType.Streaming.- Returns:
- streaming instance, null if media type is not
MediaType.Streaming.
-
removeFromAllAlbums
public void removeFromAllAlbums()
Removes the current media from all albums which it is attached to.
-
addToAlbums
public void addToAlbums(String... albumIds)
Adds the current media to the album represented by specified identifiers.- Parameters:
albumIds- the identifier of albums.
-
setToAlbums
public void setToAlbums(String... albumIds)
Sets the current media to the album represented by specified identifiers. (all not specified album attachments will be deleted)- Parameters:
albumIds- the identifier of albums.
-
getHighestUserRole
protected org.silverpeas.core.admin.user.model.SilverpeasRole getHighestUserRole(org.silverpeas.core.admin.user.model.User user)
Retrieve highest user role- Parameters:
user- the current user detail- Returns:
- the highest user role
-
getCopy
public abstract Media getCopy()
Creates a copy of the instance.- Returns:
- the new instance.
-
-