A B C D E F G H I L M O P R S U V W 

A

AbstractAssetProvider - Class in info.magnolia.dam.api
Convenient abstract base class for implementations.
AbstractAssetProvider() - Constructor for class info.magnolia.dam.api.AbstractAssetProvider
 
AbstractItem<T extends AssetProvider> - Class in info.magnolia.dam.api
Common superclass for any dam Item.
AbstractItem(T, ItemKey) - Constructor for class info.magnolia.dam.api.AbstractItem
 
Asset - Interface in info.magnolia.dam.api
An asset is a digital resource with associated metadata.
AssetDecorator - Class in info.magnolia.dam.api
TODO : do we need this ? If so, maybe call it AssetWrapper to be consistent.
AssetDecorator(Asset) - Constructor for class info.magnolia.dam.api.AssetDecorator
 
AssetMetadata - Interface in info.magnolia.dam.api.metadata
A common interface for Asset Metadata.
AssetMetadataDefinition - Interface in info.magnolia.dam.api.metadata
Definition of Metadata linking the interface with unique namespace.
AssetMetadataRegistry - Interface in info.magnolia.dam.api.metadata
Wrapper of all metadata defined through multibinding.
AssetProvider - Interface in info.magnolia.dam.api
An AssetProvider exposes Folders and Assets from a particular source.
AssetProvider.AssetNotFoundException - Exception in info.magnolia.dam.api
Thrown when the given ItemKey can't be found.
AssetProvider.AssetNotFoundException(ItemKey) - Constructor for exception info.magnolia.dam.api.AssetProvider.AssetNotFoundException
 
AssetProvider.IllegalItemKeyException - Exception in info.magnolia.dam.api
Thrown when the given ItemKey isn't usable by the provider.
AssetProvider.IllegalItemKeyException(ItemKey, AssetProvider, String) - Constructor for exception info.magnolia.dam.api.AssetProvider.IllegalItemKeyException
 
AssetProviderCapability - Enum in info.magnolia.dam.api
Features optional implemented/provided by AssetProvider.
AssetProviderRegistry - Interface in info.magnolia.dam.api
Entry point to retrieve AssetProviders.
AssetProviderRegistry.NoSuchAssetProviderException - Exception in info.magnolia.dam.api
Thrown when no AssetProvider can be found for the given ItemKey or String id.
AssetProviderRegistry.NoSuchAssetProviderException(ItemKey) - Constructor for exception info.magnolia.dam.api.AssetProviderRegistry.NoSuchAssetProviderException
 
AssetProviderRegistry.NoSuchAssetProviderException(String) - Constructor for exception info.magnolia.dam.api.AssetProviderRegistry.NoSuchAssetProviderException
 
AssetProviderRegistry.NoSuchAssetRendererException - Exception in info.magnolia.dam.api
Thrown when no AssetRenderer can be found for the given Asset to be converted to the given MediaType.
AssetProviderRegistry.NoSuchAssetRendererException(String, MediaType) - Constructor for exception info.magnolia.dam.api.AssetProviderRegistry.NoSuchAssetRendererException
 
AssetQuery - Interface in info.magnolia.dam.api
Represents a query to an AssetProvider.
AssetQuery.Builder - Class in info.magnolia.dam.api
A builder for AssetQuery which provides a fluent API.
AssetQuery.Builder() - Constructor for class info.magnolia.dam.api.AssetQuery.Builder
 
AssetQuery.Order - Enum in info.magnolia.dam.api
Enumeration specifying the order of sorting.
AssetQuery.OrderBy - Class in info.magnolia.dam.api
Represents a sorting rule to be applied to a query.
AssetQuery.OrderBy(Class<? extends AssetMetadata>, String, AssetQuery.Order) - Constructor for class info.magnolia.dam.api.AssetQuery.OrderBy
 
AssetRenderer - Interface in info.magnolia.dam.api
An AssetRenderer provides AssetRenditions by bridging an Asset's data and some type of converter.
AssetRenderers - Class in info.magnolia.dam.api.util
Utility methods to work with AssetRenderers.
AssetRenderers() - Constructor for class info.magnolia.dam.api.util.AssetRenderers
 
AssetRendition - Interface in info.magnolia.dam.api
An AssetRendition is a "view" on a asset, for a specific MimeType.
asString() - Method in class info.magnolia.dam.api.ItemKey
 

B

build() - Method in class info.magnolia.dam.api.AssetQuery.Builder
 

C

canRender(Asset, MediaType) - Method in interface info.magnolia.dam.api.AssetRenderer
 

D

DamException - Exception in info.magnolia.dam.api
An abstract exception class that all DAM exceptions should extend.
DamException(String) - Constructor for exception info.magnolia.dam.api.DamException
 
DamException(String, Throwable) - Constructor for exception info.magnolia.dam.api.DamException
 
DublinCore - Interface in info.magnolia.dam.api.metadata
A collection of Dublin Core metadata names.
DublinCoreDefinition - Class in info.magnolia.dam.api.metadata
Definition of Dublin Core metadata namespace.
DublinCoreDefinition() - Constructor for class info.magnolia.dam.api.metadata.DublinCoreDefinition
 

E

equals(Object) - Method in class info.magnolia.dam.api.ItemKey
 
excludeAssets() - Method in class info.magnolia.dam.api.AssetQuery.Builder
 
excludeChildren() - Method in class info.magnolia.dam.api.AssetQuery.Builder
Deprecated.
excludeDescendants() - Method in class info.magnolia.dam.api.AssetQuery.Builder
Do not include all the descendants of the specified path or folder, only the direct children.

F

findRenderer(Asset, MediaType, List<AssetRenderer>) - Static method in class info.magnolia.dam.api.util.AssetRenderers
Simply finds a matching AssetRenderer in the given List; Should not be used in client code, just avoids redundancy in AbstractAssetProvider and AssetProviderRegistry.
Folder - Interface in info.magnolia.dam.api
A Folder represents a structural item holding Assets.
from(String) - Static method in class info.magnolia.dam.api.ItemKey
 
fromFolder(Folder) - Method in class info.magnolia.dam.api.AssetQuery.Builder
 
fromPath(String) - Method in class info.magnolia.dam.api.AssetQuery.Builder
 

G

getAdditionalQueryStatement() - Method in interface info.magnolia.dam.api.AssetQuery
Deprecated.
since 2.0. Kept around for backwards compatibility.
getAll() - Method in interface info.magnolia.dam.api.metadata.AssetMetadataRegistry
 
getAllProviders() - Method in interface info.magnolia.dam.api.AssetProviderRegistry
 
getAsset(ItemKey) - Method in interface info.magnolia.dam.api.AssetProvider
Cast-less convenience method for AssetProvider.getItem(ItemKey).
getAsset() - Method in interface info.magnolia.dam.api.AssetRendition
The Asset this rendition was created from.
getAsset(String) - Method in interface info.magnolia.dam.api.PathAwareAssetProvider
 
getAssetId() - Method in class info.magnolia.dam.api.ItemKey
 
getAssetProvider() - Method in class info.magnolia.dam.api.AbstractItem
 
getAssetProvider() - Method in class info.magnolia.dam.api.AssetDecorator
 
getAssetProvider() - Method in interface info.magnolia.dam.api.Item
 
getCaption() - Method in interface info.magnolia.dam.api.Asset
 
getCaption() - Method in class info.magnolia.dam.api.AssetDecorator
 
getChildren() - Method in interface info.magnolia.dam.api.Folder
Returns an iterator over the direct elements under this folder; returns both Assets and Folders.
getComment() - Method in interface info.magnolia.dam.api.Asset
 
getComment() - Method in class info.magnolia.dam.api.AssetDecorator
 
getContentStream() - Method in interface info.magnolia.dam.api.Asset
Opens an InputStream to the binary data of this Asset.
getContentStream() - Method in class info.magnolia.dam.api.AssetDecorator
 
getContributor() - Method in interface info.magnolia.dam.api.metadata.DublinCore
An entity responsible for making contributions to the content of the resource.
getCopyright() - Method in interface info.magnolia.dam.api.Asset
 
getCopyright() - Method in class info.magnolia.dam.api.AssetDecorator
 
getCoverage() - Method in interface info.magnolia.dam.api.metadata.DublinCore
The extent or scope of the content of the resource.
getCreated() - Method in interface info.magnolia.dam.api.Asset
 
getCreated() - Method in class info.magnolia.dam.api.AssetDecorator
 
getCreated() - Method in interface info.magnolia.dam.api.metadata.DublinCore
Date of creation of the resource.
getCreator() - Method in interface info.magnolia.dam.api.metadata.DublinCore
An entity primarily responsible for making the content of the resource.
getDate() - Method in interface info.magnolia.dam.api.metadata.DublinCore
A date associated with an event in the life cycle of the resource.
getDecorated() - Method in class info.magnolia.dam.api.AssetDecorator
 
getDescription() - Method in interface info.magnolia.dam.api.Asset
 
getDescription() - Method in class info.magnolia.dam.api.AssetDecorator
 
getDescription() - Method in interface info.magnolia.dam.api.metadata.DublinCore
An account of the content of the resource.
getExtension() - Method in interface info.magnolia.dam.api.AssetQuery
 
getFileName() - Method in interface info.magnolia.dam.api.Asset
Returns the "preferred" file name for this asset's binary.
getFileName() - Method in class info.magnolia.dam.api.AssetDecorator
 
getFileSize() - Method in interface info.magnolia.dam.api.Asset
 
getFileSize() - Method in class info.magnolia.dam.api.AssetDecorator
 
getFolder(ItemKey) - Method in interface info.magnolia.dam.api.AssetProvider
Cast-less convenience method for AssetProvider.getItem(ItemKey).
getFolder(String) - Method in interface info.magnolia.dam.api.PathAwareAssetProvider
 
getFormat() - Method in interface info.magnolia.dam.api.metadata.DublinCore
Typically, Format may include the media-type or dimensions of the resource.
getHeight() - Method in interface info.magnolia.dam.api.metadata.MagnoliaAssetMetadata
 
getIdentifier() - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
getIdentifier() - Method in interface info.magnolia.dam.api.AssetProvider
Return the AssetProvider identifier.
getIdentifier() - Method in interface info.magnolia.dam.api.metadata.DublinCore
Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system.
getItem(ItemKey) - Method in interface info.magnolia.dam.api.AssetProvider
Returns the item associated with the given ItemKey, regardless of its type.
getItem(String) - Method in interface info.magnolia.dam.api.Folder
Returns the item directly under this folder with the given name.
getItem(String) - Method in interface info.magnolia.dam.api.PathAwareAssetProvider
 
getItemKey() - Method in class info.magnolia.dam.api.AbstractItem
 
getItemKey() - Method in class info.magnolia.dam.api.AssetDecorator
 
getItemKey() - Method in interface info.magnolia.dam.api.Item
 
getKeywordSearchTerm() - Method in interface info.magnolia.dam.api.AssetQuery
 
getLanguage() - Method in interface info.magnolia.dam.api.Asset
 
getLanguage() - Method in class info.magnolia.dam.api.AssetDecorator
 
getLanguage() - Method in interface info.magnolia.dam.api.metadata.DublinCore
A language of the intellectual content of the resource.
getLastModified() - Method in interface info.magnolia.dam.api.Asset
 
getLastModified() - Method in class info.magnolia.dam.api.AssetDecorator
 
getLink() - Method in interface info.magnolia.dam.api.Asset
Returns a link to the binary of this asset; that is, a (partial) URL usable by client code to download the asset.
getLink() - Method in class info.magnolia.dam.api.AssetDecorator
 
getLink() - Method in interface info.magnolia.dam.api.AssetRendition
Returns a link to the binary of this rendition; that is, a (partial) URL usable by client code to download the rendition.
getLink(Asset, String) - Method in interface info.magnolia.dam.api.RenditionAwareAssetProvider
Deprecated.
 
getMaxResults() - Method in interface info.magnolia.dam.api.AssetQuery
 
getMediaTypes() - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
getMediaTypes() - Method in interface info.magnolia.dam.api.AssetQuery
 
getMetadata(Class<M>) - Method in interface info.magnolia.dam.api.Asset
 
getMetadata(Class<M>) - Method in class info.magnolia.dam.api.AssetDecorator
 
getMetadataClass() - Method in class info.magnolia.dam.api.AssetQuery.OrderBy
 
getMetadataClass() - Method in interface info.magnolia.dam.api.metadata.AssetMetadataDefinition
 
getMetadataClass() - Method in class info.magnolia.dam.api.metadata.DublinCoreDefinition
 
getMetadataClass() - Method in class info.magnolia.dam.api.metadata.MagnoliaAssetMetadataDefinition
 
getMimeType() - Method in interface info.magnolia.dam.api.Asset
 
getMimeType() - Method in class info.magnolia.dam.api.AssetDecorator
 
getMimeType() - Method in interface info.magnolia.dam.api.AssetRendition
The specific mime type of this rendition.
getModified() - Method in interface info.magnolia.dam.api.metadata.DublinCore
Date on which the resource was changed.
getName() - Method in class info.magnolia.dam.api.AssetDecorator
 
getName() - Method in interface info.magnolia.dam.api.Item
Returns the name of this item; this same name should be usable by Folder.getItem(String).
getNamespace() - Method in interface info.magnolia.dam.api.metadata.AssetMetadataDefinition
Unique namespace of Metadata interface.
getNamespace() - Method in class info.magnolia.dam.api.metadata.DublinCoreDefinition
 
getNamespace() - Method in class info.magnolia.dam.api.metadata.MagnoliaAssetMetadataDefinition
 
getOffset() - Method in interface info.magnolia.dam.api.AssetQuery
The number of items to skip before returning the results.
getOrder() - Method in class info.magnolia.dam.api.AssetQuery.OrderBy
 
getParent() - Method in class info.magnolia.dam.api.AssetDecorator
 
getParent() - Method in interface info.magnolia.dam.api.Item
Since Assets can not be nested, always returns a Folder.
getPath() - Method in class info.magnolia.dam.api.AssetDecorator
 
getPath() - Method in interface info.magnolia.dam.api.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.
getPropertyId() - Method in class info.magnolia.dam.api.AssetQuery.OrderBy
 
getProviderById(String) - Method in interface info.magnolia.dam.api.AssetProviderRegistry
 
getProviderCapabilities() - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
getProviderFor(ItemKey) - Method in interface info.magnolia.dam.api.AssetProviderRegistry
TODO The below is currently not implemented/implementable, we'd need a canHandle(ItemKey) method on providers Returns the first provider that declares it can handle this key.
getProviderId() - Method in class info.magnolia.dam.api.ItemKey
 
getProvidersFor(MediaType...) - Method in interface info.magnolia.dam.api.AssetProviderRegistry
Returns a Iterator of AssetProvider that support the requested mediaTypes; returns an empty Iterator if none.
getPublisher() - Method in interface info.magnolia.dam.api.metadata.DublinCore
An entity responsible for making the resource available.
getRelation() - Method in interface info.magnolia.dam.api.metadata.DublinCore
A reference to a related resource.
getRendererFor(Asset, MediaType) - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
getRendererFor(Asset, MediaType) - Method in interface info.magnolia.dam.api.AssetProvider
Returns an appropriate AssetRenderer if this provider has specific renderers, or null if there is none.
getRendererFor(Asset, MediaType) - Method in interface info.magnolia.dam.api.AssetProviderRegistry
Returns an appropriate AssetRenderer, or null if there is none.
getRenderers() - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
getRenditionName() - Method in interface info.magnolia.dam.api.AssetRendition
The name of this specific rendition, if any, as passed to AssetRenderer.render(Asset, com.google.common.net.MediaType, String).
getRights() - Method in interface info.magnolia.dam.api.metadata.DublinCore
Information about rights held in and over the resource.
getRootFolder() - Method in interface info.magnolia.dam.api.AssetProvider
The top-most folder available from this AssetProvider.
getRootFolder() - Method in interface info.magnolia.dam.api.AssetQuery
 
getRootPath() - Method in interface info.magnolia.dam.api.AssetQuery
 
getSorters() - Method in interface info.magnolia.dam.api.AssetQuery
 
getSource() - Method in interface info.magnolia.dam.api.metadata.DublinCore
A reference to a resource from which the present resource is derived.
getStream() - Method in interface info.magnolia.dam.api.AssetRendition
 
getSubject() - Method in interface info.magnolia.dam.api.Asset
 
getSubject() - Method in class info.magnolia.dam.api.AssetDecorator
 
getSubject() - Method in interface info.magnolia.dam.api.metadata.DublinCore
The topic of the content of the resource.
getTitle() - Method in interface info.magnolia.dam.api.Asset
 
getTitle() - Method in class info.magnolia.dam.api.AssetDecorator
 
getTitle() - Method in interface info.magnolia.dam.api.metadata.DublinCore
A name given to the resource.
getType() - Method in interface info.magnolia.dam.api.metadata.DublinCore
The nature or genre of the content of the resource.
getWidth() - Method in interface info.magnolia.dam.api.metadata.MagnoliaAssetMetadata
 

H

hashCode() - Method in class info.magnolia.dam.api.ItemKey
 

I

includeFolders() - Method in class info.magnolia.dam.api.AssetQuery.Builder
 
includesAssets() - Method in interface info.magnolia.dam.api.AssetQuery
 
includesChildren() - Method in interface info.magnolia.dam.api.AssetQuery
Deprecated.
includesDescendants() - Method in interface info.magnolia.dam.api.AssetQuery
Includes all the descendants of the specified path or folder, not just the direct children.
includesFolders() - Method in interface info.magnolia.dam.api.AssetQuery
 
info.magnolia.dam.api - package info.magnolia.dam.api
 
info.magnolia.dam.api.metadata - package info.magnolia.dam.api.metadata
 
info.magnolia.dam.api.util - package info.magnolia.dam.api.util
 
isAsset() - Method in class info.magnolia.dam.api.AbstractItem
 
isAsset() - Method in class info.magnolia.dam.api.AssetDecorator
 
isAsset() - Method in interface info.magnolia.dam.api.Item
A slightly more elegant way of doing (i instanceof Asset).
isFolder() - Method in class info.magnolia.dam.api.AbstractItem
 
isFolder() - Method in class info.magnolia.dam.api.AssetDecorator
 
isFolder() - Method in interface info.magnolia.dam.api.Item
A slightly more elegant way of doing (i instanceof Folder).
isRoot() - Method in interface info.magnolia.dam.api.Folder
Returns true if this folder is the root folder of this provider.
isSortable(String) - Method in interface info.magnolia.dam.api.metadata.AssetMetadata
 
isValid(String) - Static method in class info.magnolia.dam.api.ItemKey
 
Item - Interface in info.magnolia.dam.api
Defines a common interface for Asset and Folder.
ItemKey - Class in info.magnolia.dam.api
A "composite key": in the dam, every Asset and Folder are identified by its provider's ID and its provider-specific ID (i.e the ID with which the provider can uniquely identify the asset itself).
ItemKey(String, String) - Constructor for class info.magnolia.dam.api.ItemKey
 

L

list(AssetQuery) - Method in interface info.magnolia.dam.api.AssetProvider
Returns an iterator over the results matching the given AssetQuery.

M

MagnoliaAssetMetadata - Interface in info.magnolia.dam.api.metadata
Defines Magnolia-Specific metadata.
MagnoliaAssetMetadataDefinition - Class in info.magnolia.dam.api.metadata
Definition of Magnolia metadata namespace.
MagnoliaAssetMetadataDefinition() - Constructor for class info.magnolia.dam.api.metadata.MagnoliaAssetMetadataDefinition
 

O

orderBy(Class<? extends AssetMetadata>, String, AssetQuery.Order) - Method in class info.magnolia.dam.api.AssetQuery.Builder
 

P

PathAwareAssetProvider - Interface in info.magnolia.dam.api
Expose specific operations for AssetProviders which are aware of paths.
PathAwareAssetProvider.PathNotFoundException - Exception in info.magnolia.dam.api
Thrown when no Item can be found at the given path.
PathAwareAssetProvider.PathNotFoundException(String) - Constructor for exception info.magnolia.dam.api.PathAwareAssetProvider.PathNotFoundException
 
provides(MediaType) - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
provides(MediaType) - Method in interface info.magnolia.dam.api.AssetProvider
Whether this provider provides or allows the given MediaType.

R

render(Asset, MediaType, String) - Method in interface info.magnolia.dam.api.AssetRenderer
Returns a AssetRendition of the given Asset in the given MediaType.
RenditionAwareAssetProvider - Interface in info.magnolia.dam.api
Deprecated.
since 2.0.8 - should not be used, and will be removed in 2.1.
RenditionAwareAssetProvider.AssetRenditionException - Exception in info.magnolia.dam.api
Deprecated.
Thrown when rendition couldn't be generated.
RenditionAwareAssetProvider.AssetRenditionException(String, Throwable) - Constructor for exception info.magnolia.dam.api.RenditionAwareAssetProvider.AssetRenditionException
Deprecated.
 

S

setIdentifier(String) - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
setMediaTypes(List<MediaType>) - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
setRenderers(List<AssetRenderer>) - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
setupProviderCapabilities() - Method in class info.magnolia.dam.api.AbstractAssetProvider
Called by constructor, so as to setup the capabilities Set once and only one.
supports(AssetProviderCapability) - Method in class info.magnolia.dam.api.AbstractAssetProvider
 
supports(Class<M>) - Method in interface info.magnolia.dam.api.Asset
 
supports(Class<M>) - Method in class info.magnolia.dam.api.AssetDecorator
 
supports(AssetProviderCapability) - Method in interface info.magnolia.dam.api.AssetProvider
Returns true if the provider supports the given AssetProviderCapability.
supports(Class<? extends AssetMetadata>) - Method in interface info.magnolia.dam.api.AssetProvider
Whether this provider supports the given AssetMetadata type.
supports(MediaType, MediaType) - Method in interface info.magnolia.dam.api.AssetRenderer
 

U

unwrap(Asset) - Static method in class info.magnolia.dam.api.AssetDecorator
 

V

valueOf(String) - Static method in enum info.magnolia.dam.api.AssetProviderCapability
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum info.magnolia.dam.api.AssetQuery.Order
Returns the enum constant of this type with the specified name.
values() - Static method in enum info.magnolia.dam.api.AssetProviderCapability
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum info.magnolia.dam.api.AssetQuery.Order
Returns an array containing the constants of this enum type, in the order they are declared.

W

withAdditionalQueryStatement(String) - Method in class info.magnolia.dam.api.AssetQuery.Builder
 
withExtension(String) - Method in class info.magnolia.dam.api.AssetQuery.Builder
 
withKeyword(String) - Method in class info.magnolia.dam.api.AssetQuery.Builder
 
withMaxResults(long) - Method in class info.magnolia.dam.api.AssetQuery.Builder
 
withMediaType(MediaType...) - Method in class info.magnolia.dam.api.AssetQuery.Builder
 
withOffset(long) - Method in class info.magnolia.dam.api.AssetQuery.Builder
 
A B C D E F G H I L M O P R S U V W 

Copyright © 2015 Magnolia International Ltd.. All rights reserved.