com.day.cq.wcm.foundation

Class WCMRenditionPicker

java.lang.Object

com.day.cq.wcm.foundation.WCMRenditionPicker

All Implemented Interfaces:

RenditionPicker

public class WCMRenditionPicker
extends java.lang.Object
implements RenditionPicker

The WCMRenditionPicker searches first the web rendition starting with "cq5dam.web.". If no web rendition exists the current original is returned.

Constructor Summary

Constructors

Constructor and Description
WCMRenditionPicker()

Method Summary

Modifier and Type	Method and Description
Rendition	getRendition(Asset asset) Returns the desired rendition Rendition if existing, otherwise null.

Methods inherited from class java.lang.Object

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

Constructor Detail

WCMRenditionPicker

public WCMRenditionPicker()

Method Detail

getRendition

public Rendition getRendition(Asset asset)

Description copied from interface: RenditionPicker

Returns the desired rendition Rendition if existing, otherwise null.

Implementations are free to decide which rendition is chosen when this method is called.

The rendition shall be searched for within the given Asset.

Example implementation:

  ...
  public Resource getRendition(Asset asset) {
      // 1. try to get a web enabled rendition
      List<Resource> renditions = asset.getRenditions();
      for (Resource rendition: renditions) {
          if (Text.getName(rendition.getPath()).startsWith("cq5dam.web.")) {
              return rendition;
          }
      }
      // 2. return current rendition
      return asset.getCurrentOriginal();
  }
  ...
 

Specified by:

getRendition in interface RenditionPicker

Parameters:

asset - The Asset within which to search the rendition.

Returns:

the desired rendition if existing, otherwise null