info.magnolia.dam.api

Class AssetDecorator

java.lang.Object

info.magnolia.dam.api.AssetDecorator

All Implemented Interfaces:

Asset, Item

public abstract class AssetDecorator
extends Object
implements Asset

TODO : do we need this ? If so, maybe call it AssetWrapper to be consistent. I suspect it is/was only needed because of StkAssetWrapper, and that specific wrapper might actually be wrapping a Rendition rather than an asset . . .

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssetDecorator(Asset decorated)

Method Summary

Methods

Modifier and Type	Method and Description
AssetProvider	getAssetProvider()
String	getCaption()
String	getComment()
InputStream	getContentStream() Opens an InputStream to the binary data of this Asset.
String	getCopyright()
Calendar	getCreated()
Asset	getDecorated()
String	getDescription()
String	getFileName() Returns the "preferred" file name for this asset's binary.
long	getFileSize()
ItemKey	getItemKey()
String	getLanguage()
Calendar	getLastModified()
String	getLink() Returns a link to the binary of this asset; that is, a (partial) URL usable by client code to download the asset.
<M extends AssetMetadata> M	getMetadata(Class<M> metaDataType)
String	getMimeType()
String	getName() Returns the name of this item; this same name should be usable by Folder.getItem(String).
Folder	getParent() Since Assets can not be nested, always returns a Folder.
String	getPath() Returns the canonical path to this item; in case an item is reachable by several paths, this would return the principal path that the AssetProvider knows.
String	getSubject()
String	getTitle()
boolean	isAsset() A slightly more elegant way of doing (i instanceof Asset).
boolean	isFolder() A slightly more elegant way of doing (i instanceof Folder).
static Asset	unwrap(Asset asset)

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetDecorator

protected AssetDecorator(Asset decorated)

Method Detail

unwrap

public static Asset unwrap(Asset asset)

getDecorated

public Asset getDecorated()

getItemKey

public ItemKey getItemKey()

Specified by:

getItemKey in interface Item

getAssetProvider

public AssetProvider getAssetProvider()

Specified by:

getAssetProvider in interface Item

getLink

public String getLink()

Description copied from interface: Asset

Returns a link to the binary of this asset; that is, a (partial) URL usable by client code to download the asset. Depending on the provider, this could return a URL that is relative to the current server (i.e no protocol, no hostname, but starts with a / and the context path), or an external URL including the protocol and host name. For some, this may mean generating a link to the DownloadServlet, for some it might mean something else entirely. Note: some provider may decide (based on configuration, perhaps), to *not* include the context path.

Specified by:

getLink in interface Asset

getTitle

public String getTitle()

Specified by:

getTitle in interface Asset

getSubject

public String getSubject()

Specified by:

getSubject in interface Asset

getDescription

public String getDescription()

Specified by:

getDescription in interface Asset

getCaption

public String getCaption()

Specified by:

getCaption in interface Asset

getLanguage

public String getLanguage()

Specified by:

getLanguage in interface Asset

getCopyright

public String getCopyright()

Specified by:

getCopyright in interface Asset

getComment

public String getComment()

Specified by:

getComment in interface Asset

getCreated

public Calendar getCreated()

Specified by:

getCreated in interface Asset

getLastModified

public Calendar getLastModified()

Specified by:

getLastModified in interface Asset

getMetadata

public <M extends AssetMetadata> M getMetadata(Class<M> metaDataType)

Specified by:

getMetadata in interface Asset

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface Asset

getFileSize

public long getFileSize()

Specified by:

getFileSize in interface Asset

getContentStream

public InputStream getContentStream()

Description copied from interface: Asset

Opens an InputStream to the binary data of this Asset. Client code is responsible for closing it. TODO: throw IOException ?

Specified by:

getContentStream in interface Asset

getFileName

public String getFileName()

Description copied from interface: Asset

Returns the "preferred" file name for this asset's binary. The returned name should include the file's extension (if any), but not its path.

Specified by:

getFileName in interface Asset

getPath

public String getPath()

Description copied from interface: Item

Returns the canonical path to this item; in case an item is reachable by several paths, this would return the principal path that the AssetProvider knows. Note: some providers might hide or show only a subsection of their actual data. This should return the path "relative" to that subsection.

Specified by:

getPath in interface Item

getName

public String getName()

Description copied from interface: Item

Returns the name of this item; this same name should be usable by Folder.getItem(String).

Specified by:

getName in interface Item

getParent

public Folder getParent()

Description copied from interface: Item

Since Assets can not be nested, always returns a Folder.

Specified by:

getParent in interface Item

isFolder

public boolean isFolder()

Description copied from interface: Item

A slightly more elegant way of doing (i instanceof Folder).

Specified by:

isFolder in interface Item

isAsset

public boolean isAsset()

Description copied from interface: Item

A slightly more elegant way of doing (i instanceof Asset).

Specified by:

isAsset in interface Item