Class MediaAsset
- java.lang.Object
-
- com.priint.pubserver.plugin.entitydata.MediaAsset
-
- All Implemented Interfaces:
GetContext,GetIdentifier,GetSequence,EntityData,PersistentData,java.io.Serializable
@Entity public class MediaAsset extends java.lang.Object implements java.io.Serializable, GetIdentifier, GetContext, GetSequence, EntityData, PersistentData
Object of entity type MediaAsset, e.g. images.
An image can have more than one file for different resolutions (HighRes, LowRes) and formats (JPEG, EPS, etc) these are stored in the Media Object List.
- Since:
- 4.0.0, 4.0.5 origin attribute supported, names for mediaObject and text are used in singular, added JPA annotations, getLanguage(), getCountry(), getMediaObjectsCount() and getMetadataCount() are deprecated
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMediaAsset.properties
-
Constructor Summary
Constructors Constructor Description MediaAsset()MediaAsset(java.lang.String identifier, java.lang.String label, Context context, java.lang.String entityMediaAssetId, java.lang.String bucketId, java.lang.String createdBy, java.util.Date createdOn, java.lang.String updatedBy, java.util.Date updatedOn)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BucketgetBucket()java.lang.StringgetBucketId()ConnectorEntitygetConnectorEntity()java.util.List<ContentMetaData>getContentMetaData()ContextgetContext()Get the context for this element ornullif not set.java.lang.StringgetCreatedBy()java.util.DategetCreatedOn()EntityMediaAssetgetEntity()java.lang.StringgetEntityIdentifier()Identifier of an entity in the entity model where the current object refers to.java.lang.StringgetEntityMediaAssetId()java.lang.StringgetGroupIdentifier()String key for grouping texts of the same type.java.lang.StringgetIdentifier()Get the string identifier of the asset.java.lang.StringgetLabel()Display label for the asset.java.util.List<MediaObject>getMediaObjects()java.util.List<KeyValue>getMetaData()java.lang.StringgetOrigin()intgetSequence()Get sequence number for the asset as given in the content system.java.lang.StringgetTemplate()java.util.List<Text>getTexts()java.lang.StringgetTimestamp()Get timestamp from the content system.java.lang.StringgetUpdatedBy()java.util.DategetUpdatedOn()java.lang.StringgetVersion()Version string from the content systemvoidsetBucket(Bucket bucket)Sets bucket and bucketId.voidsetBucketId(java.lang.String bucketId)Sets bucketId and eventually removes current bucket if it does not match the idvoidsetConnectorEntity(ConnectorEntity connectorEntity)voidsetContentMetaData(java.util.List<ContentMetaData> contentMetaData)voidsetContext(Context context)set the context of entity data objectvoidsetCreatedBy(java.lang.String createdBy)voidsetCreatedOn(java.util.Date createdOn)voidsetEntity(EntityMediaAsset entityMediaAsset)Sets entityMediaAsset and entityMediaAssetId.voidsetEntityIdentifier(java.lang.String entityIdentifier)Identifier of an entity in the entity model where the current object refers to.voidsetEntityMediaAssetId(java.lang.String entityMediaAssetId)Sets entityMediaAssetId and eventually removes current entityMediaAsset if it does not match the idvoidsetGroupIdentifier(java.lang.String groupIdentifier)voidsetIdentifier(java.lang.String identifier)voidsetLabel(java.lang.String label)voidsetMediaObjects(java.util.List<MediaObject> mediaObjects)voidsetMetaData(java.util.List<KeyValue> metaData)voidsetOrigin(java.lang.String origin)voidsetSequence(int sequence)voidsetTemplate(java.lang.String template)voidsetTexts(java.util.List<Text> texts)voidsetTimestamp(java.lang.String timestamp)voidsetUpdatedBy(java.lang.String updatedBy)voidsetUpdatedOn(java.util.Date updatedOn)voidsetVersion(java.lang.String version)java.lang.StringtoString()
-
-
-
Constructor Detail
-
MediaAsset
public MediaAsset()
-
MediaAsset
public MediaAsset(java.lang.String identifier, java.lang.String label, Context context, java.lang.String entityMediaAssetId, java.lang.String bucketId, java.lang.String createdBy, java.util.Date createdOn, java.lang.String updatedBy, java.util.Date updatedOn)- Parameters:
identifier-getIdentifier()label-getLabel()context-getContext()entityMediaAssetId-getEntityMediaAssetId()bucketId-getBucketId()createdBy-getCreatedBy()createdOn-getCreatedOn()updatedBy-getUpdatedBy()updatedOn-getUpdatedOn()
-
-
Method Detail
-
getIdentifier
public java.lang.String getIdentifier()
Get the string identifier of the asset.- 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()
-
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()
-
getLabel
public java.lang.String getLabel()
Display label for the asset.- Returns:
- label or
nullif not set
-
setLabel
public void setLabel(java.lang.String label)
- Parameters:
label- seegetLabel()
-
getTemplate
public java.lang.String getTemplate()
- Returns:
- String identifier of the template to render this content.
-
setTemplate
public void setTemplate(java.lang.String template)
- Parameters:
template-getTemplate()
-
getContext
public Context getContext()
Get the context for this element ornullif not set.- Specified by:
getContextin interfaceEntityData- Specified by:
getContextin interfaceGetContext- Returns:
- context
-
setContext
public void setContext(Context context)
Description copied from interface:EntityDataset the context of entity data object- Specified by:
setContextin interfaceEntityData- Parameters:
context-getContext()
-
getEntity
public EntityMediaAsset getEntity()
- Returns:
- Entity from Entity Model
- See Also:
getEntityMediaAssetId()
-
setEntity
public void setEntity(EntityMediaAsset entityMediaAsset)
Sets entityMediaAsset and entityMediaAssetId.- Parameters:
entityMediaAsset-getEntity()- See Also:
setEntityMediaAssetId(String)
-
getSequence
public int getSequence()
Get sequence number for the asset as given in the content system.This should reflect the position of the current asset in the sorting of assets of its bucket.
- Specified by:
getSequencein interfaceGetSequence- Returns:
- ordered position within a list sequenceable objects
-
setSequence
public void setSequence(int sequence)
- Parameters:
sequence- seegetSequence()
-
getBucket
public Bucket getBucket()
- Returns:
- Parent bucket that this price is related to.
-
setBucket
public void setBucket(Bucket bucket)
Sets bucket and bucketId.- Parameters:
bucket-getBucket()- See Also:
setBucketId(String)
-
getTexts
public java.util.List<Text> getTexts()
- Returns:
- List of text (e.g. image sub line).
List is LAZY loaded.
-
setTexts
public void setTexts(java.util.List<Text> texts)
- Parameters:
texts-getTexts()
-
getMediaObjects
public java.util.List<MediaObject> getMediaObjects()
- Returns:
- List of media object like image files in different formats and resolutions.
List is LAZY loaded.
-
setMediaObjects
public void setMediaObjects(java.util.List<MediaObject> mediaObjects)
- Parameters:
mediaObjects-getMediaObjects()
-
getMetaData
public java.util.List<KeyValue> getMetaData()
- Returns:
- List of meta data related to the bucket or empty list.
List is LAZY loaded.
-
setMetaData
public void setMetaData(java.util.List<KeyValue> metaData)
- Parameters:
metaData- seegetMetaData()
-
getGroupIdentifier
public java.lang.String getGroupIdentifier()
String key for grouping texts of the same type.- Returns:
- group identifier string or
nullif not set
-
setGroupIdentifier
public void setGroupIdentifier(java.lang.String groupIdentifier)
- Parameters:
groupIdentifier- seegetGroupIdentifier()
-
getConnectorEntity
public ConnectorEntity getConnectorEntity()
- Returns:
- connector entity object or
nullif not set
-
setConnectorEntity
public void setConnectorEntity(ConnectorEntity connectorEntity)
- Parameters:
connectorEntity- seegetConnectorEntity()
-
getEntityMediaAssetId
public java.lang.String getEntityMediaAssetId()
- Returns:
- Identifier of related entity in entity model.
-
setEntityMediaAssetId
public void setEntityMediaAssetId(java.lang.String entityMediaAssetId)
Sets entityMediaAssetId and eventually removes current entityMediaAsset if it does not match the id- Parameters:
entityMediaAssetId-getEntityMediaAssetId()
-
getBucketId
public java.lang.String getBucketId()
- Returns:
- Identifier of parent bucket that this content element is related to. Is null for following methods:
EntityManagerRemote.getEntityMediaAssetsOfBucket(String, String, String, String, String, Context, String)EntityManagerRemote.getEntityMediaAssetsByIdentifier(String, String, String, String, Context, String)EntityManagerRemote.getEntityMediaAssetsOfPlannedBucket(String, String, String, String, Context, String)}EntityManagerRemote.getEntityMediaAssetsOfPlanning(String, String, String, String, String, Context, String, String)}
-
setBucketId
public void setBucketId(java.lang.String bucketId)
Sets bucketId and eventually removes current bucket if it does not match the id- Parameters:
bucketId-getBucketId()
-
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()
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getOrigin
public java.lang.String getOrigin()
- Returns:
- Origin of data entity object, e.g. name of the source system. This property is filled by the connector. Might return
null.
-
setOrigin
public void setOrigin(java.lang.String origin)
- Parameters:
origin-getOrigin()
-
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
-
getContentMetaData
public java.util.List<ContentMetaData> getContentMetaData()
- Returns:
- List of ContentMetaData related to MediaAsset.
List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.
-
setContentMetaData
public void setContentMetaData(java.util.List<ContentMetaData> contentMetaData)
- Parameters:
contentMetaData-getContentMetaData()
-
-