Package de.hybris.platform.jalo.media

Class MediaContainer

java.lang.Object
de.hybris.platform.util.BridgeAbstraction
de.hybris.platform.jalo.Item
de.hybris.platform.jalo.ExtensibleItem
de.hybris.platform.jalo.c2l.LocalizableItem
de.hybris.platform.jalo.GenericItem
de.hybris.platform.jalo.media.GeneratedMediaContainer
de.hybris.platform.jalo.media.MediaContainer
All Implemented Interfaces:
Serializable, Comparable
public class MediaContainer extends GeneratedMediaContainer
A MediaContainer acts as a container for medias in order to group the "same" image in different formats and resolutions. Different formats / resolutions are represented as instances of the type MediaFormat. The media container offers simple setter / getter methods, to retrieve / store a media in a specified MediaFormat.
Since:
3.0-u5
See Also:

  • Constructor Details

    • MediaContainer

      public MediaContainer()

  • Method Details

    • createItem

      protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException
      Description copied from class: Item
      Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

      In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
      Sn example: 

      
 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }
      Overrides:
      createItem in class GenericItem
      Parameters:
      ctx - the current session context which this item is created within
      type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )
      Returns:
      the new item instance
      Throws:
      JaloBusinessException - indicates an error during creation - any changes will be rollbacked

    • getMedia

      public Media getMedia(MediaFormat format)
      Returns media which is related to this container and has the specified format, otherwise null.
      Parameters:
      format - the format the media is needed for
      Returns:
      media managed by this container with given format or null

    • setMedia

      @Deprecated(since="ages", forRemoval=false) public void setMedia(Media media) throws JaloInvalidParameterException
      Deprecated.
      since ages
      If this MediaContainer already has a media in the format of the specified media, this media will be replaced by the specified media (old media looses relation to this container).
      Parameters:
      media - the media to set
      Throws:
      JaloInvalidParameterException