Package org.ametys.runtime.model

Class AbstractModelItem

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

All Implemented Interfaces:

Comparable<ModelItem>, ModelItem, Labelable, ModifiableLabelable

Direct Known Subclasses:

DefaultElementDefinition, ModelItemGroup

public abstract class AbstractModelItem
extends Object
implements ModelItem

Abstract class for model items

Field Summary

Fields

Modifier and Type	Field	Description
protected static ServiceManager	__serviceManager	The service manager

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

ITEM_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
AbstractModelItem()	Default constructor.
AbstractModelItem(String name)	Constructor used to create simple models and items
AbstractModelItem(ModelItem modelItemToCopy)	Constructor by copying an existing AbstractModelItem.

Method Summary

Modifier and Type	Method	Description
protected ModelItemHelper	_getModelItemHelper()	Retrieves the ModelItemHelper
protected boolean	_shouldJSONBeEmpty(DefinitionContext context)	Checks if the current definition JSON conversion should return an empty map
protected Map<String,Object>	_toJSON(DefinitionContext context)	Converts the model item in a JSON map
protected void	_widgetParameterToSAX(ContentHandler contentHandler, String parameterName, I18nizableText parameterValue, DefinitionContext context)	Generates SAX events for the given widget parameter
protected Map<String,Object>	_widgetToJSON(DefinitionContext context)	Converts the model item's widget in a JSON map
protected void	_widgetToSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the model item's widget
void	addItemChecker(ItemCheckerDescriptor itemChecker)	Add an item checker to the group
int	compareTo(ModelItem item)
protected Map<String,Object>	disableConditionsToJSON()	Converts the definition's disable conditions in a JSON map
boolean	equals(Object obj)
I18nizableText	getDescription()	Retrieves the description.
DisableConditions	getDisableConditions()	Retrieves the disable condition.
Set<ItemCheckerDescriptor>	getItemCheckers()	Returns the ItemCheckerDescriptors associated with this group.
I18nizableText	getLabel()	Retrieves the label.
Model	getModel()	Retrieves the model of the item
String	getName()	Get the name.
ModelItemGroup	getParent()	Retrieves the parent of the item
String	getPath()	Retrieves the path of the model item
String	getPluginName()	Retrieves the name of the plugin declaring this element.
String	getWidget()	Retrieves the widget to use for rendering.
Map<String,I18nizableText>	getWidgetParameters()	Get the widget's parameters
int	hashCode()
void	setDescription(I18nizableText description)	Set the description.
void	setDisableConditions(DisableConditions disableConditions)	Sets the disable condition.
void	setLabel(I18nizableText label)	Set the label.
void	setModel(Model model)	Sets the model of the element
void	setName(String name)	Set the name.
void	setParent(ModelItemGroup parent)	Sets the parent of the item
void	setPluginName(String pluginName)	Set the name of the plugin declaring this element.
static void	setServiceManager(ServiceManager manager)	Set the service manager The ServiceManager is used in the model items creation methods to get the model item type.
void	setWidget(String widget)	Set the widget.
void	setWidgetParameters(Map<String,I18nizableText> params)	Set the widget's parameters
Map<String,Object>	toJSON(DefinitionContext context)	Converts the model item in a JSON map
void	toSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the model item
String	toString()

Methods inherited from class java.lang.Object

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

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

getCriterionWidget, getCriterionWidgetParameters, getType, setType

Field Details

__serviceManager

protected static ServiceManager __serviceManager

The service manager

Constructor Details

AbstractModelItem

public AbstractModelItem()

Default constructor.

AbstractModelItem

public AbstractModelItem(String name)

Constructor used to create simple models and items

Parameters:

name - the name of the item

AbstractModelItem

public AbstractModelItem(ModelItem modelItemToCopy)

Constructor by copying an existing AbstractModelItem.

Parameters:

modelItemToCopy - The AbstractModelItem to copy

Method Details

getName

public String getName()

Description copied from interface: Labelable

Get the name.

Specified by:

getName in interface Labelable

Returns:

the name.

setName

public void setName(String name)

Description copied from interface: ModifiableLabelable

Set the name.

Specified by:

setName in interface ModifiableLabelable

Parameters:

name - the name.

getPluginName

public String getPluginName()

Description copied from interface: ModelItem

Retrieves the name of the plugin declaring this element.

Specified by:

getPluginName in interface ModelItem

Returns:

the plugin name.

setPluginName

public void setPluginName(String pluginName)

Description copied from interface: ModelItem

Set the name of the plugin declaring this element.

Specified by:

setPluginName in interface ModelItem

Parameters:

pluginName - the plugin name.

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Returns:

the label.

setLabel

public void setLabel(I18nizableText label)

Description copied from interface: ModifiableLabelable

Set the label.

Specified by:

setLabel in interface ModifiableLabelable

Parameters:

label - the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Returns:

the description.

setDescription

public void setDescription(I18nizableText description)

Description copied from interface: ModifiableLabelable

Set the description.

Specified by:

setDescription in interface ModifiableLabelable

Parameters:

description - the description.

addItemChecker

public void addItemChecker(ItemCheckerDescriptor itemChecker)

Description copied from interface: ModelItem

Add an item checker to the group

Specified by:

addItemChecker in interface ModelItem

Parameters:

itemChecker - the item checker to add

getItemCheckers

public Set<ItemCheckerDescriptor> getItemCheckers()

Description copied from interface: ModelItem

Returns the ItemCheckerDescriptors associated with this group.

Specified by:

getItemCheckers in interface ModelItem

Returns:

the ItemCheckerDescriptors associated with this group.

getWidget

public String getWidget()

Description copied from interface: ModelItem

Retrieves the widget to use for rendering.

Specified by:

getWidget in interface ModelItem

Returns:

the widget or null if none is defined.

setWidget

public void setWidget(String widget)

Description copied from interface: ModelItem

Set the widget.

Specified by:

setWidget in interface ModelItem

Parameters:

widget - the widget.

getWidgetParameters

public Map<String,I18nizableText> getWidgetParameters()

Description copied from interface: ModelItem

Get the widget's parameters

Specified by:

getWidgetParameters in interface ModelItem

Returns:

the widget's parameters

setWidgetParameters

public void setWidgetParameters(Map<String,I18nizableText> params)

Description copied from interface: ModelItem

Set the widget's parameters

Specified by:

setWidgetParameters in interface ModelItem

Parameters:

params - the parameters to set

getDisableConditions

public DisableConditions getDisableConditions()

Description copied from interface: ModelItem

Retrieves the disable condition.

Specified by:

getDisableConditions in interface ModelItem

Returns:

the disable condition or null if none is defined.

setDisableConditions

public void setDisableConditions(DisableConditions disableConditions)

Description copied from interface: ModelItem

Sets the disable condition.

Specified by:

setDisableConditions in interface ModelItem

Parameters:

disableConditions - the disable condition.

getPath

public String getPath()

Description copied from interface: ModelItem

Retrieves the path of the model item

Specified by:

getPath in interface ModelItem

Returns:

the item path

getModel

public Model getModel()

Description copied from interface: ModelItem

Retrieves the model of the item

Specified by:

getModel in interface ModelItem

Returns:

the model

setModel

public void setModel(Model model)

Description copied from interface: ModelItem

Sets the model of the element

Specified by:

setModel in interface ModelItem

Parameters:

model - the model to set

getParent

public ModelItemGroup getParent()

Description copied from interface: ModelItem

Retrieves the parent of the item

Specified by:

getParent in interface ModelItem

Returns:

the parent group

setParent

public void setParent(ModelItemGroup parent)

Description copied from interface: ModelItem

Sets the parent of the item

Specified by:

setParent in interface ModelItem

Parameters:

parent - the parent to set

toJSON

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

Description copied from interface: ModelItem

Converts the model item in a JSON map

Specified by:

toJSON in interface ModelItem

Parameters:

context - the context of the definition

Returns:

The model item as a JSON map, or an empty map

Throws:

ProcessingException - If an error occurs when converting the model item

_toJSON

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

Converts the model item in a JSON map

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

_widgetToJSON

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

Converts the model item's widget in a JSON map

Parameters:

context - the context of the definition

Returns:

The model item's widget as a JSON map

Throws:

ProcessingException - If an error occurs when converting the model item

disableConditionsToJSON

protected Map<String,Object> disableConditionsToJSON()

Converts the definition's disable conditions in a JSON map

Returns:

The definition's disable conditions as a JSON map

_shouldJSONBeEmpty

protected boolean _shouldJSONBeEmpty(DefinitionContext context)

Checks if the current definition JSON conversion should return an empty map

Parameters:

context - the context of the definition

Returns:

true if the JSON conversion should return an empty map, false otherwise

toSAX

public void toSAX(ContentHandler contentHandler,
 DefinitionContext context)
           throws SAXException

Description copied from interface: ModelItem

Generates SAX events for the model item

Specified by:

toSAX in interface ModelItem

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - the context of the definition

Throws:

SAXException - if an error occurs during the SAX events generation

_widgetToSAX

protected void _widgetToSAX(ContentHandler contentHandler,
 DefinitionContext context)
                     throws SAXException

Generates SAX events for the model item's widget

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - the context of the definition

Throws:

SAXException - if an error occurs during the SAX events generation

_widgetParameterToSAX

protected void _widgetParameterToSAX(ContentHandler contentHandler,
 String parameterName,
 I18nizableText parameterValue,
 DefinitionContext context)
                              throws SAXException

Generates SAX events for the given widget parameter

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

parameterName - the name of the parameter

parameterValue - the value of the parameter

context - the context of the definition

Throws:

SAXException - if an error occurs during the SAX events generation

compareTo

public int compareTo(ModelItem item)

Specified by:

compareTo in interface Comparable<ModelItem>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

_getModelItemHelper

protected ModelItemHelper _getModelItemHelper()

Retrieves the ModelItemHelper

Returns:

the ModelItemHelper

setServiceManager

public static void setServiceManager(ServiceManager manager)

Set the service manager The ServiceManager is used in the model items creation methods to get the model item type. ModelItem is not a Component and can't have a ServiceManager itself. Another Component has to set it

Parameters:

manager - the service manager to set