fr.inria.atlanmod.neoemf.data.mapping

Interface ManyValueWithIndices

All Superinterfaces:

ManyValueMapper, ValueMapper

@ParametersAreNonnullByDefault
public interface ManyValueWithIndices
extends ManyValueMapper

A ManyValueMapper that provides a default behavior to represent the "multi-valued" directly with their position.

Indices are persisted with dedicated SingleFeatureBeans containing the index of the element to store. Using this approach avoid to deserialize entire Collections to retrieve a single element, which can be an important bottleneck in terms of execution time and memory consumption if the underlying model contains very large Collections.

Method Summary

Modifier and Type	Method and Description
default <V> void	addAllValues(ManyFeatureBean feature, List<? extends V> collection) Adds all the collection to the specified feature from the position of the feature.
default <V> void	addValue(ManyFeatureBean feature, V value) Adds the value to the specified feature at a defined position.
default <V> Stream<V>	allValuesOf(SingleFeatureBean feature) Retrieves all values of the specified feature.
default void	removeAllValues(SingleFeatureBean feature) Removes all values of the specified feature.
default <V> Optional<V>	removeValue(ManyFeatureBean feature) Removes the value of the specified feature at a defined position.
default void	sizeForValue(SingleFeatureBean feature, int size) Defines the number of values of the specified feature.
default Optional<Integer>	sizeOfValue(SingleFeatureBean feature) Returns the number of value of the specified feature.
default <V> Optional<V>	valueFor(ManyFeatureBean feature, V value) Defines the value of the specified feature at a defined position.
<V> void	valueForNullable(ManyFeatureBean feature, V value) Defines the value of the specified feature at a defined position.

Methods inherited from interface fr.inria.atlanmod.neoemf.data.mapping.ManyValueMapper

appendAllValues, appendValue, valueOf

Methods inherited from interface fr.inria.atlanmod.neoemf.data.mapping.ValueMapper

removeValue, valueFor, valueOf

Method Detail

allValuesOf

@Nonnull
default <V> Stream<V> allValuesOf(SingleFeatureBean feature)

Description copied from interface: ManyValueMapper

Retrieves all values of the specified feature.

Specified by:

allValuesOf in interface ManyValueMapper

Parameters:

feature - the bean identifying the multi-valued attribute

Returns:

an immutable ordered Stream over all values

valueFor

@Nonnull
default <V> Optional<V> valueFor(ManyFeatureBean feature,
                                           V value)

Description copied from interface: ManyValueMapper

Defines the value of the specified feature at a defined position.

Specified by:

valueFor in interface ManyValueMapper

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

value - the value to set

Returns:

an Optional containing the previous value of the feature, or Optional.empty() if the feature has no value before

See Also:

ManyValueMapper.addValue(ManyFeatureBean, Object), ManyValueMapper.appendValue(SingleFeatureBean, Object)

addValue

default <V> void addValue(ManyFeatureBean feature,
                          V value)

Description copied from interface: ManyValueMapper

Adds the value to the specified feature at a defined position.

Specified by:

addValue in interface ManyValueMapper

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

value - the value to add

addAllValues

default <V> void addAllValues(ManyFeatureBean feature,
                              List<? extends V> collection)

Description copied from interface: ManyValueMapper

Adds all the collection to the specified feature from the position of the feature.

Specified by:

addAllValues in interface ManyValueMapper

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

collection - the values to add

removeValue

@Nonnull
default <V> Optional<V> removeValue(ManyFeatureBean feature)

Description copied from interface: ManyValueMapper

Removes the value of the specified feature at a defined position.

Specified by:

removeValue in interface ManyValueMapper

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

Returns:

an Optional containing the removed value, or Optional.empty() if the feature has no value before

removeAllValues

default void removeAllValues(SingleFeatureBean feature)

Description copied from interface: ManyValueMapper

Removes all values of the specified feature.

Specified by:

removeAllValues in interface ManyValueMapper

Parameters:

feature - the bean identifying the multi-valued attribute

sizeOfValue

@Nonnull
 @Nonnegative
default Optional<Integer> sizeOfValue(SingleFeatureBean feature)

Description copied from interface: ManyValueMapper

Returns the number of value of the specified feature.

Specified by:

sizeOfValue in interface ManyValueMapper

Parameters:

feature - the bean identifying the multi-valued attribute

Returns:

an Optional containing the number of value of the feature, or Optional.empty() if the feature hasn't any value, or if size == 0.

sizeForValue

default void sizeForValue(SingleFeatureBean feature,
                          @Nonnegative
                          int size)

Defines the number of values of the specified feature.

Parameters:

feature - the bean identifying the multi-valued attribute

size - the number of values

Throws:

NullPointerException - if the feature is null

IllegalArgumentException - if size < 0

valueForNullable

<V> void valueForNullable(ManyFeatureBean feature,
                          @Nullable
                          V value)

Defines the value of the specified feature at a defined position.

This method behaves like valueFor(ManyFeatureBean, Object), without checking whether the multi-valued feature already exists, in order to replace it. If value == null, the feature is removed.

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

value - the value to set

Throws:

NullPointerException - if the feature is null