org.ametys.plugins.repository.data.type

Interface ComplexRepositoryElementType<T>

Type Parameters:

T - Type of the element value

All Superinterfaces:

ElementType<T>, ModelItemType, PluginAware, RepositoryElementType<T>, RepositoryModelItemType

All Known Implementing Classes:

BinaryRepositoryElementType, GeocodeRepositoryElementType, MultilingualStringRepositoryElementType, ReferenceRepositoryElementType, RichTextRepositoryElementType, UserRepositoryElementType

public interface ComplexRepositoryElementType<T>
extends RepositoryElementType<T>

Interface for complex types of elements stored in the repository The complex types ares those which need nodes to be stored

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_ID_DATA_NAME Data name for storing the type identifier of an element with multiple values

Method Summary

Modifier and Type	Method and Description
String	getNodeType() Retrieves the type of node used for this type
default boolean	isCompatible(RepositoryData parentData, String name) Checks if the value in the given repository data is compatible with the item type
default Object	read(RepositoryData parentData, String name) Read the value in the given repository data
T	readSingleValue(RepositoryData singleValueData) Read the single value in the given repository data
default boolean	removeValueBeforeWritingIt() Determines if the existing value has to be removed before writing the new one
default void	write(ModifiableRepositoryData parentData, String name, Object value) Write the value into the given repository data
void	writeSingleValue(ModifiableRepositoryData parentData, String name, T value) Write the single value into the given repository data This method is called by the write(ModifiableRepositoryData, String, Object) method, once for each value if the value is an array

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

castValue, fromJSONForClient, getManagedClass, getManagedClassArray, isCompatible, isSimple, parseConfiguration, toString, valueToJSONForClient

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

TYPE_ID_DATA_NAME

static final String TYPE_ID_DATA_NAME

Data name for storing the type identifier of an element with multiple values

See Also:

Constant Field Values

Method Detail

read

default Object read(RepositoryData parentData,
                    String name)
             throws BadItemTypeException

Description copied from interface: RepositoryElementType

Read the value in the given repository data

Specified by:

read in interface RepositoryElementType<T>

Parameters:

parentData - repository data containing the value

name - the name of the element to read

Returns:

the value. Can return a T or a T[]. That's why the return type is Object

Throws:

BadItemTypeException - if the reading value doesn't match this element type

readSingleValue

T readSingleValue(RepositoryData singleValueData)

Read the single value in the given repository data

Parameters:

singleValueData - repository data containing the value

Returns:

the value. Can return null if the given data does not contain the necessary elements

write

default void write(ModifiableRepositoryData parentData,
                   String name,
                   Object value)
            throws BadItemTypeException

Description copied from interface: RepositoryElementType

Write the value into the given repository data

Specified by:

write in interface RepositoryElementType<T>

Parameters:

parentData - repository where to store the value.

name - the name of the element to write

value - the value to write. Can be a T or a T[]. That's why it is an Object

Throws:

BadItemTypeException - If the given value doesn't match this element type

removeValueBeforeWritingIt

default boolean removeValueBeforeWritingIt()

Determines if the existing value has to be removed before writing the new one

Returns:

true if the previous value has to be removed, false otherwise

writeSingleValue

void writeSingleValue(ModifiableRepositoryData parentData,
                      String name,
                      T value)

Write the single value into the given repository data This method is called by the write(ModifiableRepositoryData, String, Object) method, once for each value if the value is an array

Parameters:

parentData - repository where to store the single value.

name - the name of the element to write

value - the single value to write. Can be null. In this case, an empty data must be created

isCompatible

default boolean isCompatible(RepositoryData parentData,
                             String name)
                      throws UnknownDataException

Description copied from interface: RepositoryModelItemType

Checks if the value in the given repository data is compatible with the item type

Specified by:

isCompatible in interface RepositoryModelItemType

Parameters:

parentData - repository data containing the data to check

name - the name of the data to check

Returns:

true if the data type matches the current type, false otherwise

Throws:

UnknownDataException - if there is no data in the parent repository data with this name

getNodeType

String getNodeType()

Retrieves the type of node used for this type

Returns:

the type of node used for this type