de.hybris.platform.btgcockpit.wizard.page.btgexpressioncomponent.expressioncomponent.model

Class BTGExpressionComponentCreatorModel

java.lang.Object

de.hybris.platform.btgcockpit.wizard.page.btgexpressioncomponent.expressioncomponent.model.BTGExpressionComponentCreatorModel

All Implemented Interfaces:

BTGExpressionComponentModel

Direct Known Subclasses:

BTGExpressionComponentEditorModel

public class BTGExpressionComponentCreatorModel
extends Object
implements BTGExpressionComponentModel

Represents a concrete model used to create new BTG Expressions for BTGExpressionComponentView

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BTGExpressionComponentCreatorModel.ModelChangeListener This interface is used by operand/operator models to notify BTGExpressionComponentCreatorModel that the state of the model has completely changed because a new model type was selected.
static interface	BTGExpressionComponentCreatorModel.ModelChangeListenerProvider Functor interface to enable deferred initialization of ModelChangeListener.
static interface	BTGExpressionComponentCreatorModel.ModelUpdateListener This interface is used by operand models to notify BTGExpressionComponentCreatorModel that the state of the operand has been updated by some user action.
static interface	BTGExpressionComponentCreatorModel.ModelUpdateListenerProvider Functor interface to enable deferred initialization of ModelUpdateListener.

Field Summary

Fields

Modifier and Type	Field and Description
protected BTGExpressionCreatorPage.CatalogVersionInstanceProvider	catalogVersionInstanceProvider
protected OperandModelImpl	leftOperandModel
protected BTGExpressionComponentCreatorModel.ModelChangeListener	leftOperandModelChangeListener
protected BTGExpressionComponentCreatorModel.ModelUpdateListener	leftOperandModelUpdateListener
protected BTGExpressionComponentCreatorModel.ModelChangeListener	operatorModelChangeListener
protected OperatorModelImpl	operatorPanelModel
protected OperandModelImpl	rightOperandModel
protected BTGExpressionComponentCreatorModel.ModelUpdateListener	rightOperandModelUpdateListener

Constructor Summary

Constructors

Constructor and Description
BTGExpressionComponentCreatorModel(BTGExpressionCreatorPage.RuleTypeInstanceProvider ruleTypeProvider, BTGExpressionCreatorPage.CatalogVersionInstanceProvider catalogVersionInstanceProvider) Constructor used to create model for "create mode"

Method Summary

Modifier and Type	Method and Description
protected OperandModelImpl	constructLeftOperandModel(OperandModelImpl operand) This method constructs a model for the left operand.
protected OperandTypeContainer	constructOperandType(Class<? extends BTGOperandModel> operandSLClass)
protected OperatorModelImpl	constructOperatorModel() This method constructs a model for the operator.
protected OperandModelImpl	constructRightOperandModel(OperandModelImpl operand) This method constructs a model for the right operand.
BTGConditionModel	createConditionOnly(BTGRuleModel rule)
protected OperandModelImpl	createEmptyOperandInstance() This method creates an empty operand.
protected BTGOperatorModel	createOperator() Creates an operator
protected Collection<OperandTypeContainer>	getAllowedLeftOperands() Uses ExpressionService to get a collection of allowed left operands based on rule type on which the model is based.
protected Collection<OperandTypeContainer>	getAllowedRightOperands() Uses ExpressionService to get a collection of allowed right operands based on currently selected left operand and currently selected operator.
protected ExpressionService	getExpressionService()
OperandTypeContainer	getLeftOperand()
ObjectTypeDynamicSectionPanelModelData	getLeftOperandObjectTypeModelData()
ObjectTypeDynamicSectionPanelModel	getLeftOperandPanelModel() Provides model for left operand view component
ModelService	getModelService()
protected Set<String>	getOmittedProperties(ItemModel itemModelToValidate) Gets all omitted properties of the given model.
protected ObjectTypeDynamicSectionPanelModelData.OperandValueContainerInitializer	getOperandValueContainerInitializer()
String	getOperator()
SelectionWithDynamicSectionPanelModel<String>	getOperatorPanelModel() Provides model for operator view component
OperandTypeContainer	getRightOperand()
ObjectTypeDynamicSectionPanelModelData	getRightOperandObjectTypeModelData()
ObjectTypeDynamicSectionPanelModel	getRightOperandPanelModel() Provides model for right operand view component
TypeService	getSlTypeService()
SystemService	getSystemService()
TypeService	getTypeService()
protected boolean	isAllMandatoryFullfilled(ItemModel itemModelToValidate)
protected boolean	isPreparedToSave(BTGConditionModel existingExpression, BTGOperandModel leftOperand, BTGOperatorModel operator, BTGOperandModel rightOperand)
protected boolean	save() Tries to save the entire expression.
void	save(BTGRuleModel rule)
protected void	setMissingProperties(ObjectValueContainer objectValueContainer, CatalogVersionModel catalogVersion) Sets well-known required operands properties.
protected void	setPropertyValue(ObjectType objectType, ObjectValueContainer objectValueContainer, String qualifier, Object value) Helper method to set value for a property in ObjectValueContainer
Set<CockpitValidationDescriptor>	validate() Validates the expression with its operands and operator.

Methods inherited from class java.lang.Object

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

Field Detail

catalogVersionInstanceProvider

protected final BTGExpressionCreatorPage.CatalogVersionInstanceProvider catalogVersionInstanceProvider

leftOperandModel

protected final OperandModelImpl leftOperandModel

rightOperandModel

protected final OperandModelImpl rightOperandModel

operatorPanelModel

protected final OperatorModelImpl operatorPanelModel

leftOperandModelChangeListener

protected final BTGExpressionComponentCreatorModel.ModelChangeListener leftOperandModelChangeListener

operatorModelChangeListener

protected final BTGExpressionComponentCreatorModel.ModelChangeListener operatorModelChangeListener

leftOperandModelUpdateListener

protected final BTGExpressionComponentCreatorModel.ModelUpdateListener leftOperandModelUpdateListener

rightOperandModelUpdateListener

protected final BTGExpressionComponentCreatorModel.ModelUpdateListener rightOperandModelUpdateListener

Constructor Detail

BTGExpressionComponentCreatorModel

public BTGExpressionComponentCreatorModel(BTGExpressionCreatorPage.RuleTypeInstanceProvider ruleTypeProvider,
                                          BTGExpressionCreatorPage.CatalogVersionInstanceProvider catalogVersionInstanceProvider)

Constructor used to create model for "create mode"

Method Detail

getLeftOperandPanelModel

public ObjectTypeDynamicSectionPanelModel getLeftOperandPanelModel()

Description copied from interface: BTGExpressionComponentModel

Provides model for left operand view component

Specified by:

getLeftOperandPanelModel in interface BTGExpressionComponentModel

getOperatorPanelModel

public SelectionWithDynamicSectionPanelModel<String> getOperatorPanelModel()

Description copied from interface: BTGExpressionComponentModel

Provides model for operator view component

Specified by:

getOperatorPanelModel in interface BTGExpressionComponentModel

getRightOperandPanelModel

public ObjectTypeDynamicSectionPanelModel getRightOperandPanelModel()

Description copied from interface: BTGExpressionComponentModel

Provides model for right operand view component

Specified by:

getRightOperandPanelModel in interface BTGExpressionComponentModel

getLeftOperand

public OperandTypeContainer getLeftOperand()

Returns:

the leftOperand

getRightOperand

public OperandTypeContainer getRightOperand()

Returns:

the rightOperand

getOperator

public String getOperator()

Returns:

the operator

getLeftOperandObjectTypeModelData

public ObjectTypeDynamicSectionPanelModelData getLeftOperandObjectTypeModelData()

Returns:

the leftOperandObjectTypeModelData

getRightOperandObjectTypeModelData

public ObjectTypeDynamicSectionPanelModelData getRightOperandObjectTypeModelData()

Returns:

the rightOperandObjectTypeModelData

constructOperandType

protected OperandTypeContainer constructOperandType(Class<? extends BTGOperandModel> operandSLClass)

getExpressionService

protected ExpressionService getExpressionService()

getAllowedLeftOperands

protected Collection<OperandTypeContainer> getAllowedLeftOperands()

Uses ExpressionService to get a collection of allowed left operands based on rule type on which the model is based. It should never return null.

getAllowedRightOperands

protected Collection<OperandTypeContainer> getAllowedRightOperands()

Uses ExpressionService to get a collection of allowed right operands based on currently selected left operand and currently selected operator.

Returns:

a collection of allowed right operands based on currently selected left operand and currently selected operator. Returns null if there is no selected left operand or selected operator.

createEmptyOperandInstance

protected OperandModelImpl createEmptyOperandInstance()

This method creates an empty operand. Be careful when overriding - it is called during instance creation!

getOperandValueContainerInitializer

protected ObjectTypeDynamicSectionPanelModelData.OperandValueContainerInitializer getOperandValueContainerInitializer()

constructLeftOperandModel

protected OperandModelImpl constructLeftOperandModel(OperandModelImpl operand)

This method constructs a model for the left operand. Be careful when overriding - it is called during instance creation!

constructRightOperandModel

protected OperandModelImpl constructRightOperandModel(OperandModelImpl operand)

This method constructs a model for the right operand. Be careful when overriding - it is called during instance creation!

constructOperatorModel

protected OperatorModelImpl constructOperatorModel()

This method constructs a model for the operator. Be careful when overriding - it is called during instance creation!

isPreparedToSave

protected boolean isPreparedToSave(BTGConditionModel existingExpression,
                                   BTGOperandModel leftOperand,
                                   BTGOperatorModel operator,
                                   BTGOperandModel rightOperand)

isAllMandatoryFullfilled

protected boolean isAllMandatoryFullfilled(ItemModel itemModelToValidate)

save

protected boolean save()

Tries to save the entire expression.

Returns:

true, if save was performed successfully. Returns false otherwise.

save

public void save(BTGRuleModel rule)

createConditionOnly

public BTGConditionModel createConditionOnly(BTGRuleModel rule)

createOperator

protected BTGOperatorModel createOperator()

Creates an operator

validate

public Set<CockpitValidationDescriptor> validate()
                                          throws ValueHandlerException

Validates the expression with its operands and operator.

Validation is performed on models.

For operands the corresponding ObjectValueContainer contains the models.

The models of expression and operator are created on the fly.

Returns:

Set with validation problems as CockpitValidationDescriptor or an empty set

Throws:

ValueHandlerException - if a problem during validation occurs

See Also:

validateModel(ItemModel)

getOmittedProperties

protected Set<String> getOmittedProperties(ItemModel itemModelToValidate)

Gets all omitted properties of the given model.

An omitted property is a mandatory attribute with no/empty value.

Parameters:

itemModelToValidate - model to validate

Returns:

a Set of omitted properties as String or an empty set

setMissingProperties

protected void setMissingProperties(ObjectValueContainer objectValueContainer,
                                    CatalogVersionModel catalogVersion)

Sets well-known required operands properties. These are: "catalogVersion" and "uid".

setPropertyValue

protected void setPropertyValue(ObjectType objectType,
                                ObjectValueContainer objectValueContainer,
                                String qualifier,
                                Object value)

Helper method to set value for a property in ObjectValueContainer

getTypeService

public TypeService getTypeService()

getModelService

public ModelService getModelService()

getSystemService

public SystemService getSystemService()

getSlTypeService

public TypeService getSlTypeService()