Package org.ametys.runtime.model

Class DefaultElementDefinition<T>

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<T>

Type Parameters:

T - Type of the element value

All Implemented Interfaces:

Comparable<ModelItem>, ElementDefinition<T>, ModelItem, Labelable, ModifiableLabelable

Direct Known Subclasses:

AbstractProperty, AttributeDefinition, DefaultContentElementDefinition, ServiceParameter, ViewParameter

public class DefaultElementDefinition<T>
extends AbstractModelItem
implements ElementDefinition<T>

The definition of a single model item (parameter, attribute)

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	_logger	The definition logger

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

__serviceManager

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

CONFIG_DEFAULT_VALUE_TYPE

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

ITEM_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
DefaultElementDefinition()	Default constructor.
DefaultElementDefinition(String name, boolean isMultiple, ElementType<T> type)	Constructor used to create simple models and items
DefaultElementDefinition(ElementDefinition<T> definitionToCopy)	Constructor by copying an existing ElementDefinition.

Method Summary

Modifier and Type	Method	Description
protected T	_getDefaultValue(String defaultValueType, Object parsedDefaultValue)	Retrieves the default value from the parsed one, according to the type of the default value
List<Pair<String,Object>>	_getParsedDefaultValues()	Retrieves the parsed default values
protected Map<String,Object>	_toJSON(DefinitionContext context)	Converts the model item in a JSON map
String	getCustomEnumerator()	Retrieves the custom enumerator's class name
String	getCustomValidator()	Retrieves the custom validator's class name
<X> X	getDefaultValue()	Retrieves the default value, as an object corresponding to the definition's type and cardinality Retrieves null if no default value is defined for this definition
Enumerator<T>	getEnumerator()	Retrieves the enumerator.
Configuration	getEnumeratorConfiguration()	Retrieves the custom enumerator's configuration
ElementType<T>	getType()	Retrieves the type.
Validator	getValidator()	Retrieves the validator.
Configuration	getValidatorConfiguration()	Retrieves the custom validator's configuraiton
String	getWidget()	Retrieves the widget to use for rendering.
Map<String,I18nizableText>	getWidgetParameters()	Get the widget's parameters
boolean	isMultiple()	Test if the element is multiple.
static DefaultElementDefinition	of(String name, boolean isMultiple, String typeId, String availableTypesExtensionPoint)	Creates a DefaultElementDefinition
void	setCustomEnumerator(String customEnumerator)	Set the custom enumerator's class name
void	setCustomValidator(String customValidator)	Set the custom validator's class name
void	setDefaultValue(T defaultValue)	Set a default value to the definition The default value is single, classic default value
void	setEnumerator(Enumerator<T> enumerator)	Set the enumerator.
void	setEnumeratorConfiguration(Configuration enumeratorConfiguration)	Set the custom enumerator's configuration
void	setMultiple(boolean isMultiple)	Set the element multiple status.
void	setParsedDefaultValues(List<Pair<String,Object>> parsedDefaultValues)	Set the parsed default values.
void	setType(ModelItemType type)	Set the type.
void	setValidator(Validator validator)	Set the validator.
void	setValidatorConfiguration(Configuration validatorConfiguration)	Set the custom validator's configuration
void	setWidget(String widget)	Set the widget.
void	setWidgetParameters(Map<String,I18nizableText> params)	Set the widget's parameters
void	toSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the model item

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

_shouldJSONBeEmpty, _widgetParameterToSAX, _widgetToSAX, addItemChecker, compareTo, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, setDescription, setDisableConditions, setLabel, setModel, setName, setParent, setPluginName, setServiceManager, toJSON, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

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

getCriterionEnumerator, isEditable

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

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

addItemChecker, getCriterionWidget, getCriterionWidgetParameters, getDisableConditions, getItemCheckers, getModel, getParent, getPath, getPluginName, setDisableConditions, setModel, setParent, setPluginName, toJSON

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel, setName

Field Details

_logger

protected Logger _logger

The definition logger

Constructor Details

DefaultElementDefinition

public DefaultElementDefinition()

Default constructor.

DefaultElementDefinition

public DefaultElementDefinition(String name,
 boolean isMultiple,
 ElementType<T> type)

Constructor used to create simple models and items

Parameters:

name - the name of the definition

isMultiple - the element multiple status

type - the type of the definition

DefaultElementDefinition

public DefaultElementDefinition(ElementDefinition<T> definitionToCopy)

Constructor by copying an existing ElementDefinition.

Parameters:

definitionToCopy - The ElementDefinition to copy

Method Details

getType

public ElementType<T> getType()

Description copied from interface: ModelItem

Retrieves the type.

Specified by:

getType in interface ElementDefinition<T>

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.

getEnumerator

public Enumerator<T> getEnumerator()

Description copied from interface: ElementDefinition

Retrieves the enumerator.

Specified by:

getEnumerator in interface ElementDefinition<T>

Returns:

the enumerator or null if none is defined.

setEnumerator

public void setEnumerator(Enumerator<T> enumerator)

Description copied from interface: ElementDefinition

Set the enumerator.

Specified by:

setEnumerator in interface ElementDefinition<T>

Parameters:

enumerator - the enumerator.

getCustomEnumerator

public String getCustomEnumerator()

Description copied from interface: ElementDefinition

Retrieves the custom enumerator's class name

Specified by:

getCustomEnumerator in interface ElementDefinition<T>

Returns:

the custom enumerator's class name

setCustomEnumerator

public void setCustomEnumerator(String customEnumerator)

Description copied from interface: ElementDefinition

Set the custom enumerator's class name

Specified by:

setCustomEnumerator in interface ElementDefinition<T>

Parameters:

customEnumerator - the custom enumerator's class name

getEnumeratorConfiguration

public Configuration getEnumeratorConfiguration()

Description copied from interface: ElementDefinition

Retrieves the custom enumerator's configuration

Specified by:

getEnumeratorConfiguration in interface ElementDefinition<T>

Returns:

the custom enumerator's configuration

setEnumeratorConfiguration

public void setEnumeratorConfiguration(Configuration enumeratorConfiguration)

Description copied from interface: ElementDefinition

Set the custom enumerator's configuration

Specified by:

setEnumeratorConfiguration in interface ElementDefinition<T>

Parameters:

enumeratorConfiguration - the custom enumerator's configuration

getValidator

public Validator getValidator()

Description copied from interface: ElementDefinition

Retrieves the validator.

Specified by:

getValidator in interface ElementDefinition<T>

Returns:

the validator or null if none is defined.

setValidator

public void setValidator(Validator validator)

Description copied from interface: ElementDefinition

Set the validator.

Specified by:

setValidator in interface ElementDefinition<T>

Parameters:

validator - the validator.

getCustomValidator

public String getCustomValidator()

Description copied from interface: ElementDefinition

Retrieves the custom validator's class name

Specified by:

getCustomValidator in interface ElementDefinition<T>

Returns:

the custom validator's class name

setCustomValidator

public void setCustomValidator(String customValidator)

Description copied from interface: ElementDefinition

Set the custom validator's class name

Specified by:

setCustomValidator in interface ElementDefinition<T>

Parameters:

customValidator - the custom validator's class name

getValidatorConfiguration

public Configuration getValidatorConfiguration()

Description copied from interface: ElementDefinition

Retrieves the custom validator's configuraiton

Specified by:

getValidatorConfiguration in interface ElementDefinition<T>

Returns:

the custom validator's configuration

getWidget

public String getWidget()

Description copied from interface: ModelItem

Retrieves the widget to use for rendering.

Specified by:

getWidget in interface ModelItem

Overrides:

getWidget in class AbstractModelItem

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

Overrides:

setWidget in class AbstractModelItem

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

Overrides:

getWidgetParameters in class AbstractModelItem

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

Overrides:

setWidgetParameters in class AbstractModelItem

Parameters:

params - the parameters to set

setValidatorConfiguration

public void setValidatorConfiguration(Configuration validatorConfiguration)

Description copied from interface: ElementDefinition

Set the custom validator's configuration

Specified by:

setValidatorConfiguration in interface ElementDefinition<T>

Parameters:

validatorConfiguration - the custom validator's configuration

getDefaultValue

public <X> X getDefaultValue()

Description copied from interface: ElementDefinition

Retrieves the default value, as an object corresponding to the definition's type and cardinality Retrieves null if no default value is defined for this definition

Specified by:

getDefaultValue in interface ElementDefinition<T>

Type Parameters:

X - The type of the default value

Returns:

the default value.

_getDefaultValue

protected T _getDefaultValue(String defaultValueType,
 Object parsedDefaultValue)

Retrieves the default value from the parsed one, according to the type of the default value

Parameters:

parsedDefaultValue - the parsed default value (can be an I18nizableText, a config parameter name, ... depending on the default value type)

defaultValueType - the type of the default value

Returns:

the default value.

setParsedDefaultValues

public void setParsedDefaultValues(List<Pair<String,Object>> parsedDefaultValues)

Description copied from interface: ElementDefinition

Set the parsed default values. If the definition is not multiple, the list should contain only one element A parsed default value is described by its type and an object depending on the type

Specified by:

setParsedDefaultValues in interface ElementDefinition<T>

Parameters:

parsedDefaultValues - the parsed default values.

setDefaultValue

public void setDefaultValue(T defaultValue)

Description copied from interface: ElementDefinition

Set a default value to the definition The default value is single, classic default value

Specified by:

setDefaultValue in interface ElementDefinition<T>

Parameters:

defaultValue - the default value to set

_getParsedDefaultValues

public List<Pair<String,Object>> _getParsedDefaultValues()

Description copied from interface: ElementDefinition

Retrieves the parsed default values

Specified by:

_getParsedDefaultValues in interface ElementDefinition<T>

Returns:

the parsed default values

isMultiple

public boolean isMultiple()

Description copied from interface: ElementDefinition

Test if the element is multiple.

Specified by:

isMultiple in interface ElementDefinition<T>

Returns:

true if the metadata is multiple.

setMultiple

public void setMultiple(boolean isMultiple)

Description copied from interface: ElementDefinition

Set the element multiple status.

Specified by:

setMultiple in interface ElementDefinition<T>

Parameters:

isMultiple - the element multiple status.

_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

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

Overrides:

toSAX in class AbstractModelItem

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

of

public static DefaultElementDefinition of(String name,
 boolean isMultiple,
 String typeId,
 String availableTypesExtensionPoint)
                                   throws UnknownTypeException,
BadItemTypeException,
ServiceException

Creates a DefaultElementDefinition

Parameters:

name - the definition's name

isMultiple - the definition's cardinality

typeId - the definition's type identifier

availableTypesExtensionPoint - the role of the extension point containing all available types for this DefaultElementDefinition

Returns:

the created DefaultElementDefinition

Throws:

UnknownTypeException - if the given type identifier is not available in the extension point

BadItemTypeException - if the given type identifier can not be used for an ElementDefinition

ServiceException - if an error occurs while getting the extension point of available types