org.ametys.runtime.model.type

Interface ElementType<T>

Type Parameters:

T - Type of the element value

All Superinterfaces:

ModelItemType, PluginAware

All Known Subinterfaces:

ComplexRepositoryElementType<T>, RepositoryElementType<T>, XMLElementType<T>, XSLElementType<T>

All Known Implementing Classes:

AbstractBinaryElementType, AbstractBooleanElementType, AbstractContentElementType, AbstractDateElementType, AbstractDateTimeElementType, AbstractDoubleElementType, AbstractElementType, AbstractFileElementType, AbstractGeocodeElementType, AbstractLongElementType, AbstractMultilingualStringElementType, AbstractReferenceElementType, AbstractRichTextElementType, AbstractStringElementType, AbstractUserElementType, BinaryRepositoryElementType, BooleanRepositoryElementType, BooleanXMLElementType, BooleanXSLElementType, ContentRepositoryElementType, DateRepositoryElementType, DateTimeRepositoryElementType, DateXMLElementType, DoubleRepositoryElementType, DoubleXMLElementType, DoubleXSLElementType, FileRepositoryElementType, GeocodeRepositoryElementType, LongRepositoryElementType, LongXMLElementType, LongXSLElementType, MultilingualStringRepositoryElementType, PasswordRepositoryElementType, PasswordXMLElementType, ReferenceRepositoryElementType, RichTextRepositoryElementType, StringRepositoryElementType, StringXMLElementType, StringXSLElementType, UserRepositoryElementType

public interface ElementType<T>
extends ModelItemType

Interface for element types

Method Summary

Modifier and Type	Method and Description
T	castValue(String value) Cast an untyped value (string) to an object of the corresponding type
Object	fromJSONForClient(Object json) Convert the given client side JSON object to the types value
Class	getManagedClass() Get the class managed by the implementation
Class	getManagedClassArray() Get the class representing an array of managed class by the implementation
boolean	isCompatible(Object value) Checks if the value is compatible with the element type
boolean	isSimple() Determines if this type is simple or not.
T	parseConfiguration(Configuration configuration) Parses the given configuration to get the typed value
String	toString(T value) Cast a typed value to a String
Object	valueToJSONForClient(Object value) Convert the value into a JSON object to use client side

Methods inherited from interface org.ametys.runtime.model.type.ModelItemType

getId, valueToSAX

Methods inherited from interface org.ametys.runtime.plugin.component.PluginAware

setPluginInfo

Method Detail

castValue

T castValue(String value)
     throws BadItemTypeException

Cast an untyped value (string) to an object of the corresponding type

Parameters:

value - the value to cast

Returns:

An object of the parameterized type representing the given value. Returns null if value cannot be cast

Throws:

BadItemTypeException - if the String value can't be cast to the type

toString

String toString(T value)

Cast a typed value to a String

Parameters:

value - the value to cast

Returns:

the String representation of the value

valueToJSONForClient

Object valueToJSONForClient(Object value)

Convert the value into a JSON object to use client side

Parameters:

value - the value to convert

Returns:

The value as JSON

fromJSONForClient

Object fromJSONForClient(Object json)

Convert the given client side JSON object to the types value

Parameters:

json - the JSON object to convert

Returns:

the typed value corresponding to the JSON object

parseConfiguration

T parseConfiguration(Configuration configuration)
              throws ConfigurationException

Parses the given configuration to get the typed value

Parameters:

configuration - the configuration to parse

Returns:

The typed value in the configuration

Throws:

ConfigurationException - if an error occurs while parsing the configuration

isSimple

boolean isSimple()

Determines if this type is simple or not. A simple element type is a type of elements that can be edited in a grid

Returns:

true if the type is simple, false otherwise

getManagedClass

Class getManagedClass()

Get the class managed by the implementation

Returns:

The class managed (T.class)

getManagedClassArray

Class getManagedClassArray()

Get the class representing an array of managed class by the implementation

Returns:

The class managed (T[].class)

isCompatible

boolean isCompatible(Object value)

Checks if the value is compatible with the element type

Parameters:

value - the value to check

Returns:

true if the value matches the current type, false otherwise