de.hybris.platform.impex.jalo.translators

Class ItemExpressionTranslator

java.lang.Object

de.hybris.platform.impex.jalo.translators.AbstractValueTranslator

de.hybris.platform.impex.jalo.translators.SingleValueTranslator

de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator

Direct Known Subclasses:

AlternativeExpressionTranslator

public class ItemExpressionTranslator
extends SingleValueTranslator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ItemExpressionTranslator.CombinedSearchResult
static class	ItemExpressionTranslator.ExpressionQuery

Constructor Summary

Constructors

Constructor and Description
ItemExpressionTranslator(ComposedType targetType, List<AbstractDescriptor.ColumnParams> itemPatternList)

Method Summary

Modifier and Type	Method and Description
protected de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternEndElement	addValuePath(List<AttributeDescriptor> path, AtomicValueTranslator trans, Map modifiers, boolean isAlternative)
protected ItemExpressionTranslator.ExpressionQuery	buildQuery(ComposedType targetType, List<AbstractDescriptor.ColumnParams> itemPatternList)
protected void	checkResolvableAttribute(HeaderDescriptor header, AttributeDescriptor attributeDescriptor)
static List<ItemExpressionTranslator.CombinedSearchResult>	convertAllToJalo(Item _forItem, List<ItemExpressionTranslator> translators, List<String> expressions)
protected Object	convertToJalo(String valueExpr, Item forItem) Converts a non-null and non-empty string into a jalo attribute value.
protected String	convertToString(Object value) Converts a non-null jalo attribute value into its string representation.
protected void	createAtomicAttributeSubTranslator(AttributeDescriptor attributeDescriptor, StringBuilder stringBuilder, ComposedType type, AbstractDescriptor.ColumnParams patternElement, List<AttributeDescriptor> qualifierPath, String enclosingTableAlias, boolean isAlternative)
protected void	createDocumentIDSubTranslator(AttributeDescriptor attributeDescriptor, StringBuilder stringBuilder, ComposedType type, AbstractDescriptor.ColumnParams patternElement, List<AttributeDescriptor> qualifierPath, String enclosingTableAlias, boolean isAlternative, String documentID)
protected void	createItemAttributeSubTranslator(String qualifier, ComposedType attrType, StringBuilder stringBuilder, ComposedType type, AbstractDescriptor.ColumnParams patternElement, List<AttributeDescriptor> qualifierPath, String enclosingTableAlias, boolean isAlternative)
protected String	createNewTableAlias()
protected void	createRelationAttributeSubTranslator(RelationDescriptor relationDescriptor, StringBuilder stringBuilder, ComposedType relatedType, AbstractDescriptor.ColumnParams patternElement, List<AttributeDescriptor> qualifierPath, String enclosingTableAlias, boolean isAlternative)
protected ComposedType	createSubTranslator(StringBuilder stringBuilder, ComposedType type, AbstractDescriptor.ColumnParams patternElement, List<AttributeDescriptor> qualifierPath, String enclosingTableAlias, boolean isAlternative) Translates a single item reference expression.
protected List<de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternElement>	cutOff(List<de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternElement> original, int cutPosition)
protected String	getDocumentIDFromItemPattern(AbstractDescriptor.ColumnParams pattern)
protected Object	getEmptyValue() Returning default translation in case a default value was specified for each item path expression.
protected Map<String,Object>	getFullDefaultValueMap()
protected Language	getLanguageByIsoCode(de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternEndElement patternElement)
protected ComposedType	getMostSpecific(ComposedType baseType, Set<ComposedType> types)
protected ItemExpressionTranslator.ExpressionQuery	getQuery()
protected ComposedType	getTargetType()
void	init(StandardColumnDescriptor columnDescriptor) Called once per header creation to allow configuring this translator using column modifiers etc.
protected static String	inserIsNullIfNecessary(String queryBody, Map<String,Object> valuesIncludingNull)
protected boolean	isLocalizedAndLanguageModifierIsSet(de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternEndElement patternElement)
protected Map<String,Object>	mergeDefaultValues(List<String> parsedValues)
protected static void	mergeValues(Map<String,Object> merged, Map<String,Object> original, int tokenNumber)
protected AttributeDescriptor	resolveAttribute(ComposedType type, AbstractDescriptor.ColumnParams patternElement) Tries to find the matching attribute descriptor for a given expression pattern element.
protected static List<Object>	searchCombined(List<ItemExpressionTranslator> translators, List<Map<String,Object>> valueMaps, List<String> valueExpressions)
protected Object	searchItem(Map values, String valueExpr) Executes actual resolving of a given reference pattern by issuing a flexible search query.
protected String	toString(Item item)
void	validate(StandardColumnDescriptor columnDescriptor) Validates the value translator once per header creation.

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

exportValue, importValue, isEmpty

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

clearStatus, createTranslator, createTranslator, createTranslator, debug, error, getColumnDescriptor, getFlexibleSearch, info, isDebugEnabled, isInfoEnabled, setEmpty, setError, warn, wasEmpty, wasUnresolved

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemExpressionTranslator

public ItemExpressionTranslator(ComposedType targetType,
                                List<AbstractDescriptor.ColumnParams> itemPatternList)
                         throws HeaderValidationException

Throws:

HeaderValidationException

Method Detail

init

public void init(StandardColumnDescriptor columnDescriptor)

Description copied from class: AbstractValueTranslator

Called once per header creation to allow configuring this translator using column modifiers etc.

Overrides:

init in class AbstractValueTranslator

Parameters:

columnDescriptor - descriptor where the value to translate belongs to

getQuery

protected ItemExpressionTranslator.ExpressionQuery getQuery()

getTargetType

protected ComposedType getTargetType()

createNewTableAlias

protected String createNewTableAlias()

buildQuery

protected ItemExpressionTranslator.ExpressionQuery buildQuery(ComposedType targetType,
                                                              List<AbstractDescriptor.ColumnParams> itemPatternList)
                                                       throws HeaderValidationException

Throws:

HeaderValidationException

getMostSpecific

protected ComposedType getMostSpecific(ComposedType baseType,
                                       Set<ComposedType> types)
                                throws HeaderValidationException

Throws:

HeaderValidationException

resolveAttribute

protected AttributeDescriptor resolveAttribute(ComposedType type,
                                               AbstractDescriptor.ColumnParams patternElement)
                                        throws HeaderValidationException

Tries to find the matching attribute descriptor for a given expression pattern element. This method supports the following syntax:

        ( {itemtype} '.' )? {qualifier}
 

In case a explicite item type is specified it must be the same or subtype of the actual attribute type which encloses this expression.

Parameters:

type - the attribute type which encloses this expression

patternElement - the expression to reference the enclosing attribute value

Throws:

HeaderValidationException

addValuePath

protected de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternEndElement addValuePath(List<AttributeDescriptor> path,
                                                                                                                  AtomicValueTranslator trans,
                                                                                                                  Map modifiers,
                                                                                                                  boolean isAlternative)

cutOff

protected List<de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternElement> cutOff(List<de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternElement> original,
                                                                                                               int cutPosition)

createSubTranslator

protected ComposedType createSubTranslator(StringBuilder stringBuilder,
                                           ComposedType type,
                                           AbstractDescriptor.ColumnParams patternElement,
                                           List<AttributeDescriptor> qualifierPath,
                                           String enclosingTableAlias,
                                           boolean isAlternative)
                                    throws HeaderValidationException

Translates a single item reference expression.

Parameters:

stringBuilder -

type -

patternElement -

qualifierPath -

isAlternative -

Returns:

in case the expression describes a subtype of the expected attribute type it returns this subtype, null otherwise

Throws:

HeaderValidationException

getDocumentIDFromItemPattern

protected String getDocumentIDFromItemPattern(AbstractDescriptor.ColumnParams pattern)
                                       throws HeaderValidationException

Throws:

HeaderValidationException

createRelationAttributeSubTranslator

protected void createRelationAttributeSubTranslator(RelationDescriptor relationDescriptor,
                                                    StringBuilder stringBuilder,
                                                    ComposedType relatedType,
                                                    AbstractDescriptor.ColumnParams patternElement,
                                                    List<AttributeDescriptor> qualifierPath,
                                                    String enclosingTableAlias,
                                                    boolean isAlternative)
                                             throws HeaderValidationException

Throws:

HeaderValidationException

createItemAttributeSubTranslator

protected void createItemAttributeSubTranslator(String qualifier,
                                                ComposedType attrType,
                                                StringBuilder stringBuilder,
                                                ComposedType type,
                                                AbstractDescriptor.ColumnParams patternElement,
                                                List<AttributeDescriptor> qualifierPath,
                                                String enclosingTableAlias,
                                                boolean isAlternative)
                                         throws HeaderValidationException

Throws:

HeaderValidationException

createAtomicAttributeSubTranslator

protected void createAtomicAttributeSubTranslator(AttributeDescriptor attributeDescriptor,
                                                  StringBuilder stringBuilder,
                                                  ComposedType type,
                                                  AbstractDescriptor.ColumnParams patternElement,
                                                  List<AttributeDescriptor> qualifierPath,
                                                  String enclosingTableAlias,
                                                  boolean isAlternative)
                                           throws HeaderValidationException

Throws:

HeaderValidationException

createDocumentIDSubTranslator

protected void createDocumentIDSubTranslator(AttributeDescriptor attributeDescriptor,
                                             StringBuilder stringBuilder,
                                             ComposedType type,
                                             AbstractDescriptor.ColumnParams patternElement,
                                             List<AttributeDescriptor> qualifierPath,
                                             String enclosingTableAlias,
                                             boolean isAlternative,
                                             String documentID)
                                      throws HeaderValidationException

Throws:

HeaderValidationException

validate

public void validate(StandardColumnDescriptor columnDescriptor)
              throws HeaderValidationException

Description copied from class: AbstractValueTranslator

Validates the value translator once per header creation.

Overrides:

validate in class AbstractValueTranslator

Parameters:

columnDescriptor - descriptor where the value to translate belongs to

Throws:

HeaderValidationException - validation has thrown errors

checkResolvableAttribute

protected void checkResolvableAttribute(HeaderDescriptor header,
                                        AttributeDescriptor attributeDescriptor)
                                 throws HeaderValidationException

Throws:

HeaderValidationException

getFullDefaultValueMap

protected Map<String,Object> getFullDefaultValueMap()

mergeDefaultValues

protected Map<String,Object> mergeDefaultValues(List<String> parsedValues)

convertToString

protected String convertToString(Object value)

Description copied from class: SingleValueTranslator

Converts a non-null jalo attribute value into its string representation.

Specified by:

convertToString in class SingleValueTranslator

Parameters:

value - value to translate

Returns:

translated value

toString

protected String toString(Item item)

getLanguageByIsoCode

protected Language getLanguageByIsoCode(de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternEndElement patternElement)

isLocalizedAndLanguageModifierIsSet

protected boolean isLocalizedAndLanguageModifierIsSet(de.hybris.platform.impex.jalo.translators.ItemExpressionTranslator.ExportPatternEndElement patternElement)

getEmptyValue

protected Object getEmptyValue()

Returning default translation in case a default value was specified for each item path expression.

Example:

        INSERT ...; attrib( a1[ default=a],a2[default=b],a3[default=c] ); ...
 

Here a actually empty attrib column is translated into the equivalent of 'a:b:c' which were set as default value because each path expression ( a1, a2, a3 ) owns a default value. Otherwise the column would not be translatable

Overrides:

getEmptyValue in class SingleValueTranslator

Returns:

used null value

searchItem

protected Object searchItem(Map values,
                            String valueExpr)

Executes actual resolving of a given reference pattern by issuing a flexible search query.

Parameters:

values -

valueExpr -

Returns:

Item

inserIsNullIfNecessary

protected static String inserIsNullIfNecessary(String queryBody,
                                               Map<String,Object> valuesIncludingNull)

mergeValues

protected static void mergeValues(Map<String,Object> merged,
                                  Map<String,Object> original,
                                  int tokenNumber)

convertAllToJalo

public static List<ItemExpressionTranslator.CombinedSearchResult> convertAllToJalo(Item _forItem,
                                                                                   List<ItemExpressionTranslator> translators,
                                                                                   List<String> expressions)

searchCombined

protected static List<Object> searchCombined(List<ItemExpressionTranslator> translators,
                                             List<Map<String,Object>> valueMaps,
                                             List<String> valueExpressions)

convertToJalo

protected Object convertToJalo(String valueExpr,
                               Item forItem)

Description copied from class: SingleValueTranslator

Converts a non-null and non-empty string into a jalo attribute value.

Specified by:

convertToJalo in class SingleValueTranslator

Parameters:

valueExpr - string to translate

forItem - item instance the translated value will be set to as attribute

Returns:

Object translated value