Class MediaObject
- java.lang.Object
-
- com.priint.pubserver.plugin.entitydata.MediaObject
-
- All Implemented Interfaces:
GetIdentifier,EntityData,PersistentData,java.io.Serializable
@Entity public class MediaObject extends java.lang.Object implements java.io.Serializable, GetIdentifier, EntityData, PersistentData
Represents a file or an object in a Media Asset System
MediaObject is used to designate an individual images (or other media object).
- Since:
- 4.0.0, 4.0.5 added JPA annotations
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMediaObject.properties
-
Constructor Summary
Constructors Constructor Description MediaObject()Default constructor.MediaObject(java.lang.String identifier, java.lang.String filename, java.lang.String path, java.lang.String type, java.lang.String media)Creates a media object with necessary properties.MediaObject(java.lang.String identifier, java.lang.String filename, java.lang.String path, java.lang.String type, java.lang.String media, java.lang.String createdBy, java.util.Date createdOn, java.lang.String updatedBy, java.util.Date updatedOn)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ConnectorEntitygetConnectorEntity()Deprecated.MediaObject has no connector entity that can be set via ison.ContextgetContext()java.lang.StringgetCreatedBy()java.util.DategetCreatedOn()java.lang.StringgetEntityIdentifier()Identifier of an entity in the entity model where the current object refers to.java.lang.StringgetFilename()java.lang.StringgetFullpath()java.lang.StringgetGroupIdentifier()String key for grouping media objects of the same type.intgetId()java.lang.StringgetIdentifier()Get the string identifier of the media object.java.lang.StringgetMedia()Optional media content.MediaAssetgetMediaAsset()java.util.List<KeyValue>getMetaData()java.lang.StringgetPath()java.lang.StringgetTimestamp()Get timestamp from the content system.java.lang.StringgetType()Type like JPEG , EPS, etc.java.lang.StringgetUpdatedBy()java.util.DategetUpdatedOn()java.lang.StringgetUrl()java.lang.StringgetVersion()Version string from the content systemvoidsetConnectorEntity(ConnectorEntity connectorEntity)Deprecated.MediaObject has no connector entity that can be set via ison.voidsetContext(Context context)set the context of entity data objectvoidsetCreatedBy(java.lang.String createdBy)voidsetCreatedOn(java.util.Date createdOn)voidsetEntityIdentifier(java.lang.String entityIdentifier)Identifier of an entity in the entity model where the current object refers to.voidsetFilename(java.lang.String filename)voidsetGroupIdentifier(java.lang.String groupIdentifier)voidsetId(int id)voidsetIdentifier(java.lang.String identifier)voidsetMedia(java.lang.String media)voidsetMediaAsset(MediaAsset mediaAsset)voidsetMetaData(java.util.List<KeyValue> metaData)voidsetPath(java.lang.String path)voidsetTimestamp(java.lang.String timestamp)voidsetType(java.lang.String type)voidsetUpdatedBy(java.lang.String updatedBy)voidsetUpdatedOn(java.util.Date updatedOn)voidsetUrl(java.lang.String url)voidsetVersion(java.lang.String version)java.lang.StringtoString()
-
-
-
Constructor Detail
-
MediaObject
public MediaObject()
Default constructor.
-
MediaObject
public MediaObject(java.lang.String identifier, java.lang.String filename, java.lang.String path, java.lang.String type, java.lang.String media)Creates a media object with necessary properties.- Parameters:
identifier-getIdentifier()filename-getFilename()path-getPath()type-getType()media-getMedia()
-
MediaObject
public MediaObject(java.lang.String identifier, java.lang.String filename, java.lang.String path, java.lang.String type, java.lang.String media, java.lang.String createdBy, java.util.Date createdOn, java.lang.String updatedBy, java.util.Date updatedOn)- Parameters:
identifier-getIdentifier()filename-getFilename()path-getPath()type-getType()media-getMedia()createdBy-getCreatedBy()createdOn-getCreatedOn()updatedBy-getUpdatedBy()updatedOn-getUpdatedOn()
-
-
Method Detail
-
getId
public int getId()
-
setId
public void setId(int id)
-
getIdentifier
public java.lang.String getIdentifier()
Get the string identifier of the media object.- Specified by:
getIdentifierin interfaceEntityData- Specified by:
getIdentifierin interfaceGetIdentifier- Specified by:
getIdentifierin interfacePersistentData- Returns:
- identifier string or
nullif not set
-
setIdentifier
public void setIdentifier(java.lang.String identifier)
- Specified by:
setIdentifierin interfaceEntityData- Parameters:
identifier- seegetIdentifier()
-
getGroupIdentifier
public java.lang.String getGroupIdentifier()
String key for grouping media objects of the same type.- Returns:
- group identifier string or
nullif not set
-
setGroupIdentifier
public void setGroupIdentifier(java.lang.String groupIdentifier)
- Parameters:
groupIdentifier- seegetGroupIdentifier()
-
getConnectorEntity
@Deprecated public ConnectorEntity getConnectorEntity()
Deprecated.MediaObject has no connector entity that can be set via ison.- Returns:
- connector entity object or
nullif not set
-
setConnectorEntity
@Deprecated public void setConnectorEntity(ConnectorEntity connectorEntity)
Deprecated.MediaObject has no connector entity that can be set via ison.- Parameters:
connectorEntity-
-
getVersion
public java.lang.String getVersion()
Version string from the content system- Returns:
- version string or
nullif not set
-
setVersion
public void setVersion(java.lang.String version)
- Parameters:
version- seegetVersion()
-
getTimestamp
public java.lang.String getTimestamp()
Get timestamp from the content system.Timestamp is used as a string to support differing types of timestamp representation as used by different content system. publishing server does not validate any format of this string.
- Returns:
- timestamp string
-
setTimestamp
public void setTimestamp(java.lang.String timestamp)
- Parameters:
timestamp- seegetTimestamp()
-
getFilename
public java.lang.String getFilename()
- Returns:
- Name of the file (with extension).
-
setFilename
public void setFilename(java.lang.String filename)
- Parameters:
filename-getFilename()
-
getPath
public java.lang.String getPath()
- Returns:
- System path without filename.
-
setPath
public void setPath(java.lang.String path)
- Parameters:
path-getPath()
-
getType
public java.lang.String getType()
Type like JPEG , EPS, etc.At the time being there is no fixed vocabulary on media object types.
It is recommended practice to use types from the IANA MIME type registry.- Returns:
- type
-
setType
public void setType(java.lang.String type)
- Parameters:
type-getType()
-
getUrl
public java.lang.String getUrl()
- Returns:
- URL to media asset system
-
setUrl
public void setUrl(java.lang.String url)
- Parameters:
url-getUrl()
-
getMetaData
public java.util.List<KeyValue> getMetaData()
- Returns:
- List of meta data related to the bucket or empty list
-
setMetaData
public void setMetaData(java.util.List<KeyValue> metaData)
- Parameters:
metaData- seegetMetaData()
-
getMedia
public java.lang.String getMedia()
Optional media content.- Returns:
- content as string
-
setMedia
public void setMedia(java.lang.String media)
- Parameters:
media-getMedia()
-
getCreatedBy
public java.lang.String getCreatedBy()
- Returns:
- creation user or
nullif not set
-
setCreatedBy
public void setCreatedBy(java.lang.String createdBy)
- Parameters:
createdBy- seegetCreatedBy()
-
getCreatedOn
public java.util.Date getCreatedOn()
- Returns:
- creation date or
nullif not set
-
setCreatedOn
public void setCreatedOn(java.util.Date createdOn)
- Parameters:
createdOn- seegetCreatedOn()
-
getUpdatedBy
public java.lang.String getUpdatedBy()
- Returns:
- last modified user or
nullif not set
-
setUpdatedBy
public void setUpdatedBy(java.lang.String updatedBy)
- Parameters:
updatedBy- seegetUpdatedBy()
-
getUpdatedOn
public java.util.Date getUpdatedOn()
- Returns:
- last modified date or
nullif not set
-
setUpdatedOn
public void setUpdatedOn(java.util.Date updatedOn)
- Parameters:
updatedOn- seegetUpdatedOn()
-
getMediaAsset
public MediaAsset getMediaAsset()
-
setMediaAsset
public void setMediaAsset(MediaAsset mediaAsset)
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getFullpath
public java.lang.String getFullpath()
- Returns:
- returns the full path of the media object concatenating path and filename
-
getEntityIdentifier
public java.lang.String getEntityIdentifier()
Description copied from interface:EntityDataIdentifier of an entity in the entity model where the current object refers to.- Specified by:
getEntityIdentifierin interfaceEntityData- Returns:
- entity identifier as string
-
setEntityIdentifier
public void setEntityIdentifier(java.lang.String entityIdentifier)
Description copied from interface:EntityDataIdentifier of an entity in the entity model where the current object refers to.- Specified by:
setEntityIdentifierin interfaceEntityData
-
getContext
public Context getContext()
- Specified by:
getContextin interfaceEntityData- Returns:
- entity context
-
setContext
public void setContext(Context context)
Description copied from interface:EntityDataset the context of entity data object- Specified by:
setContextin interfaceEntityData
-
-