com.day.cq.dam.scene7.api.model

Class Scene7AssetImpl

java.lang.Object

com.day.cq.dam.scene7.api.model.Scene7AssetImpl

All Implemented Interfaces:

Scene7Asset, java.io.Serializable

public class Scene7AssetImpl
extends java.lang.Object
implements Scene7Asset

Default implementation for a Scene7Asset

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scene7AssetImpl.Scene7AssetProperty Scene7 asset property keys

Constructor Summary

Constructors

Constructor and Description
Scene7AssetImpl(java.util.Map<java.lang.Object,java.lang.Object> assetAttributes) Creates a new Scene7Asset object
Scene7AssetImpl(Scene7Asset scene7Asset, java.util.Map<java.lang.Object,java.lang.Object> overrideProperties) Copy constructor useful for changing the properties for an already parsed Scene7Asset

Method Summary

Modifier and Type	Method and Description
void	addSubAsset(Scene7Asset subAsset) Adds a new sub-asset to the current asset
java.lang.String	getAssetHandle() Get this asset handle
java.util.Map<java.lang.String,java.lang.String>	getAssetProperties()
java.lang.String	getAssetSubTypeStr() Get the asset's subtype string from Scene7 (if appliable)
Scene7AssetType	getAssetType() Get the type of this asset
java.lang.String	getAssetTypeStr() Get the asset type as read from Scene7
java.lang.String	getCreatedBy() Get the user that created this asset
java.util.Date	getCreatedDate() Get the creation date of this asset
java.lang.String	getFileName() Get the file name where the asset is stored
java.lang.Integer	getFileSize() Gets the size in bytes of the file where the asset is stored
java.lang.String	getFolder() Get the folder where this asset is stored
java.lang.String	getFolderHandle() Get the Scene7 folder handle of the folder containing this asset
java.lang.Long	getHeight() Get the height of this asset
java.lang.String	getModifiedBy() Get the user that last modified this asset
java.util.Date	getModifiedDate() Get the last modified date of this asset
java.lang.String	getName() Get the name of this asset
java.lang.String	getOriginalFile() Get the original file uploaded to Scene7 for this asset
java.lang.String	getOriginalPath() Get the original path of the file uploaded to Scene7 for this asset
Scene7Asset	getOriginatorAsset() Gets the originator asset for this asset Should only return a valid asset if the current asset was generated from another uploaded asset (e.g.
java.lang.String	getRootFolder() Returns the root folder or an empty String if no folder is specified for this asset.
Scene7SmartCrop	getSmartCrop() Gets the Scene7SmartCrop object (if exists) associated with this asset
java.util.List<Scene7Asset>	getSubAssets() Returns an unmodifiable view of the internal sub-assets list
java.lang.String	getUrlModifier() Get the url modified of this asset
java.lang.String	getVideoEncodingPresetId() Gets the video encoding preset id for this asset, if this is a video scene7 asset
java.util.Map<java.lang.String,java.lang.String>	getViewerPresetConfigurationSettings() Get a map containing the viewer preset configuration for this asset
java.lang.String	getViewerPresetType() Get the viewer preset type of this asset
java.lang.Long	getWidth() Get the width of this asset
boolean	isPublished() Gets the publish status of this asset
void	updateOriginatorAsset(Scene7Asset originator) Updates the originator asset of the current asset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scene7AssetImpl

public Scene7AssetImpl(java.util.Map<java.lang.Object,java.lang.Object> assetAttributes)

Creates a new Scene7Asset object

Parameters:

assetAttributes - a Map object containing the new Scene7 asset's main attributes

Scene7AssetImpl

public Scene7AssetImpl(Scene7Asset scene7Asset,
                       java.util.Map<java.lang.Object,java.lang.Object> overrideProperties)

Copy constructor useful for changing the properties for an already parsed Scene7Asset

Parameters:

scene7Asset - the original Scene7Asset

overrideProperties - a Map containing the properties that need to be updated

Method Detail

getAssetType

public Scene7AssetType getAssetType()

Description copied from interface: Scene7Asset

Get the type of this asset

Specified by:

getAssetType in interface Scene7Asset

Returns:

A Scene7AssetType identifying this asset type

getAssetTypeStr

public java.lang.String getAssetTypeStr()

Description copied from interface: Scene7Asset

Get the asset type as read from Scene7

Specified by:

getAssetTypeStr in interface Scene7Asset

Returns:

A String object containing the actual Scene7 type string

getAssetSubTypeStr

public java.lang.String getAssetSubTypeStr()

Description copied from interface: Scene7Asset

Get the asset's subtype string from Scene7 (if appliable)

Specified by:

getAssetSubTypeStr in interface Scene7Asset

Returns:

A String object containing the Scene7 subtype string

getName

public java.lang.String getName()

Description copied from interface: Scene7Asset

Get the name of this asset

Specified by:

getName in interface Scene7Asset

Returns:

String object containing the asset's name

getAssetHandle

public java.lang.String getAssetHandle()

Description copied from interface: Scene7Asset

Get this asset handle

Specified by:

getAssetHandle in interface Scene7Asset

Returns:

String object with this asset's handle

getFileName

public java.lang.String getFileName()

Description copied from interface: Scene7Asset

Get the file name where the asset is stored

Specified by:

getFileName in interface Scene7Asset

Returns:

String containing the file name of the asset

getFolder

public java.lang.String getFolder()

Description copied from interface: Scene7Asset

Get the folder where this asset is stored

Specified by:

getFolder in interface Scene7Asset

Returns:

String containing the folder path of the asset

getFolderHandle

public java.lang.String getFolderHandle()

Description copied from interface: Scene7Asset

Get the Scene7 folder handle of the folder containing this asset

Specified by:

getFolderHandle in interface Scene7Asset

Returns:

String object containing a Scene7 folder handle

getCreatedBy

public java.lang.String getCreatedBy()

Description copied from interface: Scene7Asset

Get the user that created this asset

Specified by:

getCreatedBy in interface Scene7Asset

Returns:

String object containing the username of the user that created this asset

getModifiedBy

public java.lang.String getModifiedBy()

Description copied from interface: Scene7Asset

Get the user that last modified this asset

Specified by:

getModifiedBy in interface Scene7Asset

Returns:

String object containing the username of the user that last modified this asset

getCreatedDate

public java.util.Date getCreatedDate()

Description copied from interface: Scene7Asset

Get the creation date of this asset

Specified by:

getCreatedDate in interface Scene7Asset

Returns:

Date object with the creation time of the asset

getModifiedDate

public java.util.Date getModifiedDate()

Description copied from interface: Scene7Asset

Get the last modified date of this asset

Specified by:

getModifiedDate in interface Scene7Asset

Returns:

Date object with the time the asset was last modified

getOriginalFile

public java.lang.String getOriginalFile()

Description copied from interface: Scene7Asset

Get the original file uploaded to Scene7 for this asset

Specified by:

getOriginalFile in interface Scene7Asset

Returns:

String object containing the original file of this asset

getOriginalPath

public java.lang.String getOriginalPath()

Description copied from interface: Scene7Asset

Get the original path of the file uploaded to Scene7 for this asset

Specified by:

getOriginalPath in interface Scene7Asset

Returns:

String object containing the original path for this asset

getSubAssets

public java.util.List<Scene7Asset> getSubAssets()

Returns an unmodifiable view of the internal sub-assets list

Specified by:

getSubAssets in interface Scene7Asset

Returns:

a List with the Scene7Asset assets linked to this asset

getOriginatorAsset

public Scene7Asset getOriginatorAsset()

Description copied from interface: Scene7Asset

Gets the originator asset for this asset Should only return a valid asset if the current asset was generated from another uploaded asset (e.g. a Template asset is usually generated after importing a PSD into Scene7; the original uploaded PSD will be the Template asset's originator)

Specified by:

getOriginatorAsset in interface Scene7Asset

Returns:

a Scene7Asset object holding this asset's originator asset

updateOriginatorAsset

public void updateOriginatorAsset(Scene7Asset originator)

Description copied from interface: Scene7Asset

Updates the originator asset of the current asset

Specified by:

updateOriginatorAsset in interface Scene7Asset

Parameters:

originator - the new Scene7Asset originator of the current asset

addSubAsset

public void addSubAsset(Scene7Asset subAsset)

Description copied from interface: Scene7Asset

Adds a new sub-asset to the current asset

Specified by:

addSubAsset in interface Scene7Asset

Parameters:

subAsset - a Scene7Asset object to be added as a sub-asset of the current asset

getWidth

public java.lang.Long getWidth()

Description copied from interface: Scene7Asset

Get the width of this asset

Specified by:

getWidth in interface Scene7Asset

Returns:

a Long object containing the width of this asset

getHeight

public java.lang.Long getHeight()

Description copied from interface: Scene7Asset

Get the height of this asset

Specified by:

getHeight in interface Scene7Asset

Returns:

a Long object containing the height of this asset

getUrlModifier

public java.lang.String getUrlModifier()

Description copied from interface: Scene7Asset

Get the url modified of this asset

Specified by:

getUrlModifier in interface Scene7Asset

Returns:

a String object containing the url modifier of this asset

getViewerPresetConfigurationSettings

public java.util.Map<java.lang.String,java.lang.String> getViewerPresetConfigurationSettings()

Description copied from interface: Scene7Asset

Get a map containing the viewer preset configuration for this asset

Specified by:

getViewerPresetConfigurationSettings in interface Scene7Asset

Returns:

a Map that store the name-value pairs found in the viewer preset configuration of the asset

getViewerPresetType

public java.lang.String getViewerPresetType()

Description copied from interface: Scene7Asset

Get the viewer preset type of this asset

Specified by:

getViewerPresetType in interface Scene7Asset

Returns:

a String object containing the viewer preset type

getRootFolder

public java.lang.String getRootFolder()

Description copied from interface: Scene7Asset

Returns the root folder or an empty String if no folder is specified for this asset.

Specified by:

getRootFolder in interface Scene7Asset

Returns:

path to Root folder

isPublished

public boolean isPublished()

Description copied from interface: Scene7Asset

Gets the publish status of this asset

Specified by:

isPublished in interface Scene7Asset

Returns:

a Boolean indicating if this asset is published or not

getFileSize

public java.lang.Integer getFileSize()

Description copied from interface: Scene7Asset

Gets the size in bytes of the file where the asset is stored

Specified by:

getFileSize in interface Scene7Asset

Returns:

an Integer containing the file size

getVideoEncodingPresetId

public java.lang.String getVideoEncodingPresetId()

Description copied from interface: Scene7Asset

Gets the video encoding preset id for this asset, if this is a video scene7 asset

Specified by:

getVideoEncodingPresetId in interface Scene7Asset

Returns:

a String containing the video encoding preset for a video scene7 asset

getAssetProperties

public java.util.Map<java.lang.String,java.lang.String> getAssetProperties()

Specified by:

getAssetProperties in interface Scene7Asset

getSmartCrop

public Scene7SmartCrop getSmartCrop()

Description copied from interface: Scene7Asset

Gets the Scene7SmartCrop object (if exists) associated with this asset

Specified by:

getSmartCrop in interface Scene7Asset

Returns:

Scene7SmartCrop object