Package de.hybris.platform.impex.jalo

Class ImpExMedia

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.GeneratedAbstractMedia
de.hybris.platform.jalo.media.AbstractMedia
de.hybris.platform.jalo.media.GeneratedMedia
de.hybris.platform.jalo.media.Media
de.hybris.platform.impex.jalo.GeneratedImpExMedia
de.hybris.platform.impex.jalo.ImpExMedia
All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
GeneratedHeaderLibrary, GeneratedImpExExportMedia
public class ImpExMedia extends GeneratedImpExMedia
Media item representing medias used for ImpEx processing (import/export). ImpEx is a CSV-based import/export engine and therefore the used medias are needing the ability of setting the used CSV-specific properties like the field separator or encoding. So, this media type adds this properties to the media type.
See Also:

  • Constructor Details

    • ImpExMedia

      public ImpExMedia()

  • 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 Media
      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

    • copySettings

      public void copySettings(ImpExMedia media)
      Sets the ImpEx specific settings of this media to the given one.
      Parameters:
      media - media which will get the same ImpEx specific settings as this one

    • copyData

      public void copyData(ImpExMedia media) throws JaloBusinessException
      Copies the data of this media to the given one.
      Parameters:
      media - media to which data of this media will be written
      Throws:
      JaloBusinessException - error while reading or writing to media

    • getPreview

      public String getPreview(SessionContext ctx)
      Description copied from class: GeneratedImpExMedia
      Generated method - Getter of the ImpExMedia.preview attribute.
      Specified by:
      getPreview in class GeneratedImpExMedia
      Returns:
      the preview - Preview of content