org.broadleafcommerce.common.i18n.dao

Class TranslationDaoImpl

java.lang.Object

org.broadleafcommerce.common.i18n.dao.TranslationDaoImpl

All Implemented Interfaces:

TranslationDao

@Repository(value="blTranslationDao")
public class TranslationDaoImpl
extends Object
implements TranslationDao

Field Summary

Fields

Modifier and Type	Field and Description
protected DynamicDaoHelper	dynamicDaoHelper
protected javax.persistence.EntityManager	em
protected EntityConfiguration	entityConfiguration
protected TranslationServiceExtensionManager	extensionManager
protected SandBoxHelper	sandBoxHelper

Constructor Summary

Constructors

Constructor and Description
TranslationDaoImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Long	countTranslationEntries(TranslatedEntity entityType, ResultType stage) Count the number of translations for the given params.
Translation	create() Creates an empty translation instance that is not persisted to the database
void	delete(Translation translation) Deletes the given translation
protected Translation	findBestTranslation(String specificLocale, List<Translation> translations)
DynamicDaoHelper	getDynamicDaoHelper()
String	getEntityId(TranslatedEntity entityType, Object entity) Get the id for the object.
Class<?>	getEntityImpl(TranslatedEntity entity) Returns the entity implementation class based on the TranslatedEntity
Map<String,Object>	getIdPropertyMetadata(TranslatedEntity entity) Returns a map that holds the following data for the given entity: "name" --> idProperty (the name of the id property, always a String) "type" --> idProperty's type (usually either Long or String)
protected String	getUpdatedEntityId(TranslatedEntity entityType, Long idValue)
protected String	getUpdatedEntityId(TranslatedEntity entityType, String entityId)
List<Translation>	readAllTranslationEntries(TranslatedEntity entityType, ResultType stage) Read all the available translations for the given params.
List<Translation>	readAllTranslationEntries(TranslatedEntity entityType, ResultType stage, List<String> entityIds) Read all the available translations for the given params.
List<StandardCacheItem>	readConvertedTranslationEntries(TranslatedEntity entityType, ResultType stage) Read all translation entries (see TranslationDao.readAllTranslationEntries(org.broadleafcommerce.common.i18n.domain.TranslatedEntity, org.broadleafcommerce.common.extension.ResultType)), and convert those results into a list of StandardCacheItem instances.
Translation	readTranslation(TranslatedEntity entity, String entityId, String fieldName, String localeCode) Reads a translation for the requested parameters.
Translation	readTranslation(TranslatedEntity entityType, String entityId, String fieldName, String localeCode, String localeCountryCode, ResultType stage) Read a specific translation for the given params.
Translation	readTranslationById(Long translationId) Reads a translation by its own primary key
List<Translation>	readTranslations(TranslatedEntity entity, String entityId, String fieldName) Reads all translations for a given field
Translation	save(Translation translation) Persists the given translation
void	setDynamicDaoHelper(DynamicDaoHelper dynamicDaoHelper)

Methods inherited from class java.lang.Object

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

Field Detail

em

protected javax.persistence.EntityManager em

entityConfiguration

protected EntityConfiguration entityConfiguration

extensionManager

protected TranslationServiceExtensionManager extensionManager

sandBoxHelper

protected SandBoxHelper sandBoxHelper

dynamicDaoHelper

protected DynamicDaoHelper dynamicDaoHelper

Constructor Detail

TranslationDaoImpl

public TranslationDaoImpl()

Method Detail

save

public Translation save(Translation translation)

Description copied from interface: TranslationDao

Persists the given translation

Specified by:

save in interface TranslationDao

Returns:

the saved translation

create

public Translation create()

Description copied from interface: TranslationDao

Creates an empty translation instance that is not persisted to the database

Specified by:

create in interface TranslationDao

Returns:

the unsaved, empty translation

delete

public void delete(Translation translation)

Description copied from interface: TranslationDao

Deletes the given translation

Specified by:

delete in interface TranslationDao

getIdPropertyMetadata

public Map<String,Object> getIdPropertyMetadata(TranslatedEntity entity)

Description copied from interface: TranslationDao

Returns a map that holds the following data for the given entity: "name" --> idProperty (the name of the id property, always a String) "type" --> idProperty's type (usually either Long or String)

Specified by:

getIdPropertyMetadata in interface TranslationDao

Returns:

the id property's metadata

getEntityImpl

public Class<?> getEntityImpl(TranslatedEntity entity)

Description copied from interface: TranslationDao

Returns the entity implementation class based on the TranslatedEntity

Specified by:

getEntityImpl in interface TranslationDao

Returns:

the entity implementation class

readTranslationById

public Translation readTranslationById(Long translationId)

Description copied from interface: TranslationDao

Reads a translation by its own primary key

Specified by:

readTranslationById in interface TranslationDao

Returns:

the translation

readTranslations

public List<Translation> readTranslations(TranslatedEntity entity,
                                 String entityId,
                                 String fieldName)

Description copied from interface: TranslationDao

Reads all translations for a given field

Specified by:

readTranslations in interface TranslationDao

Returns:

the list of translations

readTranslation

public Translation readTranslation(TranslatedEntity entity,
                          String entityId,
                          String fieldName,
                          String localeCode)

Description copied from interface: TranslationDao

Reads a translation for the requested parameters. Returns null if there is no translation found

Specified by:

readTranslation in interface TranslationDao

Returns:

the translation

getEntityId

public String getEntityId(TranslatedEntity entityType,
                 Object entity)

Description copied from interface: TranslationDao

Get the id for the object. Can take into account hierarchical multitenancy to retrieve the original id.

Specified by:

getEntityId in interface TranslationDao

Returns:

countTranslationEntries

public Long countTranslationEntries(TranslatedEntity entityType,
                           ResultType stage)

Description copied from interface: TranslationDao

Count the number of translations for the given params.

Specified by:

countTranslationEntries in interface TranslationDao

stage - param drives whether to look for entries at a template level or standard site level (multitenant concepts). Can be IGNORE. Any multitenant behavior is ignored in the absence of the multitenant module.

Returns:

readAllTranslationEntries

public List<Translation> readAllTranslationEntries(TranslatedEntity entityType,
                                          ResultType stage)

Description copied from interface: TranslationDao

Read all the available translations for the given params.

Specified by:

readAllTranslationEntries in interface TranslationDao

stage - param drives whether to look for entries at a template level or standard site level (multitenant concepts). Can be IGNORE. Any multitenant behavior is ignored in the absence of the multitenant module.

Returns:

readAllTranslationEntries

public List<Translation> readAllTranslationEntries(TranslatedEntity entityType,
                                          ResultType stage,
                                          List<String> entityIds)

Description copied from interface: TranslationDao

Read all the available translations for the given params.

Specified by:

readAllTranslationEntries in interface TranslationDao

stage - param drives whether to look for entries at a template level or standard site level (multitenant concepts). Can be IGNORE. Any multitenant behavior is ignored in the absence of the multitenant module.

entityIds - the Translation.getEntityId() to restrict the results by

Returns:

readConvertedTranslationEntries

public List<StandardCacheItem> readConvertedTranslationEntries(TranslatedEntity entityType,
                                                      ResultType stage)

Description copied from interface: TranslationDao

Read all translation entries (see TranslationDao.readAllTranslationEntries(org.broadleafcommerce.common.i18n.domain.TranslatedEntity, org.broadleafcommerce.common.extension.ResultType)), and convert those results into a list of StandardCacheItem instances.

Specified by:

readConvertedTranslationEntries in interface TranslationDao

stage - param drives whether to look for entries at a template level or standard site level (multitenant concepts). Can be IGNORE. Any multitenant behavior is ignored in the absence of the multitenant module.

Returns:

readTranslation

public Translation readTranslation(TranslatedEntity entityType,
                          String entityId,
                          String fieldName,
                          String localeCode,
                          String localeCountryCode,
                          ResultType stage)

Description copied from interface: TranslationDao

Read a specific translation for the given params.

Specified by:

readTranslation in interface TranslationDao

stage - param drives whether to look for entries at a template level or standard site level (multitenant concepts). Can be IGNORE. Any multitenant behavior is ignored in the absence of the multitenant module.

Returns:

getUpdatedEntityId

protected String getUpdatedEntityId(TranslatedEntity entityType,
                        String entityId)

getUpdatedEntityId

protected String getUpdatedEntityId(TranslatedEntity entityType,
                        Long idValue)

findBestTranslation

protected Translation findBestTranslation(String specificLocale,
                              List<Translation> translations)

getDynamicDaoHelper

public DynamicDaoHelper getDynamicDaoHelper()

setDynamicDaoHelper

public void setDynamicDaoHelper(DynamicDaoHelper dynamicDaoHelper)