org.ametys.runtime.model

Class CategorizedElementDefinitionHelper

java.lang.Object

org.ametys.runtime.model.CategorizedElementDefinitionHelper

public final class CategorizedElementDefinitionHelper
extends Object

Helper for CategorizedElementDefinitionProxy

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CategorizedElementDefinitionHelper()

Method Summary

Modifier and Type	Method and Description
private static ModelViewItemGroup	_buildCategoryViewItem(ModelItem category, Comparator<? super ModelItem> groupsComparator)
private static ModelViewItem	_buildElementViewItem(ModelItem modelItem)
private static ModelViewItemGroup	_buildGroupViewItem(ModelItem modelItem)
private static Collection<? extends ModelItem>	_sort(Collection<? extends ModelItem> items, Comparator<? super ModelItem> comparator) sort a model item list using comparator
static View	buildViewFromCategories(Collection<? extends ModelItem> categories, Comparator<? super ModelItem> categoriesComparator, Comparator<? super ModelItem> groupsComparator) Generate the wiew for a list of ModelItem, using comparators to sort the categories and the groups This works only on the very specific categories/group/fieldset hierarchy and an IllegalArgumentException will be thrown if the hierarchy is incorrect.
static List<ModelItem>	categorize(Collection<CategorizedElementDefinitionProxy> elements) Categorize the ModlItems based on the informations in the CategorizedElementDefinitionProxy collection Category and groups are not sorted, only definitions, based on the position.
protected static Map<I18nizableText,Map<I18nizableText,List<CategorizedElementDefinitionProxy>>>	categorizeToMap(Collection<CategorizedElementDefinitionProxy> elements) Organize a collection of skin parameters by categories and groups.
static Map<String,ElementDefinition>	getFlatDefinitions(Collection<CategorizedElementDefinitionProxy> elements) Get definitions of all elements parsed in this CategorizedElementDefinitionProxy Collection, as a flat map.
protected static Collection<CategorizedElementDefinitionProxy>	orderDefinitions(Collection<CategorizedElementDefinitionProxy> definitions) Order definitions, based on their position
protected static Collection<CategorizedElementDefinitionProxy>	orderDefinitions(Collection<CategorizedElementDefinitionProxy> definitions, I18nizableText categoryLabel, I18nizableText groupLabel) Order definitions, based on their position
static Map<String,List<I18nizableText>>	validateValuesForWriting(Map<String,DefinitionAndValue> definitionAndValues, Logger logger) Validate parameters before writing
static Map<String,List<I18nizableText>>	validateValuesForWriting(Map<String,DefinitionAndValue> definitionAndValues, Map<String,ElementDefinition> flatDefinitions, Logger logger) Deprecated. TODO NEWATTRIBUTEAPI_CONFIG RUNTIME-2851 remove this method when it is not necessary anymore to have the flat definitions

Methods inherited from class java.lang.Object

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

Constructor Detail

CategorizedElementDefinitionHelper

private CategorizedElementDefinitionHelper()

Method Detail

getFlatDefinitions

public static Map<String,ElementDefinition> getFlatDefinitions(Collection<CategorizedElementDefinitionProxy> elements)

Get definitions of all elements parsed in this CategorizedElementDefinitionProxy Collection, as a flat map.

Parameters:

elements - a Collection of CategorizedElementDefinitionProxy

Returns:

a map with the definition name as key, containing all definitions

categorize

public static List<ModelItem> categorize(Collection<CategorizedElementDefinitionProxy> elements)

Categorize the ModlItems based on the informations in the CategorizedElementDefinitionProxy collection Category and groups are not sorted, only definitions, based on the position. Sorting of category and groups have to be done when the view is created (each usage can be different)

Parameters:

elements - collection of categorized elements

Returns:

a list of ModelItem with the correct tree (category/group/definitions)

categorizeToMap

protected static Map<I18nizableText,Map<I18nizableText,List<CategorizedElementDefinitionProxy>>> categorizeToMap(Collection<CategorizedElementDefinitionProxy> elements)

Organize a collection of skin parameters by categories and groups.

Parameters:

elements - a collection of elements.

Returns:

a Map of parameters sorted first by category then group.

orderDefinitions

protected static Collection<CategorizedElementDefinitionProxy> orderDefinitions(Collection<CategorizedElementDefinitionProxy> definitions)

Order definitions, based on their position

Parameters:

definitions - Collection of CategorizedElementDefinitionProxy

Returns:

an ordered Collection of CategorizedElementDefinitionProxy

orderDefinitions

protected static Collection<CategorizedElementDefinitionProxy> orderDefinitions(Collection<CategorizedElementDefinitionProxy> definitions,
                                                                                I18nizableText categoryLabel,
                                                                                I18nizableText groupLabel)

Order definitions, based on their position

Parameters:

definitions - Collection of CategorizedElementDefinitionProxy

categoryLabel - label of the category to filter (null to avoid filter)

groupLabel - label of the group (null to avoid filter)

Returns:

an ordered Collection of CategorizedElementDefinitionProxy

validateValuesForWriting

@Deprecated
public static Map<String,List<I18nizableText>> validateValuesForWriting(Map<String,DefinitionAndValue> definitionAndValues,
                                                                                    Map<String,ElementDefinition> flatDefinitions,
                                                                                    Logger logger)

Deprecated. TODO NEWATTRIBUTEAPI_CONFIG RUNTIME-2851 remove this method when it is not necessary anymore to have the flat definitions

Validate parameters before writing

Parameters:

definitionAndValues - a map of all parameters and their values

flatDefinitions - flat definition of ElementDefinition from the model file

logger - a logger

Returns:

a map containing the potential errors

validateValuesForWriting

public static Map<String,List<I18nizableText>> validateValuesForWriting(Map<String,DefinitionAndValue> definitionAndValues,
                                                                        Logger logger)

Validate parameters before writing

Parameters:

definitionAndValues - a map of all parameters and their values

logger - a logger

Returns:

a map containing the potential errors

buildViewFromCategories

public static View buildViewFromCategories(Collection<? extends ModelItem> categories,
                                           Comparator<? super ModelItem> categoriesComparator,
                                           Comparator<? super ModelItem> groupsComparator)
                                    throws IllegalArgumentException

Generate the wiew for a list of ModelItem, using comparators to sort the categories and the groups This works only on the very specific categories/group/fieldset hierarchy and an IllegalArgumentException will be thrown if the hierarchy is incorrect.

Parameters:

categories - list of ModelItem

categoriesComparator - Comparator used for the categories (can be null to keep order)

groupsComparator - Comparator for the groups (can be null to keep order)

Returns:

A View ordered from the ModelItem using the Comparator

Throws:

IllegalArgumentException - the hierarchy of the categories/groups/elements is incorrect

_sort

private static Collection<? extends ModelItem> _sort(Collection<? extends ModelItem> items,
                                                     Comparator<? super ModelItem> comparator)

sort a model item list using comparator

Parameters:

items - list of items to sort

comparator - a comparator, can be null to avoid sort

Returns:

a sorted list (or a copy of the list if the comparator is null)

_buildCategoryViewItem

private static ModelViewItemGroup _buildCategoryViewItem(ModelItem category,
                                                         Comparator<? super ModelItem> groupsComparator)
                                                  throws IllegalArgumentException

Throws:

IllegalArgumentException

_buildGroupViewItem

private static ModelViewItemGroup _buildGroupViewItem(ModelItem modelItem)
                                               throws IllegalArgumentException

Throws:

IllegalArgumentException

_buildElementViewItem

private static ModelViewItem _buildElementViewItem(ModelItem modelItem)
                                            throws IllegalArgumentException

Throws:

IllegalArgumentException