Package com.priint.pubserver.plugin.entitydata

Class MediaAsset

java.lang.Object

com.priint.pubserver.plugin.entitydata.MediaAsset

All Implemented Interfaces:

GetContext, GetIdentifier, GetSequence, EntityData, PersistentData, Serializable

@Entity
public class MediaAsset
extends Object
implements 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 enum	MediaAsset.properties

Constructor Summary

Constructors

Constructor	Description
MediaAsset()
MediaAsset(String identifier, String label, Context context, String entityMediaAssetId, String bucketId, String createdBy, Date createdOn, String updatedBy, Date updatedOn)

Method Summary

Modifier and Type	Method	Description
Bucket	getBucket()
String	getBucketId()
ConnectorEntity	getConnectorEntity()
List<ContentMetaData>	getContentMetaData()
Context	getContext()	Get the context for this element or null if not set.
String	getCreatedBy()
Date	getCreatedOn()
EntityMediaAsset	getEntity()
String	getEntityIdentifier()	Identifier of an entity in the entity model where the current object refers to.
String	getEntityMediaAssetId()
String	getGroupIdentifier()	String key for grouping texts of the same type.
String	getIdentifier()	Get the string identifier of the asset.
String	getLabel()	Display label for the asset.
List<MediaObject>	getMediaObjects()
List<KeyValue>	getMetaData()
String	getOrigin()
int	getSequence()	Get sequence number for the asset as given in the content system.
String	getTemplate()
List<Text>	getTexts()
String	getTimestamp()	Get timestamp from the content system.
String	getUpdatedBy()
Date	getUpdatedOn()
String	getVersion()	Version string from the content system
void	setBucket(Bucket bucket)	Sets bucket and bucketId.
void	setBucketId(String bucketId)	Sets bucketId and eventually removes current bucket if it does not match the id
void	setConnectorEntity(ConnectorEntity connectorEntity)
void	setContentMetaData(List<ContentMetaData> contentMetaData)
void	setContext(Context context)	set the context of entity data object
void	setCreatedBy(String createdBy)
void	setCreatedOn(Date createdOn)
void	setEntity(EntityMediaAsset entityMediaAsset)	Sets entityMediaAsset and entityMediaAssetId.
void	setEntityIdentifier(String entityIdentifier)	Identifier of an entity in the entity model where the current object refers to.
void	setEntityMediaAssetId(String entityMediaAssetId)	Sets entityMediaAssetId and eventually removes current entityMediaAsset if it does not match the id
void	setGroupIdentifier(String groupIdentifier)
void	setIdentifier(String identifier)
void	setLabel(String label)
void	setMediaObjects(List<MediaObject> mediaObjects)
void	setMetaData(List<KeyValue> metaData)
void	setOrigin(String origin)
void	setSequence(int sequence)
void	setTemplate(String template)
void	setTexts(List<Text> texts)
void	setTimestamp(String timestamp)
void	setUpdatedBy(String updatedBy)
void	setUpdatedOn(Date updatedOn)
void	setVersion(String version)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

MediaAsset

public MediaAsset()

MediaAsset

public MediaAsset(String identifier,
 String label,
 Context context,
 String entityMediaAssetId,
 String bucketId,
 String createdBy,
 Date createdOn,
 String updatedBy,
 Date updatedOn)

Parameters:

identifier - getIdentifier()

label - getLabel()

context - getContext()

entityMediaAssetId - getEntityMediaAssetId()

bucketId - getBucketId()

createdBy - getCreatedBy()

createdOn - getCreatedOn()

updatedBy - getUpdatedBy()

updatedOn - getUpdatedOn()

Method Details

getIdentifier

public String getIdentifier()

Get the string identifier of the asset.

Specified by:

getIdentifier in interface EntityData

Specified by:

getIdentifier in interface GetIdentifier

Specified by:

getIdentifier in interface PersistentData

Returns:

identifier string or null if not set

setIdentifier

public void setIdentifier(String identifier)

Specified by:

setIdentifier in interface EntityData

Parameters:

identifier - see getIdentifier()

getVersion

public String getVersion()

Version string from the content system

Returns:

version string or null if not set

setVersion

public void setVersion(String version)

Parameters:

version - see getVersion()

getTimestamp

public 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(String timestamp)

Parameters:

timestamp - see getTimestamp()

getLabel

public String getLabel()

Display label for the asset.

Returns:

label or null if not set

setLabel

public void setLabel(String label)

Parameters:

label - see getLabel()

getTemplate

public String getTemplate()

Returns:

String identifier of the template to render this content.

setTemplate

public void setTemplate(String template)

Parameters:

template - getTemplate()

getContext

public Context getContext()

Get the context for this element or null if not set.

Specified by:

getContext in interface EntityData

Specified by:

getContext in interface GetContext

Returns:

context

setContext

public void setContext(Context context)

Description copied from interface: EntityData

set the context of entity data object

Specified by:

setContext in interface EntityData

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:

getSequence in interface GetSequence

Returns:

ordered position within a list sequenceable objects

setSequence

public void setSequence(int sequence)

Parameters:

sequence - see getSequence()

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 List<Text> getTexts()

Returns:

List of text (e.g. image sub line).

List is LAZY loaded.

setTexts

public void setTexts(List<Text> texts)

Parameters:

texts - getTexts()

getMediaObjects

public List<MediaObject> getMediaObjects()

Returns:

List of media object like image files in different formats and resolutions.

List is LAZY loaded.

setMediaObjects

public void setMediaObjects(List<MediaObject> mediaObjects)

Parameters:

mediaObjects - getMediaObjects()

getMetaData

public List<KeyValue> getMetaData()

Returns:

List of meta data related to the bucket or empty list.

List is LAZY loaded.

setMetaData

public void setMetaData(List<KeyValue> metaData)

Parameters:

metaData - see getMetaData()

getGroupIdentifier

public String getGroupIdentifier()

String key for grouping texts of the same type.

Returns:

group identifier string or null if not set

setGroupIdentifier

public void setGroupIdentifier(String groupIdentifier)

Parameters:

groupIdentifier - see getGroupIdentifier()

getConnectorEntity

public ConnectorEntity getConnectorEntity()

Returns:

connector entity object or null if not set

setConnectorEntity

public void setConnectorEntity(ConnectorEntity connectorEntity)

Parameters:

connectorEntity - see getConnectorEntity()

getEntityMediaAssetId

public String getEntityMediaAssetId()

Returns:

Identifier of related entity in entity model.

setEntityMediaAssetId

public void setEntityMediaAssetId(String entityMediaAssetId)

Sets entityMediaAssetId and eventually removes current entityMediaAsset if it does not match the id

Parameters:

entityMediaAssetId - getEntityMediaAssetId()

getBucketId

public 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(String bucketId)

Sets bucketId and eventually removes current bucket if it does not match the id

Parameters:

bucketId - getBucketId()

getCreatedBy

public String getCreatedBy()

Returns:

creation user or null if not set

setCreatedBy

public void setCreatedBy(String createdBy)

Parameters:

createdBy - see getCreatedBy()

getCreatedOn

public Date getCreatedOn()

Returns:

creation date or null if not set

setCreatedOn

public void setCreatedOn(Date createdOn)

Parameters:

createdOn - see getCreatedOn()

getUpdatedBy

public String getUpdatedBy()

Returns:

last modified user or null if not set

setUpdatedBy

public void setUpdatedBy(String updatedBy)

Parameters:

updatedBy - see getUpdatedBy()

getUpdatedOn

public Date getUpdatedOn()

Returns:

last modified date or null if not set

setUpdatedOn

public void setUpdatedOn(Date updatedOn)

Parameters:

updatedOn - see getUpdatedOn()

toString

public String toString()

Overrides:

toString in class Object

getOrigin

public 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(String origin)

Parameters:

origin - getOrigin()

getEntityIdentifier

public String getEntityIdentifier()

Description copied from interface: EntityData

Identifier of an entity in the entity model where the current object refers to.

Specified by:

getEntityIdentifier in interface EntityData

Returns:

entity identifier as string

setEntityIdentifier

public void setEntityIdentifier(String entityIdentifier)

Description copied from interface: EntityData

Identifier of an entity in the entity model where the current object refers to.

Specified by:

setEntityIdentifier in interface EntityData

getContentMetaData

public 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(List<ContentMetaData> contentMetaData)

Parameters:

contentMetaData - getContentMetaData()