de.hybris.platform.printcockpit.model.layout.impl

Class LayoutServiceImpl

java.lang.Object

de.hybris.platform.printcockpit.model.general.impl.AbstractServiceImpl

de.hybris.platform.printcockpit.model.layout.impl.LayoutServiceImpl

All Implemented Interfaces:

LayoutService

public class LayoutServiceImpl
extends AbstractServiceImpl
implements LayoutService

Constructor Summary

Constructors

Constructor and Description
LayoutServiceImpl()

Method Summary

Modifier and Type	Method and Description
AttributePlaceholderModel	createAttributePlaceholder(PlaceholderTemplateModel template, String qualifier, List<AttributeDescriptorModel> ad) Creates a new attribute placeholder.
ClassificationAttributePlaceholderModel	createClassificationAttributePlaceholder(PlaceholderTemplateModel template, String qualifier, ClassAttributeAssignmentModel assignment) Creates a new classification attribute placeholder.
protected Map<String,Object>	createEmptyLocMap()
ExpressionPlaceholderModel	createExpressionPlaceholder(PlaceholderTemplateModel template, String qualifer) Creates a new expression placeholder.
PlaceholderTemplateModel	createPlaceholderTemplate(CometConfigurationModel cfg, String type, String code) Creates a new placeholder template.
List<CometConfigurationModel>	getAllCometConfigurations() Finds all comet configurations.
List<MediaModel>	getAlternativeMedias(PlaceholderTemplateModel placeholderTemplate, ItemModel item)
List<HybrisEnumValue>	getAvailableGridModes() Returns all grid mode enums.
List<GridModel>	getAvailableGrids(CometConfigurationModel cfg) Finds all grids within a specified comet configuration.
List<LayoutTemplateModel>	getAvailableLayoutTemplates(CometConfigurationModel cfg, String type) Finds all layout templates applicable to a given type within a specified comet configuration.
List<LayoutTemplateModel>	getAvailableLayoutTemplates(PlaceholderTemplateModel placeholderTemplate) Finds all layout templates applicable to a given PlaceholderTemplate.
List<MasterPageModel>	getAvailableMasterPages(String type) Finds all master pages applicable to a given type.
List<HybrisEnumValue>	getAvailablePageAlignments() Returns all page alignment enums.
List<PageFormatModel>	getAvailablePageFormats() Returns all page formats available within the system.
List<HybrisEnumValue>	getAvailablePageStates() Returns all page states enums.
List<HybrisEnumValue>	getAvailablePageTypes() Returns all page type enums.
List<PlaceholderTemplateModel>	getAvailablePlaceholderTemplates(CometConfigurationModel cfg, String type) Finds all placeholder templates applicable to a given type within a specified comet configuration.
Collection<HybrisEnumValue>	getAvailablePlaceholderTypes() Returns all available placeholder types for PlaceholderModel.getPlaceholderType().
Collection<HybrisEnumValue>	getAvailablePlaceholderValueTypes() Returns all available placeholder value types
List<HybrisEnumValue>	getAvailablePlacementModes()
LayoutTemplateModel	getDefaultLayoutTemplate(PageModel page, PlaceholderTemplateModel placeholderTemplate, PlacementModel uiPlacement, ItemModel placementItem, SpreadPosition gridType) Returns default layout template for this placement but.
PlaceholderTemplateModel	getDefaultPlaceholderTemplate(PageModel page, PlacementModel uiPlacement, ItemModel placementItem) Determines the default placeholder template for a given placement and placed item.
HybrisEnumValue	getDefaultPlaceholderType() Returns the default placeholder type when creating a new (unspecified) placeholder.
HybrisEnumValue	getDefaultPlaceholderType(AttributeDescriptorModel attribute) Returns the default placeholder type when creating a new attribute placeholder.
HybrisEnumValue	getDefaultPlaceholderType(ClassAttributeAssignmentModel assignmnet) Returns the default placeholder type when creating a new classification attribute placeholder.
HybrisEnumValue	getDefaultPlaceholderValueType() Returns the default placeholder value type when creating a new (unspecified) placeholder.
HybrisEnumValue	getDefaultPlaceholderValueType(AttributeDescriptorModel attribute) Returns the default placeholder value type when creating a new attribute placeholder.
HybrisEnumValue	getDefaultPlaceholderValueType(ClassAttributeAssignmentModel assignmnet) Returns the default placeholder type when creating a new classification attribute placeholder.
String	getDisplayName(PlacementModel placementModel) Calculates the dynamic display name of the given placement.
GridModel	getGrid(CometConfigurationModel cfg, int id) Fetches a grid by its id.
int[]	getPageDimensions(PageModel pageModel) Compute width and height only once for all images
String	getPlaceholderSource(PlaceholderModel placeholder)
Map<String,String>	getPlaceholderValue(PlaceholderTemplateModel template, ItemModel item) Calculates all placeholder values for a placeholder template applied to a item.
String	getPreview(PlacementModel placement) Calculates the dynamic preview for the given placement.
List<LayoutTemplateModel>	getUnassignedLayoutTemplates(CometConfigurationModel cfg) Finds all layout templates which haven't been assigned to any placeholder template yet.
Object	getValue(PlaceholderModel placeholder, PlacementModel placement) Calculates the actual value for a given placeholder applied to a placement.
protected Object	getValue(PlaceholderModel placeholder, PlacementModel placementModel, Item item)
LayoutTemplateModel	loadLayoutTemplate(PlaceholderTemplateModel placeholderTemplate, LayoutTemplate templ)
PlaceholderTemplateModel	loadPlaceholderTemplate(PlaceholderTemplate pt)
protected PlaceholderTemplateModel	loadPlaceholderTemplateReferences(PlaceholderTemplateModel me, PlaceholderTemplate orig)
protected List<LayoutTemplate>	queryLayoutTemplates(CometConfigurationModel cfg, String type) Finds layout templates by given type.
protected List<PlaceholderTemplate>	queryPlaceholderTemplates(CometConfigurationModel cfg, String type, boolean includeSuperType) Finds all placeholder templates matching the given type.
protected Map<Language,Object>	unmapLocMap(Map<String,Object> src)

Methods inherited from class de.hybris.platform.printcockpit.model.general.impl.AbstractServiceImpl

getEnum, getEnums, getModelService, setModelService

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutServiceImpl

public LayoutServiceImpl()

Method Detail

createAttributePlaceholder

public AttributePlaceholderModel createAttributePlaceholder(PlaceholderTemplateModel template,
                                                            String qualifier,
                                                            List<AttributeDescriptorModel> ad)

Description copied from interface: LayoutService

Creates a new attribute placeholder. This instance exist in memory only and must be saved together with its template!

Specified by:

createAttributePlaceholder in interface LayoutService

Parameters:

template - the enclosing template

qualifier - the qualifier

ad - the attribute descriptor path

createClassificationAttributePlaceholder

public ClassificationAttributePlaceholderModel createClassificationAttributePlaceholder(PlaceholderTemplateModel template,
                                                                                        String qualifier,
                                                                                        ClassAttributeAssignmentModel assignment)

Description copied from interface: LayoutService

Creates a new classification attribute placeholder. This instance exist in memory only and must be saved together with its template!

Specified by:

createClassificationAttributePlaceholder in interface LayoutService

Parameters:

template - the enclosing template

qualifier - TODO

assignment - the class-attribute assignment

createEmptyLocMap

protected Map<String,Object> createEmptyLocMap()

createExpressionPlaceholder

public ExpressionPlaceholderModel createExpressionPlaceholder(PlaceholderTemplateModel template,
                                                              String qualifer)

Description copied from interface: LayoutService

Creates a new expression placeholder. This instance exist in memory only and must be saved together with its template!

Specified by:

createExpressionPlaceholder in interface LayoutService

Parameters:

template - the enclosing placeholder template

qualifer - the qualifier

createPlaceholderTemplate

public PlaceholderTemplateModel createPlaceholderTemplate(CometConfigurationModel cfg,
                                                          String type,
                                                          String code)

Description copied from interface: LayoutService

Creates a new placeholder template. This instance exist in memory only and must be saved explicitly!

Specified by:

createPlaceholderTemplate in interface LayoutService

Parameters:

cfg - the enclosing comet configuration

type - the associated composed type

code - the code

getAllCometConfigurations

public List<CometConfigurationModel> getAllCometConfigurations()

Description copied from interface: LayoutService

Finds all comet configurations.

Specified by:

getAllCometConfigurations in interface LayoutService

getAlternativeMedias

public List<MediaModel> getAlternativeMedias(PlaceholderTemplateModel placeholderTemplate,
                                             ItemModel item)

Specified by:

getAlternativeMedias in interface LayoutService

getAvailableGridModes

public List<HybrisEnumValue> getAvailableGridModes()

Description copied from interface: LayoutService

Returns all grid mode enums.

Specified by:

getAvailableGridModes in interface LayoutService

getAvailablePlacementModes

public List<HybrisEnumValue> getAvailablePlacementModes()

Specified by:

getAvailablePlacementModes in interface LayoutService

Returns:

all possible placement mode enums for page

getAvailableGrids

public List<GridModel> getAvailableGrids(CometConfigurationModel cfg)

Description copied from interface: LayoutService

Finds all grids within a specified comet configuration.

Specified by:

getAvailableGrids in interface LayoutService

Parameters:

cfg - the comet configuration

getAvailableLayoutTemplates

public List<LayoutTemplateModel> getAvailableLayoutTemplates(CometConfigurationModel cfg,
                                                             String type)

Description copied from interface: LayoutService

Finds all layout templates applicable to a given type within a specified comet configuration.

Specified by:

getAvailableLayoutTemplates in interface LayoutService

Parameters:

cfg - the comet configuration

type - the type to match

getAvailableLayoutTemplates

public List<LayoutTemplateModel> getAvailableLayoutTemplates(PlaceholderTemplateModel placeholderTemplate)

Description copied from interface: LayoutService

Finds all layout templates applicable to a given PlaceholderTemplate.

Specified by:

getAvailableLayoutTemplates in interface LayoutService

Parameters:

placeholderTemplate - the placeholderTemplate to match

getAvailableMasterPages

public List<MasterPageModel> getAvailableMasterPages(String type)

Description copied from interface: LayoutService

Finds all master pages applicable to a given type.

Specified by:

getAvailableMasterPages in interface LayoutService

Parameters:

type - the type to match.

getAvailablePageAlignments

public List<HybrisEnumValue> getAvailablePageAlignments()

Description copied from interface: LayoutService

Returns all page alignment enums.

Specified by:

getAvailablePageAlignments in interface LayoutService

getAvailablePageFormats

public List<PageFormatModel> getAvailablePageFormats()

Description copied from interface: LayoutService

Returns all page formats available within the system.

Specified by:

getAvailablePageFormats in interface LayoutService

getAvailablePageStates

public List<HybrisEnumValue> getAvailablePageStates()

Description copied from interface: LayoutService

Returns all page states enums.

Specified by:

getAvailablePageStates in interface LayoutService

getAvailablePageTypes

public List<HybrisEnumValue> getAvailablePageTypes()

Description copied from interface: LayoutService

Returns all page type enums.

Specified by:

getAvailablePageTypes in interface LayoutService

getAvailablePlaceholderTemplates

public List<PlaceholderTemplateModel> getAvailablePlaceholderTemplates(CometConfigurationModel cfg,
                                                                       String type)

Description copied from interface: LayoutService

Finds all placeholder templates applicable to a given type within a specified comet configuration.

Specified by:

getAvailablePlaceholderTemplates in interface LayoutService

Parameters:

cfg - the comet configuration

type - the type to match

getAvailablePlaceholderTypes

public Collection<HybrisEnumValue> getAvailablePlaceholderTypes()

Description copied from interface: LayoutService

Returns all available placeholder types for PlaceholderModel.getPlaceholderType().

Specified by:

getAvailablePlaceholderTypes in interface LayoutService

getAvailablePlaceholderValueTypes

public Collection<HybrisEnumValue> getAvailablePlaceholderValueTypes()

Description copied from interface: LayoutService

Returns all available placeholder value types

Specified by:

getAvailablePlaceholderValueTypes in interface LayoutService

getDefaultLayoutTemplate

public LayoutTemplateModel getDefaultLayoutTemplate(PageModel page,
                                                    PlaceholderTemplateModel placeholderTemplate,
                                                    PlacementModel uiPlacement,
                                                    ItemModel placementItem,
                                                    SpreadPosition gridType)

Returns default layout template for this placement but. Default layout template is being determined as follows: If grid element has default template specified and this template is applicable for current placement then it's used. Else default template of grid assigned to current page is taken if it is not specified then first template from list of all usable templates for this placement is taken.

Specified by:

getDefaultLayoutTemplate in interface LayoutService

getDefaultPlaceholderTemplate

public PlaceholderTemplateModel getDefaultPlaceholderTemplate(PageModel page,
                                                              PlacementModel uiPlacement,
                                                              ItemModel placementItem)

Description copied from interface: LayoutService

Determines the default placeholder template for a given placement and placed item.

Specified by:

getDefaultPlaceholderTemplate in interface LayoutService

uiPlacement - the placement to place the item into

placementItem - the placed item

getDefaultPlaceholderType

public HybrisEnumValue getDefaultPlaceholderType()

Description copied from interface: LayoutService

Returns the default placeholder type when creating a new (unspecified) placeholder.

Specified by:

getDefaultPlaceholderType in interface LayoutService

getDefaultPlaceholderType

public HybrisEnumValue getDefaultPlaceholderType(AttributeDescriptorModel attribute)

Description copied from interface: LayoutService

Returns the default placeholder type when creating a new attribute placeholder.

Specified by:

getDefaultPlaceholderType in interface LayoutService

getDefaultPlaceholderType

public HybrisEnumValue getDefaultPlaceholderType(ClassAttributeAssignmentModel assignmnet)

Description copied from interface: LayoutService

Returns the default placeholder type when creating a new classification attribute placeholder.

Specified by:

getDefaultPlaceholderType in interface LayoutService

getDefaultPlaceholderValueType

public HybrisEnumValue getDefaultPlaceholderValueType()

Description copied from interface: LayoutService

Returns the default placeholder value type when creating a new (unspecified) placeholder.

Specified by:

getDefaultPlaceholderValueType in interface LayoutService

getDefaultPlaceholderValueType

public HybrisEnumValue getDefaultPlaceholderValueType(AttributeDescriptorModel attribute)

Description copied from interface: LayoutService

Returns the default placeholder value type when creating a new attribute placeholder.

Specified by:

getDefaultPlaceholderValueType in interface LayoutService

getDefaultPlaceholderValueType

public HybrisEnumValue getDefaultPlaceholderValueType(ClassAttributeAssignmentModel assignmnet)

Description copied from interface: LayoutService

Returns the default placeholder type when creating a new classification attribute placeholder.

Specified by:

getDefaultPlaceholderValueType in interface LayoutService

getDisplayName

public String getDisplayName(PlacementModel placementModel)

Description copied from interface: LayoutService

Calculates the dynamic display name of the given placement.

Specified by:

getDisplayName in interface LayoutService

getGrid

public GridModel getGrid(CometConfigurationModel cfg,
                         int id)

Description copied from interface: LayoutService

Fetches a grid by its id.

Specified by:

getGrid in interface LayoutService

getPlaceholderSource

public String getPlaceholderSource(PlaceholderModel placeholder)

Specified by:

getPlaceholderSource in interface LayoutService

getPlaceholderValue

public Map<String,String> getPlaceholderValue(PlaceholderTemplateModel template,
                                              ItemModel item)

Description copied from interface: LayoutService

Calculates all placeholder values for a placeholder template applied to a item.

Specified by:

getPlaceholderValue in interface LayoutService

Parameters:

template - the placeholder template to get values for

item - the item to read values from

getPreview

public String getPreview(PlacementModel placement)

Description copied from interface: LayoutService

Calculates the dynamic preview for the given placement.

Specified by:

getPreview in interface LayoutService

Returns:

the preview hmtl text

getUnassignedLayoutTemplates

public List<LayoutTemplateModel> getUnassignedLayoutTemplates(CometConfigurationModel cfg)

Description copied from interface: LayoutService

Finds all layout templates which haven't been assigned to any placeholder template yet.

Specified by:

getUnassignedLayoutTemplates in interface LayoutService

getValue

public Object getValue(PlaceholderModel placeholder,
                       PlacementModel placement)

Description copied from interface: LayoutService

Calculates the actual value for a given placeholder applied to a placement.

Specified by:

getValue in interface LayoutService

Parameters:

placeholder - the placeholder which describes the value

placement - the placement which holds the data item

getValue

protected Object getValue(PlaceholderModel placeholder,
                          PlacementModel placementModel,
                          Item item)

loadLayoutTemplate

public LayoutTemplateModel loadLayoutTemplate(PlaceholderTemplateModel placeholderTemplate,
                                              LayoutTemplate templ)

loadPlaceholderTemplate

public PlaceholderTemplateModel loadPlaceholderTemplate(PlaceholderTemplate pt)

loadPlaceholderTemplateReferences

protected PlaceholderTemplateModel loadPlaceholderTemplateReferences(PlaceholderTemplateModel me,
                                                                     PlaceholderTemplate orig)

queryLayoutTemplates

protected List<LayoutTemplate> queryLayoutTemplates(CometConfigurationModel cfg,
                                                    String type)

Finds layout templates by given type. If the type is specified it selectes all layout templates which are assigned to a placeholder template which matches the given type or any of its super types. If the type is null only unassigned layout templates are found!

Parameters:

cfg - the comet configuration to search within

type - the item type to macth

queryPlaceholderTemplates

protected List<PlaceholderTemplate> queryPlaceholderTemplates(CometConfigurationModel cfg,
                                                              String type,
                                                              boolean includeSuperType)

Finds all placeholder templates matching the given type.

Parameters:

cfg - the comet cfg

type - the type

includeSuperType - whether or not to search for templates matching the type's super types

unmapLocMap

protected Map<Language,Object> unmapLocMap(Map<String,Object> src)

getPageDimensions

public int[] getPageDimensions(PageModel pageModel)

Description copied from interface: LayoutService

Compute width and height only once for all images

Specified by:

getPageDimensions in interface LayoutService

Returns:

page width and height [px,px]