Package org.ametys.runtime.model

Class ViewHelper

java.lang.Object

org.ametys.runtime.model.ViewHelper

public final class ViewHelper
extends Object

Helper class for views

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ViewHelper.ViewItemGetter

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ViewHelper()

Method Summary

Modifier and Type	Method	Description
private static Optional<String>	_getModelItemContainerIdentifier(ModelItemContainer container)
private static Map<String,ModelItem>	_getModelItemsFromViewItemContainer(ViewItemContainer viewItemContainer)	Retrieves all model items in the given ViewItemContainer, indexed by their paths
static void	addViewContainerItems(ViewItemContainer currentContainer, ViewItemContainer containerToInclude, View referenceView)	Add the items of the view item container to include if they are not already present in the current view item container or in the reference view
static void	addViewItem(String relativePath, ViewItemContainer viewItemContainer, ModelItemContainer... modelItemContainers)	Add a view item in the given container
static <T extends ViewItemContainer> T	createEmptyViewItemContainer(Collection<? extends ModelItemContainer> modelItemContainers)	Creates an empty ViewItemContainer The created container can be a View or a ModelViewItemGroup, according to the given ModelItemContainers.
static <T extends ViewItemContainer> T	createViewItemContainer(Collection<? extends ModelItemContainer> modelItemContainers)	Creates a ViewItemContainer with the items of the given ModelItemContainer
static <T extends ViewItemContainer> T	createViewItemContainer(Collection<? extends ModelItemContainer> modelItemContainers, String... itemPaths)	Creates a ViewItemContainer with the given items
static Collection<ModelItem>	getModelItemsFromView(View view)	Retrieves all model items in the given View
static Set<String>	getModelItemsPathsFromView(View view)	Retrieves the paths of all model items in the given View
static ModelViewItem	getModelViewItem(ViewItemContainer itemContainer, String itemPath)	Gets the ModelViewItem from the ViewItemContainer at the given path.
static ModelViewItemGroup	getModelViewItemGroup(ViewItemContainer itemContainer, String itemPath)	Gets the ModelViewItemGroup from the ViewItemContainer at the given path.
static ViewElement	getViewElement(ViewItemContainer itemContainer, String itemPath)	Gets the ViewElement from the ViewItemContainer at the given path.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewHelper

private ViewHelper()

Method Detail

addViewContainerItems

public static void addViewContainerItems(ViewItemContainer currentContainer,
                                         ViewItemContainer containerToInclude,
                                         View referenceView)

Add the items of the view item container to include if they are not already present in the current view item container or in the reference view

Parameters:

currentContainer - the current container

containerToInclude - the container to include

referenceView - the reference view

createViewItemContainer

public static <T extends ViewItemContainer> T createViewItemContainer(Collection<? extends ModelItemContainer> modelItemContainers)
                                                               throws IllegalArgumentException

Creates a ViewItemContainer with the items of the given ModelItemContainer

Type Parameters:

T - Type of the ViewItemContainer to create (View or ModelViewItemGroup)

Parameters:

modelItemContainers - the model item containers

Returns:

the created ViewItemContainer

Throws:

IllegalArgumentException - if the model item containers collection is empty

createViewItemContainer

public static <T extends ViewItemContainer> T createViewItemContainer(Collection<? extends ModelItemContainer> modelItemContainers,
                                                                      String... itemPaths)
                                                               throws IllegalArgumentException,
                                                                      BadItemTypeException

Creates a ViewItemContainer with the given items

Type Parameters:

T - Type of the ViewItemContainer to create (View or ModelViewItemGroup)

Parameters:

modelItemContainers - the model items containing items definitions

itemPaths - the paths of the items to put in the view item container

Returns:

the created ViewItemContainer

Throws:

IllegalArgumentException - if the model item containers collection is empty or if an item path is null, empty, or is not defined in the given model item containers

BadItemTypeException - if a segment in a path (but not the last) does not represent a group item

createEmptyViewItemContainer

public static <T extends ViewItemContainer> T createEmptyViewItemContainer(Collection<? extends ModelItemContainer> modelItemContainers)
                                                                    throws IllegalArgumentException

Creates an empty ViewItemContainer The created container can be a View or a ModelViewItemGroup, according to the given ModelItemContainers.

Type Parameters:

T - The type of the created container

Parameters:

modelItemContainers - the model items containing items definitions

Returns:

the created ViewItemContainer

Throws:

IllegalArgumentException - if the model item containers collection is empty

addViewItem

public static void addViewItem(String relativePath,
                               ViewItemContainer viewItemContainer,
                               ModelItemContainer... modelItemContainers)
                        throws IllegalArgumentException,
                               UndefinedItemPathException,
                               BadItemTypeException

Add a view item in the given container

Parameters:

relativePath - path of the item to add

viewItemContainer - the view item container

modelItemContainers - the corresponding model item containers

Throws:

IllegalArgumentException - if the path is null or empty

UndefinedItemPathException - if the path is not defined in the given model item containers

BadItemTypeException - if a segment in a path (but not the last) does not represent a group item

_getModelItemContainerIdentifier

private static Optional<String> _getModelItemContainerIdentifier(ModelItemContainer container)

getModelItemsPathsFromView

public static Set<String> getModelItemsPathsFromView(View view)

Retrieves the paths of all model items in the given View

Parameters:

view - the View

Returns:

the paths of all items

getModelItemsFromView

public static Collection<ModelItem> getModelItemsFromView(View view)

Retrieves all model items in the given View

Parameters:

view - the View

Returns:

all model items

_getModelItemsFromViewItemContainer

private static Map<String,ModelItem> _getModelItemsFromViewItemContainer(ViewItemContainer viewItemContainer)

Retrieves all model items in the given ViewItemContainer, indexed by their paths

Parameters:

viewItemContainer - the ViewItemContainer

Returns:

all model items

getModelViewItem

public static ModelViewItem getModelViewItem(ViewItemContainer itemContainer,
                                             String itemPath)
                                      throws UndefinedItemPathException,
                                             BadItemTypeException

Gets the ModelViewItem from the ViewItemContainer at the given path.
Unlike ViewItemContainer.getModelViewItem(String), this method accepts a path and not only a name, allowing to traverse composites.

Parameters:

itemContainer - The container of view items

itemPath - The path of the item to get

Returns:

The ModelViewItem. Can never be null

Throws:

UndefinedItemPathException - If one of the parts of the given path is undefined

BadItemTypeException - If one of the parts of the given path is defined, but is not of the correct type

getViewElement

public static ViewElement getViewElement(ViewItemContainer itemContainer,
                                         String itemPath)
                                  throws UndefinedItemPathException,
                                         BadItemTypeException

Gets the ViewElement from the ViewItemContainer at the given path.
Unlike ViewItemContainer.getModelViewItem(String), this method accepts a path and not only a name, allowing to traverse composites.

Parameters:

itemContainer - The container of view items

itemPath - The path of the item to get

Returns:

The ViewElement. Can never be null

Throws:

UndefinedItemPathException - If one of the parts of the given path is undefined

BadItemTypeException - If one of the parts of the given path is defined, but is not of the correct type

getModelViewItemGroup

public static ModelViewItemGroup getModelViewItemGroup(ViewItemContainer itemContainer,
                                                       String itemPath)
                                                throws UndefinedItemPathException,
                                                       BadItemTypeException

Gets the ModelViewItemGroup from the ViewItemContainer at the given path.
Unlike ViewItemContainer.getModelViewItem(String), this method accepts a path and not only a name, allowing to traverse composites.

Parameters:

itemContainer - The container of view items

itemPath - The path of the container to get

Returns:

The ModelViewItemGroup. Can never be null

Throws:

UndefinedItemPathException - If one of the parts of the given path is undefined

BadItemTypeException - If one of the parts of the given path is defined, but is not of the correct type