com.broadleafcommerce.dataimport.csv.cellprocessor

Class MediaParsingCellProcessor

java.lang.Object

org.supercsv.cellprocessor.CellProcessorAdaptor

com.broadleafcommerce.dataimport.csv.cellprocessor.BroadleafCellProcessorAdaptor

com.broadleafcommerce.dataimport.csv.cellprocessor.MediaParsingCellProcessor

All Implemented Interfaces:

BroadleafCellProcessor, org.springframework.core.Ordered, org.supercsv.cellprocessor.ift.CellProcessor

Direct Known Subclasses:

SingleMediaProcessor

@Component(value="blMediaParsingCellProcessor")
public class MediaParsingCellProcessor
extends BroadleafCellProcessorAdaptor

Parses a value of the form primary:/cmsstatic/val1.png|alt1:/cmsstatic/val2.png|alt2:/cmsstatic/val3.png|alt3:/cmsstatic/val4.png into unique media items.

In the above example, that would be parsed into individual medai tiems like:

  [
      { "key": "primary", "url":"/cmsstatic/val1.png"},
      { "key": "alt1", "url":"/cmsstatic/val2.png"},
      { "key": "alt2", "url":"/cmsstatic/val3.png"},
      { "key": "alt3", "url":"/cmsstatic/val4.png"}
  ]
    
  

Author:

Elbert Bautista (elbertbautista), Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY_MEDIA_FIELD_NAME
protected DynamicEntityDaoProvider	entityDaoProvider
protected org.broadleafcommerce.openadmin.server.factory.PersistencePackageFactory	persistencePackageFactory
static String	PRODUCT_MEDIA_FIELD_NAME

Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor

next

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
MediaParsingCellProcessor()

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(String header, ImportType importType) Determines if this processor can be used to handle the given header within the context of an import of the given importingClass
protected List<org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest>	createPersistenceRequests(List<MediaResult> media, BroadleafCsvContext context)
ColumnParseResult	execute(String value, BroadleafCsvContext context) Parses out the String value that appears in the CSV file.
String	getMediaField(String header, ImportType importType)
protected List<MediaResult>	parseMediaString(String media) 1-element will be treated as just the value without a key.

Methods inherited from class com.broadleafcommerce.dataimport.csv.cellprocessor.BroadleafCellProcessorAdaptor

execute, getOrder

Methods inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor

toString, validateInputNotNull

Methods inherited from class java.lang.Object

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

Field Detail

PRODUCT_MEDIA_FIELD_NAME

public static final String PRODUCT_MEDIA_FIELD_NAME

See Also:

Constant Field Values

CATEGORY_MEDIA_FIELD_NAME

public static final String CATEGORY_MEDIA_FIELD_NAME

See Also:

Constant Field Values

entityDaoProvider

protected DynamicEntityDaoProvider entityDaoProvider

persistencePackageFactory

protected org.broadleafcommerce.openadmin.server.factory.PersistencePackageFactory persistencePackageFactory

Constructor Detail

MediaParsingCellProcessor

public MediaParsingCellProcessor()

Method Detail

canHandle

public boolean canHandle(String header,
                         ImportType importType)

Description copied from interface: BroadleafCellProcessor

Determines if this processor can be used to handle the given header within the context of an import of the given importingClass

Parameters:

header - the header that appears in the CSV

importType - the type of import

Returns:

true if this can process the header, false otherwise.

execute

public ColumnParseResult execute(String value,
                                 BroadleafCsvContext context)

Description copied from interface: BroadleafCellProcessor

Parses out the String value that appears in the CSV file. This should never return null and instead should always return a valid instance of ColumnParseResult. The ColumnParseResult.getVal() could be null.

Parameters:

value - the raw value that was parsed out of the CSV row, could be null if the value was ommitted

context - the context that the value appears in in relation to the rest of the line

Returns:

a new ColumnParseResult indicating either the parsed value or sub-persistence packages that should be executed

createPersistenceRequests

protected List<org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest> createPersistenceRequests(List<MediaResult> media,
                                                                                                                  BroadleafCsvContext context)

getMediaField

public String getMediaField(String header,
                            ImportType importType)

parseMediaString

protected List<MediaResult> parseMediaString(String media)

1-element will be treated as just the value without a key. Syntax is key1:val1|key2:val2|key3:val3 Return key-value pairs representing media keys and values

Parameters:

media -