org.ametys.cms.data.type

Class AbstractUserElementType

java.lang.Object

org.ametys.core.model.type.AbstractModelItemType

org.ametys.core.model.type.AbstractElementType<UserIdentity>

org.ametys.cms.data.type.AbstractUserElementType

All Implemented Interfaces:

ElementType<UserIdentity>, ModelItemType, PluginAware, Serviceable

Direct Known Subclasses:

UserRepositoryElementType

public abstract class AbstractUserElementType
extends AbstractElementType<UserIdentity>
implements Serviceable

Abstract class for user type of elements

Field Summary

Fields

Modifier and Type	Field and Description
protected UserHelper	_helper The user helper
protected UserManager	_userManager The user manager

Constructor Summary

Constructors

Constructor and Description
AbstractUserElementType()

Method Summary

Modifier and Type	Method and Description
protected Object	_singleValueToJSON(UserIdentity value) Convert the single value into a JSON object
protected void	_singleValueToSAX(ContentHandler contentHandler, String tagName, UserIdentity value, Locale locale) Generates SAX events for the given single value
UserIdentity	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
boolean	isSimple() Determines if this type is simple or not.
UserIdentity	parseConfiguration(Configuration configuration) Parses the given configuration to get the typed value
void	service(ServiceManager manager)
String	toString(UserIdentity value) Cast a typed value to a String

Methods inherited from class org.ametys.core.model.type.AbstractElementType

getManagedClass, getManagedClassArray, isCompatible, valueToJSONForClient, valueToSAX

Methods inherited from class org.ametys.core.model.type.AbstractModelItemType

getId, setPluginInfo

Methods inherited from class java.lang.Object

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

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

getId

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

setPluginInfo

Field Detail

_helper

protected UserHelper _helper

The user helper

_userManager

protected UserManager _userManager

The user manager

Constructor Detail

AbstractUserElementType

public AbstractUserElementType()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

castValue

public UserIdentity castValue(String value)
                       throws BadItemTypeException

Description copied from interface: ElementType

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

Specified by:

castValue in interface ElementType<UserIdentity>

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

public String toString(UserIdentity value)

Description copied from interface: ElementType

Cast a typed value to a String

Specified by:

toString in interface ElementType<UserIdentity>

Overrides:

toString in class AbstractElementType<UserIdentity>

Parameters:

value - the value to cast

Returns:

the String representation of the value

_singleValueToSAX

protected void _singleValueToSAX(ContentHandler contentHandler,
                                 String tagName,
                                 UserIdentity value,
                                 Locale locale)
                          throws SAXException

Description copied from class: AbstractElementType

Generates SAX events for the given single value

Overrides:

_singleValueToSAX in class AbstractElementType<UserIdentity>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

tagName - the tag name of the SAX event to generate.

value - the single value to SAX

locale - The locale to use for localized data. Can be null to generate SAX events for all existing Locales.

Throws:

SAXException - if an error occurs during the SAX events generation

parseConfiguration

public UserIdentity parseConfiguration(Configuration configuration)
                                throws ConfigurationException

Description copied from interface: ElementType

Parses the given configuration to get the typed value

Specified by:

parseConfiguration in interface ElementType<UserIdentity>

Overrides:

parseConfiguration in class AbstractElementType<UserIdentity>

Parameters:

configuration - the configuration to parse

Returns:

The typed value in the configuration

Throws:

ConfigurationException - if an error occurs while parsing the configuration

_singleValueToJSON

protected Object _singleValueToJSON(UserIdentity value)

Description copied from class: AbstractElementType

Convert the single value into a JSON object

Overrides:

_singleValueToJSON in class AbstractElementType<UserIdentity>

Parameters:

value - the value to convert

Returns:

The value as JSON

fromJSONForClient

public Object fromJSONForClient(Object json)

Description copied from interface: ElementType

Convert the given client side JSON object to the types value

Specified by:

fromJSONForClient in interface ElementType<UserIdentity>

Parameters:

json - the JSON object to convert

Returns:

the typed value corresponding to the JSON object

isSimple

public boolean isSimple()

Description copied from interface: ElementType

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

Specified by:

isSimple in interface ElementType<UserIdentity>

Returns:

true if the type is simple, false otherwise