org.ametys.cms.data.type

Class AbstractFileElementType

java.lang.Object

org.ametys.core.model.type.AbstractModelItemType

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

org.ametys.cms.data.type.AbstractFileElementType

All Implemented Interfaces:

ElementType<File>, ModelItemType, PluginAware, Component, Configurable, Serviceable

Direct Known Subclasses:

FileRepositoryElementType

public abstract class AbstractFileElementType
extends AbstractElementType<File>
implements Component, Serviceable, Configurable

Abstract class for file type of elements

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	__EXPLORER_FILE_TYPE Type of he file from explorer
protected String	_binaryType Type of the binary
protected AmetysObjectResolver	_resolver Ametys object resolver

Constructor Summary

Constructors

Constructor and Description
AbstractFileElementType()

Method Summary

Modifier and Type	Method and Description
protected boolean	_hasAmetysObjectsForIdentifiers(String... identifiers) Check if ametys objects exist with the given identifiers
File	castValue(String value) Cast an untyped value (string) to an object of the corresponding type
void	configure(Configuration configuration)
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.
File	parseConfiguration(Configuration configuration) Parses the given configuration to get the typed value
void	service(ServiceManager manager)
String	toString(File value) Cast a typed value to a String
Object	valueToJSONForClient(Object value) Convert the value into a JSON object to use client side
void	valueToSAX(ContentHandler contentHandler, String tagName, Object value, Locale locale) Generates SAX events for the given value

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

_singleValueToJSON, _singleValueToSAX, getManagedClass, getManagedClassArray, isCompatible

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

__EXPLORER_FILE_TYPE

protected static final String __EXPLORER_FILE_TYPE

Type of he file from explorer

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_binaryType

protected String _binaryType

Type of the binary

Constructor Detail

AbstractFileElementType

public AbstractFileElementType()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

castValue

public File 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<File>

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(File value)

Description copied from interface: ElementType

Cast a typed value to a String

Specified by:

toString in interface ElementType<File>

Overrides:

toString in class AbstractElementType<File>

Parameters:

value - the value to cast

Returns:

the String representation of the value

valueToSAX

public void valueToSAX(ContentHandler contentHandler,
                       String tagName,
                       Object value,
                       Locale locale)
                throws SAXException

Description copied from interface: ModelItemType

Generates SAX events for the given value

Specified by:

valueToSAX in interface ModelItemType

Overrides:

valueToSAX in class AbstractElementType<File>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

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

value - the 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 File 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<File>

Overrides:

parseConfiguration in class AbstractElementType<File>

Parameters:

configuration - the configuration to parse

Returns:

The typed value in the configuration

Throws:

ConfigurationException - if an error occurs while parsing the configuration

valueToJSONForClient

public Object valueToJSONForClient(Object value)

Description copied from interface: ElementType

Convert the value into a JSON object to use client side

Specified by:

valueToJSONForClient in interface ElementType<File>

Overrides:

valueToJSONForClient in class AbstractElementType<File>

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<File>

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<File>

Returns:

true if the type is simple, false otherwise

_hasAmetysObjectsForIdentifiers

protected boolean _hasAmetysObjectsForIdentifiers(String... identifiers)

Check if ametys objects exist with the given identifiers

Parameters:

identifiers - the identifiers

Returns:

true if ametys object exist for each identifier, false otherwise