Package org.ametys.cms.data.type

Class AbstractUserElementType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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, LogEnabled, PluginAware, Component, Serviceable

Direct Known Subclasses:

UserRepositoryElementType

public abstract class AbstractUserElementType
extends AbstractElementType<UserIdentity>

Abstract class for user type of elements

Field Summary

Fields

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

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

_jsonUtils

Constructor Summary

Constructors

Constructor	Description
AbstractUserElementType()

Method Summary

Modifier and Type	Method	Description
protected UserIdentity	_singleValueFromXML(Element element, Optional<Object> additionalData)	Retrieves a single typed value from the given DOM node
protected Object	_singleValueToJSON(UserIdentity value, DataContext context)	Convert the single value into a JSON object
protected void	_singleValueToSAX(ContentHandler contentHandler, String tagName, UserIdentity value, Optional<ViewItem> viewItem, DataContext context, AttributesImpl attributes)	Generates SAX events for the given single value
protected boolean	_useJSONForEdition()	Determine if the JSON format has to be used in edition mode for this element type
UserIdentity	convertValue(Object value)	Try to convert the given value.
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.
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

_compareMultipleValues, _compareSingleValues, _getValueAttributes, _isValueFromXMLMultiple, _valueToSAX, _valueToSAX, _valueToSAXForEdition, castValue, compareValues, getManagedClass, getManagedClassArray, isCompatible, parseConfiguration, valueFromXML, valueToJSONForClient, valueToSAX, valueToSAXForEdition

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

_getContextAttributes, getId, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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, valueToSAX

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

Overrides:

service in class AbstractElementType<UserIdentity>

Throws:

ServiceException

convertValue

public UserIdentity convertValue(Object value)

Description copied from class: AbstractElementType

Try to convert the given value.

Overrides:

convertValue in class AbstractElementType<UserIdentity>

Parameters:

value - the value to convert

Returns:

the converted value or null if it's not possible.

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

fromJSONForClient

public Object fromJSONForClient(Object json)

Description copied from interface: ElementType

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

_singleValueToJSON

protected Object _singleValueToJSON(UserIdentity value,
                                    DataContext context)

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

context - The context of the data to convert

Returns:

The value as JSON

_singleValueFromXML

protected UserIdentity _singleValueFromXML(Element element,
                                           Optional<Object> additionalData)
                                    throws TransformerException,
                                           IOException

Description copied from class: AbstractElementType

Retrieves a single typed value from the given DOM node

Overrides:

_singleValueFromXML in class AbstractElementType<UserIdentity>

Parameters:

element - the DOM element containing the single value

additionalData - additional data needed to get the typed value

Returns:

the value

Throws:

TransformerException - if an error occurs while parsing the DOM node

IOException - if an error occurs while parsing a value using the I/O API

_singleValueToSAX

protected void _singleValueToSAX(ContentHandler contentHandler,
                                 String tagName,
                                 UserIdentity value,
                                 Optional<ViewItem> viewItem,
                                 DataContext context,
                                 AttributesImpl attributes)
                          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

viewItem - The optional view item corresponding item that is currently saxed. This view item gives context for the SAX event that will be generated here.

context - The context of the data to SAX

attributes - the attributes for the SAX event to generate

Throws:

SAXException - if an error occurs during the SAX events generation

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

Returns:

true if the type is simple, false otherwise

_useJSONForEdition

protected boolean _useJSONForEdition()

Description copied from class: AbstractElementType

Determine if the JSON format has to be used in edition mode for this element type

Overrides:

_useJSONForEdition in class AbstractElementType<UserIdentity>

Returns:

true if the JSON format has to be used, false otherwise