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
static enum	ViewHelper.InsertMode	The mode used to insert a view item in an existing view item accessor

Method Summary

Modifier and Type	Method	Description
static void	addViewAccessorItems(ViewItemAccessor currentAccessor, ViewItemAccessor accessorToInclude, ViewItemAccessor referenceViewItemAccessor, String accessorPath)	Add the items of the view item accessor to include if they are not already present in the current view item accessor or in the referenced one
static ModelViewItem	addViewItem(String relativePath, ViewItemAccessor viewItemAccessor, boolean expandContainers, boolean mergeContainers, ModelItemAccessor... modelItemAccessors)	Add a view item in the given accessor.
static ModelViewItem	addViewItem(String relativePath, ViewItemAccessor viewItemAccessor, ModelItemAccessor... modelItemAccessors)	Add a view item in the given accessor.
static boolean	areItemsPresentsOnlyOnce(View view)	Checks if all the items of the given view are present only once in the view Children of accessors that are not containers are not taken into account
static List<ViewItem>	copyViewItems(List<ViewItem> viewItems)	Copy the given view items.
static List<ViewItem>	copyViewItems(List<ViewItem> viewItems, Function<ViewItem,ViewItem> createCopyInstance)	Copy the given view items.
static <T extends ViewItemAccessor> T	createEmptyViewItemAccessor(Collection<? extends ModelItemAccessor> modelItemAccessors)	Creates an empty ViewItemAccessor The created container can be a View, a ModelViewItemGroup or a ViewElementAccessor, according to the given ModelItemAccessors.
static ModelViewItem	createModelViewItemInstance(ModelItem modelItem)	Creates an instance of ModelViewItem due to the given ModelItem
static <T extends ViewItemAccessor> T	createViewItemAccessor(Collection<? extends ModelItemAccessor> modelItemAccessors)	Creates a ViewItemAccessor with the items of the given ModelItemAccessor
static <T extends ViewItemAccessor> T	createViewItemAccessor(Collection<? extends ModelItemAccessor> modelItemAccessors, String... itemPaths)	Creates a ViewItemAccessor with the given items
static ViewItem	createViewItemInstance(ViewItem viewItem)	Create an instance of ViewItem from the given one
static Collection<ModelItem>	getModelItems(ViewItemAccessor viewItemAccessor)	Get the collection of model items from a view item accessor.
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(ViewItemAccessor viewItemAccessor, String itemPath)	Gets the ModelViewItem from the ViewItemAccessor at the given path.
static ModelViewItemGroup	getModelViewItemGroup(ViewItemAccessor viewItemAccessor, String itemPath)	Gets the ModelViewItemGroup from the ViewItemAccessor at the given path.
static String	getModelViewItemPath(ModelViewItem modelViewItem)	Retrieves the path of the given ModelViewItem.
static SimpleViewItemGroup	getSimpleViewItemGroup(ViewItemAccessor viewItemAccessor, String groupPath)	Retrieves the SimpleViewItemGroup at the given group path.
static View	getTruncatedView(View originalView)	Retrieves a View corresponding to the given one, avoiding the view items below the ViewItemAccessors that are not ViewItemContainers
static ViewElement	getViewElement(ViewItemAccessor viewItemAccessor, String itemPath)	Gets the ViewElement from the ViewItemAccessor at the given path.
static ViewItem	getViewItem(ViewItemAccessor viewItemAccessor, String viewItemPath)	Retrieves the ViewItem at the given view path.
static boolean	hasModelViewItem(ViewItemAccessor viewItemAccessor, String itemPath)	Checks if there is a ModelViewItem in the ViewItemAccessor at the given path
static void	insertItemAfterOrBefore(ViewItemAccessor viewItemAccessor, ViewItem itemToInsert, String insertAfterOrBefore, ViewHelper.InsertMode insertMode)	Insert the given ViewItem to the view before or after the item at the given path
static void	insertItemBefore(ViewItemAccessor viewItemAccessor, ViewItem viewItemToInsert, String insertBefore)	Insert the given ViewItem to the view before the item at the given path
static void	insertViewItemAfter(ViewItemAccessor viewItemAccessor, ViewItem viewItemToInsert, String insertAfter)	Insert the given ViewItem to the view after the item at the given path
static <T extends ViewItemAccessor> T	mergeDuplicatedItems(T originalViewItemAccessor)	Retrieves a ViewItemAccessor corresponding to the given one, where items that appears several times are merged
static Map<String,Object>	viewItemsToJSON(List<ViewItem> viewItems, DefinitionContext context)	Converts the given view items as a JSON map

Methods inherited from class java.lang.Object

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

Method Details

createModelViewItemInstance

public static ModelViewItem createModelViewItemInstance(ModelItem modelItem)

Creates an instance of ModelViewItem due to the given ModelItem

Parameters:

modelItem - the model item corresponding to the view item to create

Returns:

the created view item

getModelViewItemPath

public static String getModelViewItemPath(ModelViewItem modelViewItem)

Retrieves the path of the given ModelViewItem. Only keep segments of the model view items, does not include groups

Parameters:

modelViewItem - the model view item

Returns:

the model view item's path

copyViewItems

public static List<ViewItem> copyViewItems(List<ViewItem> viewItems)

Copy the given view items. Also copy the children of view item accessors

Parameters:

viewItems - the view items to copy

Returns:

the view items copies

copyViewItems

public static List<ViewItem> copyViewItems(List<ViewItem> viewItems,
 Function<ViewItem,ViewItem> createCopyInstance)

Copy the given view items. Also copy the children of view item accessors

Parameters:

viewItems - the view items to copy

createCopyInstance - the method to use to create the view item instances

Returns:

the view items copies

createViewItemInstance

public static ViewItem createViewItemInstance(ViewItem viewItem)

Create an instance of ViewItem from the given one

Parameters:

viewItem - the view item used to create the new instance of ViewItem

Returns:

the created ViewItem instance

addViewAccessorItems

public static void addViewAccessorItems(ViewItemAccessor currentAccessor,
 ViewItemAccessor accessorToInclude,
 ViewItemAccessor referenceViewItemAccessor,
 String accessorPath)

Add the items of the view item accessor to include if they are not already present in the current view item accessor or in the referenced one

Parameters:

currentAccessor - the current accessor

accessorToInclude - the accessor to include

referenceViewItemAccessor - the reference view item accessor

accessorPath - the path of the accessor relative to the reference view item accessor

createViewItemAccessor

public static <T extends ViewItemAccessor> T createViewItemAccessor(Collection<? extends ModelItemAccessor> modelItemAccessors)
                                                             throws IllegalArgumentException

Creates a ViewItemAccessor with the items of the given ModelItemAccessor

Type Parameters:

T - Type of the ViewItemAccessor to create (View, ModelViewItemGroup or ViewElementAccessor)

Parameters:

modelItemAccessors - the model item accessors

Returns:

the created ViewItemAccessor

Throws:

IllegalArgumentException - if the model item accessors collection is empty

createViewItemAccessor

public static <T extends ViewItemAccessor> T createViewItemAccessor(Collection<? extends ModelItemAccessor> modelItemAccessors,
 String... itemPaths)
                                                             throws IllegalArgumentException,
BadItemTypeException

Creates a ViewItemAccessor with the given items

Type Parameters:

T - Type of the ViewItemAccessor to create (View, ModelViewItemGroup or ViewElementAccessor)

Parameters:

modelItemAccessors - the model items accessing the items definitions

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

Returns:

the created ViewItemAccessor

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

createEmptyViewItemAccessor

public static <T extends ViewItemAccessor> T createEmptyViewItemAccessor(Collection<? extends ModelItemAccessor> modelItemAccessors)
                                                                  throws IllegalArgumentException

Creates an empty ViewItemAccessor The created container can be a View, a ModelViewItemGroup or a ViewElementAccessor, according to the given ModelItemAccessors.

Type Parameters:

T - The type of the created accessor

Parameters:

modelItemAccessors - the model items accessing the items definitions

Returns:

the created ViewItemAccessor

Throws:

IllegalArgumentException - if the model item accessors collection is empty

addViewItem

public static ModelViewItem addViewItem(String relativePath,
 ViewItemAccessor viewItemAccessor,
 ModelItemAccessor... modelItemAccessors)
                                 throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException

Add a view item in the given accessor. Only one view item is created for a given container. All paths with the same container are added in the same view item. If the last segment of the given path is a ModelItemContainer, all its children are added to the created view item

Parameters:

relativePath - path of the item to add

viewItemAccessor - the view item accessor

modelItemAccessors - the corresponding model item accessors

Returns:

the added view item

Throws:

IllegalArgumentException - if the path is null or empty

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

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

addViewItem

public static ModelViewItem addViewItem(String relativePath,
 ViewItemAccessor viewItemAccessor,
 boolean expandContainers,
 boolean mergeContainers,
 ModelItemAccessor... modelItemAccessors)
                                 throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException

Add a view item in the given accessor. If mergeContainers is set to true, only one view item is created for a given container. All paths with the same container are added in the same view item. If the last segment of the given path is a ModelItemContainer and expandContainers is set to true, all its children are added to the created view item

Parameters:

relativePath - path of the item to add

viewItemAccessor - the view item accessor

expandContainers - set to false to avoid to create view items for all children of the created view item if it is a container

mergeContainers - set to true to avoid to create new containers when they are already present in the given view item accessor

modelItemAccessors - the corresponding model item accessors

Returns:

the added view item

Throws:

IllegalArgumentException - if the path is null or empty

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

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

getSimpleViewItemGroup

public static SimpleViewItemGroup getSimpleViewItemGroup(ViewItemAccessor viewItemAccessor,
 String groupPath)

Retrieves the SimpleViewItemGroup at the given group path. All segments in the group path must refer to a SimpleViewItemGroup (tab, fieldset) If there are more than one corresponding items, the first one is retrieved

Parameters:

viewItemAccessor - The ViewItemAccessor in which to find the group of given path

groupPath - The group path

Returns:

the found SimpleViewItemGroup

Throws:

IllegalArgumentException - if the group path is empty

UndefinedItemPathException - if no group was found at the given path

getViewItem

public static ViewItem getViewItem(ViewItemAccessor viewItemAccessor,
 String viewItemPath)

Retrieves the ViewItem at the given view path. If items are in groups, the names of the groups must appear in the path. All groups have to be named If there are more than one corresponding items, the first one is retrieved

Parameters:

viewItemAccessor - The ViewItemAccessor in which to find the view item of given path

viewItemPath - The view item path

Returns:

the found ViewItem

Throws:

IllegalArgumentException - if the view item path is empty

UndefinedItemPathException - if no view item was found at the given path

insertViewItemAfter

public static void insertViewItemAfter(ViewItemAccessor viewItemAccessor,
 ViewItem viewItemToInsert,
 String insertAfter)
                                throws IllegalArgumentException,
UndefinedItemPathException

Insert the given ViewItem to the view after the item at the given path

Parameters:

viewItemAccessor - The ViewItemAccessor in which to insert the view item

viewItemToInsert - The view item to insert

insertAfter - The name of the view item after which the given one has to be inserted. The item with this name must appear in the given accessor

Throws:

IllegalArgumentException - If the given view item path is null or empty

UndefinedItemPathException - If the given view item path is not present in the view item accessor

insertItemBefore

public static void insertItemBefore(ViewItemAccessor viewItemAccessor,
 ViewItem viewItemToInsert,
 String insertBefore)
                             throws IllegalArgumentException,
UndefinedItemPathException

Insert the given ViewItem to the view before the item at the given path

Parameters:

viewItemAccessor - The ViewItemAccessor in which to insert the item

viewItemToInsert - The view item to insert

insertBefore - The name of the view item before which the given one has to be inserted. The item with this name must appear in the given accessor

Throws:

IllegalArgumentException - If the ModelItem "insertBefore" is null or empty

UndefinedItemPathException - If the path to the modelItem "insertBefore" is undefined

insertItemAfterOrBefore

public static void insertItemAfterOrBefore(ViewItemAccessor viewItemAccessor,
 ViewItem itemToInsert,
 String insertAfterOrBefore,
 ViewHelper.InsertMode insertMode)
                                    throws IllegalArgumentException,
UndefinedItemPathException

Insert the given ViewItem to the view before or after the item at the given path

Parameters:

viewItemAccessor - The ViewItemAccessor in which to insert the item

itemToInsert - The view item to insert

insertAfterOrBefore - The name of the view item before or after which the given one has to be inserted. The item with this name must appear in the given accessor

insertMode - The mode of insertion (before or after)

Throws:

IllegalArgumentException - If the ModelItem "insertAfterOrBefore" is null, empty, or is a path

UndefinedItemPathException - If the path to the modelItem "insertAfterOrBefore" is undefined

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

areItemsPresentsOnlyOnce

public static boolean areItemsPresentsOnlyOnce(View view)

Checks if all the items of the given view are present only once in the view Children of accessors that are not containers are not taken into account

Parameters:

view - the view to check

Returns:

true if all items are presents only once, false otherwise

getTruncatedView

public static View getTruncatedView(View originalView)

Retrieves a View corresponding to the given one, avoiding the view items below the ViewItemAccessors that are not ViewItemContainers

Parameters:

originalView - the view to truncate

Returns:

the truncated view

mergeDuplicatedItems

public static <T extends ViewItemAccessor> T mergeDuplicatedItems(T originalViewItemAccessor)

Retrieves a ViewItemAccessor corresponding to the given one, where items that appears several times are merged

Type Parameters:

T - The type of ViewItemAccessor to merge

Parameters:

originalViewItemAccessor - the ViewItemAccessor to merge

Returns:

the merged ViewItemAccessor

hasModelViewItem

public static boolean hasModelViewItem(ViewItemAccessor viewItemAccessor,
 String itemPath)

Checks if there is a ModelViewItem in the ViewItemAccessor at the given path

Parameters:

viewItemAccessor - The accessor of the view items

itemPath - The path of the item to check

Returns:

true if there is a model view item at the given path, false otherwise

viewItemsToJSON

public static Map<String,Object> viewItemsToJSON(List<ViewItem> viewItems,
 DefinitionContext context)
                                          throws ProcessingException

Converts the given view items as a JSON map

Parameters:

viewItems - the view items to convert

context - the context of the items' definitions

Returns:

The view items as a JSON map

Throws:

ProcessingException - If an error occurs when converting the view items

getModelViewItem

public static ModelViewItem getModelViewItem(ViewItemAccessor viewItemAccessor,
 String itemPath)
                                      throws UndefinedItemPathException,
BadItemTypeException

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

Parameters:

viewItemAccessor - The accessor 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(ViewItemAccessor viewItemAccessor,
 String itemPath)
                                  throws UndefinedItemPathException,
BadItemTypeException

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

Parameters:

viewItemAccessor - The accessor 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(ViewItemAccessor viewItemAccessor,
 String itemPath)
                                                throws UndefinedItemPathException,
BadItemTypeException

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

Parameters:

viewItemAccessor - The accessor 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

getModelItems

public static Collection<ModelItem> getModelItems(ViewItemAccessor viewItemAccessor)

Get the collection of model items from a view item accessor.

Parameters:

viewItemAccessor - The view item accessor

Returns:

a collection of model items