de.hybris.platform.impex.jalo.translators

Class AbstractTypeTranslator

java.lang.Object

de.hybris.platform.impex.jalo.translators.AbstractTypeTranslator

All Implemented Interfaces:

HeaderCellTranslator

Direct Known Subclasses:

DefaultTypeTranslator

public abstract class AbstractTypeTranslator
extends Object
implements HeaderCellTranslator

Base class for all TypeTranslators. Validates and translates ImpEx cell headers.

Returns a AbstractColumnDescriptor implementation for a specific HeaderDescriptor

Constructor Summary

Constructors

Constructor and Description
AbstractTypeTranslator()

Method Summary

Modifier and Type	Method and Description
protected List<AbstractColumnDescriptor>	getAutoColumnExpressions(HeaderDescriptor header) Generates all mandatory column expressions related to the given header.
protected boolean	isDocumentIDColumn(String expr) Checks if the column is a document id column (starts with &).
protected boolean	isSpecialColumn(String expr) Checks if the column is a special column (starts with @).
List<AbstractColumnDescriptor>	translateColumnDescriptors(HeaderDescriptor header, List<String> columnExpressions) Instantiates for each column expression in given list the matching AbstractColumnDescriptor an returns them.
List<AbstractColumnDescriptor>	translateColumnDescriptors(HeaderDescriptor header, List<String> columnExpressions, boolean rethrowException)
protected AbstractColumnDescriptor	translatorColumnDescriptor(HeaderDescriptor header, String expr, int pos) Instantiates the correct AbstractColumnDescriptor for the given column expression.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.impex.jalo.translators.HeaderCellTranslator

isValid, translate

Constructor Detail

AbstractTypeTranslator

public AbstractTypeTranslator()

Method Detail

translateColumnDescriptors

public List<AbstractColumnDescriptor> translateColumnDescriptors(HeaderDescriptor header,
                                                                 List<String> columnExpressions)
                                                          throws HeaderValidationException

Instantiates for each column expression in given list the matching AbstractColumnDescriptor an returns them.

Parameters:

header - the current header object to which the columns belong

columnExpressions - the column expression for which column descriptors will be instantiated

Returns:

list of AbstractColumnDescriptors

Throws:

HeaderValidationException - no column expressions are declared and header is not in relaxed mode

translateColumnDescriptors

public List<AbstractColumnDescriptor> translateColumnDescriptors(HeaderDescriptor header,
                                                                 List<String> columnExpressions,
                                                                 boolean rethrowException)
                                                          throws HeaderValidationException

Throws:

HeaderValidationException

translatorColumnDescriptor

protected AbstractColumnDescriptor translatorColumnDescriptor(HeaderDescriptor header,
                                                              String expr,
                                                              int pos)
                                                       throws HeaderValidationException

Instantiates the correct AbstractColumnDescriptor for the given column expression. Selection is based whether a expression is a

• a special column
• a document id column
• a plain column

It returns a specific AbstractColumnDescriptor if translator is in servicelayer mode or not.

Parameters:

header - the header to which the column belongs

expr - the column expression to which a descriptor is needed

pos - the position of the column within the header

Returns:

a AbstractColumnDescriptor to the given column expression

Throws:

HeaderValidationException - exception while instantiation

isSpecialColumn

protected boolean isSpecialColumn(String expr)

Checks if the column is a special column (starts with @).

Parameters:

expr - the column string

Returns:

true if the string is a special column

isDocumentIDColumn

protected boolean isDocumentIDColumn(String expr)

Checks if the column is a document id column (starts with &).

Parameters:

expr - the column string

Returns:

true if the string is a column defining a document id

getAutoColumnExpressions

protected List<AbstractColumnDescriptor> getAutoColumnExpressions(HeaderDescriptor header)

Generates all mandatory column expressions related to the given header.

Parameters:

header - the header for which columns are needed

Returns:

list of AbstractColumnDescriptors