Package org.ametys.runtime.model

Class ModelItemGroup

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.ModelItemGroup

All Implemented Interfaces:

Comparable<ModelItem>, ModelItem, ModelItemAccessor, ModelItemContainer, Labelable, ModifiableLabelable

Direct Known Subclasses:

CompositeDefinition, RepeaterDefinition

public class ModelItemGroup
extends AbstractModelItem
implements ModelItemContainer

Class for group of model items

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__DEFAULT_TYPE_ID	Id for model item group types
private List<ModelItem>	_children
private ElementDefinition<Boolean>	_switcher
private ModelItemType	_type

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__serviceManager

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
ModelItemGroup()	Default constructor.
ModelItemGroup(String name, ModelItem... children)	Constructor used to create simple models and items

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_toJSON(DefinitionContext context)	Converts the model item in a JSON map
protected Map<String,Object>	_toJSON(DefinitionContext context, boolean includeChildren)	Converts the model item group in a JSON map
void	addChild(ModelItem child)	Add a child in the group
void	addChild(ModelItem child, boolean isGroupSwitch)	Add a child in the group
List<ModelItem>	getChildren()	Retrieves the list of children model items
List<ModelItem>	getChildren(boolean withSwitch)	Retrieves the list of children model items, with or without the switcher
Collection<ModelItem>	getModelItems()	Retrieves all the model items of this accessor
ElementDefinition<Boolean>	getSwitcher()	Retrieves the switcher element definition
ModelItemType	getType()	Retrieves the type.
static ModelItemGroup	of(String name, ModelItem... children)	Creates a ModelItemGroup
void	setModel(Model model)	Sets the model of the element
void	setType(ModelItemType type)	Set the type.
Map<String,Object>	toJSON(DefinitionContext context, boolean includeChildren)	Converts the model item group in a JSON map

Methods inherited from class org.ametys.runtime.model.AbstractModelItem

_shouldJSONBeEmpty, addItemChecker, compareTo, equals, getDescription, getItemCheckers, getLabel, getModel, getName, getParent, getPath, hashCode, setDescription, setLabel, setName, setParent, setServiceManager, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.runtime.model.ModelItemAccessor

getChild, getModelItem, hasModelItem

Field Detail

__DEFAULT_TYPE_ID

private static final String __DEFAULT_TYPE_ID

Id for model item group types

See Also:

Constant Field Values

_children

private List<ModelItem> _children

_switcher

private ElementDefinition<Boolean> _switcher

_type

private ModelItemType _type

Constructor Detail

ModelItemGroup

public ModelItemGroup()

Default constructor.

ModelItemGroup

public ModelItemGroup(String name,
                      ModelItem... children)

Constructor used to create simple models and items

Parameters:

name - the name of the definition

children - the group's children

Method Detail

getModelItems

public Collection<ModelItem> getModelItems()

Description copied from interface: ModelItemAccessor

Retrieves all the model items of this accessor

Specified by:

getModelItems in interface ModelItemAccessor

Returns:

the model items

getChildren

public List<ModelItem> getChildren()

Retrieves the list of children model items

Returns:

the children

getChildren

public List<ModelItem> getChildren(boolean withSwitch)

Retrieves the list of children model items, with or without the switcher

Parameters:

withSwitch - true to retrieve the switcher with the other children

Returns:

the children with or without the switcher

addChild

public void addChild(ModelItem child)

Add a child in the group

Parameters:

child - the item to add

addChild

public void addChild(ModelItem child,
                     boolean isGroupSwitch)

Add a child in the group

Parameters:

child - the child to add

isGroupSwitch - true if the child to add is the group switch, false otherwise

getSwitcher

public ElementDefinition<Boolean> getSwitcher()

Retrieves the switcher element definition

Returns:

the switcher

setModel

public void setModel(Model model)

Description copied from interface: ModelItem

Sets the model of the element

Specified by:

setModel in interface ModelItem

Overrides:

setModel in class AbstractModelItem

Parameters:

model - the model to set

getType

public ModelItemType getType()

Description copied from interface: ModelItem

Retrieves the type.

Specified by:

getType in interface ModelItem

Returns:

the type.

setType

public void setType(ModelItemType type)

Description copied from interface: ModelItem

Set the type.

Specified by:

setType in interface ModelItem

Parameters:

type - the type.

_toJSON

protected Map<String,Object> _toJSON(DefinitionContext context)
                                    throws ProcessingException

Description copied from class: AbstractModelItem

Converts the model item in a JSON map

Overrides:

_toJSON in class AbstractModelItem

Parameters:

context - the context of the definition

Returns:

The model item as a JSON map

Throws:

ProcessingException - If an error occurs when converting the model item

toJSON

public Map<String,Object> toJSON(DefinitionContext context,
                                       boolean includeChildren)
                                throws ProcessingException

Converts the model item group in a JSON map

Parameters:

context - the context of the definition

includeChildren - true to iterate and add children as elements in the returned JSON map, false otherwise

Returns:

The model item as a JSON map

Throws:

ProcessingException - If an error occurs when converting the model item group

_toJSON

protected Map<String,Object> _toJSON(DefinitionContext context,
                                           boolean includeChildren)
                                    throws ProcessingException

Converts the model item group in a JSON map

Parameters:

context - the context of the definition

includeChildren - true to iterate and add children as elements in the returned JSON map, false otherwise

Returns:

The model item as a JSON map

Throws:

ProcessingException - If an error occurs when converting the model item group

of

public static ModelItemGroup of(String name,
                                ModelItem... children)

Creates a ModelItemGroup

Parameters:

name - the group's name

children - the group's children

Returns:

the created ModelItemGroup