com.broadleafcommerce.dataimport.csv

Class ExternalIdUtil

java.lang.Object

com.broadleafcommerce.dataimport.csv.ExternalIdUtil

@Component(value="blExternalIdUtil")
public class ExternalIdUtil
extends Object

Extensible utility that gets the external ID header from a given row.

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.persistence.EntityManager	em
static String	EXTERNAL_ID_HEADER

Constructor Summary

Constructors

Constructor and Description
ExternalIdUtil()

Method Summary

Modifier and Type	Method and Description
javax.persistence.TypedQuery	buildExternalIdLookupQuery(Class<?> clazz, ExternalIdLookup externalIdLookup)
String	getExternalIdFieldName(Class<?> importingClass) Returns the entity field name of the external ID for the given className
String	getExternalIdFieldName(String className) Convenience method for getExternalIdFieldName(Class).
String	getExternalIdHeaderName(Class<?> importingClass) Returns the CSV column name that contains the external ID for the given className
String	getExternalIdHeaderName(String className) Convenience method for getExternalIdHeaderName(Class).

Methods inherited from class java.lang.Object

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

Field Detail

EXTERNAL_ID_HEADER

public static final String EXTERNAL_ID_HEADER

See Also:

Constant Field Values

em

protected javax.persistence.EntityManager em

Constructor Detail

ExternalIdUtil

public ExternalIdUtil()

Method Detail

getExternalIdHeaderName

public String getExternalIdHeaderName(String className)

Convenience method for getExternalIdHeaderName(Class). This will throw a RuntimeException if the given className could not be instantiated.

getExternalIdHeaderName

public String getExternalIdHeaderName(Class<?> importingClass)

Returns the CSV column name that contains the external ID for the given className

Parameters:

importingClass - the class to check

Returns:

usually just EXTERNAL_ID_HEADER but this can differ per class. For instance, the externalId from Product is on defaultSku.externalId

getExternalIdFieldName

public String getExternalIdFieldName(String className)

Convenience method for getExternalIdFieldName(Class). This will throw a RuntimeException if the given className could not be instantiated.

getExternalIdFieldName

public String getExternalIdFieldName(Class<?> importingClass)

Returns the entity field name of the external ID for the given className

Parameters:

importingClass - the class to check

Returns:

the name of the the external id field on the entity

buildExternalIdLookupQuery

public javax.persistence.TypedQuery buildExternalIdLookupQuery(Class<?> clazz,
                                                               ExternalIdLookup externalIdLookup)