Package de.hybris.platform.impex.jalo.media

Class MediaDataTranslator

java.lang.Object

de.hybris.platform.impex.jalo.translators.AbstractSpecialValueTranslator

de.hybris.platform.impex.jalo.media.MediaDataTranslator

All Implemented Interfaces:

SpecialValueTranslator

public class MediaDataTranslator
extends AbstractSpecialValueTranslator

Special translator which allows to import data from a file to a media item or vice versa.
It holds a MediaDataHandler for each thread for import/export the data. So you always have to set such an handler before using the translator.

Constructor Summary

Constructors

Constructor	Description
MediaDataTranslator()

Method Summary

Modifier and Type	Method	Description
static MediaDataHandler	getHandler()	Gets the handler currently mapped to current thread.
static boolean	hasHandler()
void	init(SpecialColumnDescriptor columnDescriptor)	Called once upon header creation to do some initial setup logic.
java.lang.String	performExport(Item processedItem)	Called each time an item is exported using the enclosing header.
void	performImport(java.lang.String cellValue, Item processedItem)	Called each time a non-empty cell value has to be imported.
static void	setMediaDataHandler(MediaDataHandler handler)	Sets the MediaDataHandler for current thread.
static void	unsetMediaDataHandler()	Unsets the handler which was mapped to the current thread for import/export.
void	validate(java.lang.String expr)	Validates the special column definition.

Methods inherited from class de.hybris.platform.impex.jalo.translators.AbstractSpecialValueTranslator

isEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaDataTranslator

public MediaDataTranslator()

Method Detail

setMediaDataHandler

public static void setMediaDataHandler(MediaDataHandler handler)

Sets the MediaDataHandler for current thread. This handler will be used for import/export if called by this thread.
ATTENTION: An already set handler will be overwritten.

Parameters:

handler - the handler which will be set for current thread.

unsetMediaDataHandler

public static final void unsetMediaDataHandler()

Unsets the handler which was mapped to the current thread for import/export.

hasHandler

public static final boolean hasHandler()

getHandler

public static final MediaDataHandler getHandler()

Gets the handler currently mapped to current thread.

Returns:

current handler mapped to current thread

init

public void init(SpecialColumnDescriptor columnDescriptor)
          throws HeaderValidationException

Description copied from interface: SpecialValueTranslator

Called once upon header creation to do some initial setup logic.

Specified by:

init in interface SpecialValueTranslator

Overrides:

init in class AbstractSpecialValueTranslator

Parameters:

columnDescriptor - the newly created column descriptor

Throws:

HeaderValidationException - indicates that the column descriptor is not configured properly

validate

public void validate(java.lang.String expr)
              throws HeaderValidationException

Description copied from interface: SpecialValueTranslator

Validates the special column definition.

Specified by:

validate in interface SpecialValueTranslator

Overrides:

validate in class AbstractSpecialValueTranslator

Parameters:

expr - the definition expression

Throws:

HeaderValidationException - if the expression is not valid

performExport

public java.lang.String performExport(Item processedItem)
                               throws ImpExException

Description copied from interface: SpecialValueTranslator

Called each time an item is exported using the enclosing header.

Specified by:

performExport in interface SpecialValueTranslator

Overrides:

performExport in class AbstractSpecialValueTranslator

Parameters:

processedItem - the item to export

Returns:

the string representation of the value to export

Throws:

ImpExException - indicates an export error

performImport

public void performImport(java.lang.String cellValue,
                          Item processedItem)
                   throws ImpExException

Description copied from interface: SpecialValueTranslator

Called each time a non-empty cell value has to be imported.

Specified by:

performImport in interface SpecialValueTranslator

Overrides:

performImport in class AbstractSpecialValueTranslator

Parameters:

cellValue - the cell value string

processedItem - the item to import the value for

Throws:

ImpExException - indicates an import error