fr.inria.atlanmod.neoemf.data.mapping

Interface ManyValueMapper

All Superinterfaces:

ValueMapper

All Known Subinterfaces:

AllReferenceAs<M>, Backend, BerkeleyDbBackend, BlueprintsBackend, DataMapper, HBaseBackend, InMemoryBackend, ManyReferenceAs<M>, ManyValueWithArrays, ManyValueWithIndices, ManyValueWithLists, MapDbBackend, MongoDbBackend, Store

All Known Implementing Classes:

AbstractBackend, AbstractCachingStore, AbstractDataMapper, AbstractDataMapperChain, AbstractInMemoryBackend, AbstractStore, AutoSavingStore, BoundInMemoryBackend, ClassCachingStore, ClosedStore, ContainerCachingStore, DefaultInMemoryBackend, FeatureCachingStore, InvalidBackend, InvalidDataMapper, ListeningStore, NoopStore, ReadOnlyStore, SizeCachingStore

@ParametersAreNonnullByDefault
public interface ManyValueMapper
extends ValueMapper

An object capable of mapping multi-valued attributes represented as a set of key/value pair.

Method Summary

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

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

removeValue, valueFor, valueOf

Method Detail

valueOf

@Nonnull
<V> Optional<V> valueOf(ManyFeatureBean feature)

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

Parameters:

feature - the bean identifying the multi-valued attribute

Returns:

an Optional containing the value, or Optional.empty() if the feature hasn't any value or doesn't exist

Throws:

NullPointerException - if the feature is null

allValuesOf

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

Retrieves all values of the specified feature.

Parameters:

feature - the bean identifying the multi-valued attribute

Returns:

an immutable ordered Stream over all values

Throws:

NullPointerException - if the feature is null

valueFor

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

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

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

Throws:

NullPointerException - if any parameter is null

IndexOutOfBoundsException - if index.position < 0 || index.position >= size

See Also:

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

addValue

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

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

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

value - the value to add

Throws:

NullPointerException - if any parameter is null

IndexOutOfBoundsException - if feature.position > size

addAllValues

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

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

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

collection - the values to add

Throws:

NullPointerException - if any parameter is null

IndexOutOfBoundsException - if feature.position > size

appendValue

@Nonnegative
default <V> int appendValue(SingleFeatureBean feature,
                                          V value)

Adds the value to the specified feature at the last position.

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

value - the value to add

Returns:

the position to which the value was added

Throws:

NullPointerException - if any parameter is null

See Also:

addValue(ManyFeatureBean, Object)

appendAllValues

@Nonnegative
default <V> int appendAllValues(SingleFeatureBean feature,
                                              List<? extends V> collection)

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

Type Parameters:

V - the type of values

Parameters:

feature - the bean identifying the multi-valued attribute

collection - the values to add

Returns:

the position to which the first value was added

Throws:

NullPointerException - if any parameter is null

See Also:

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

removeValue

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

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

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

Throws:

NullPointerException - if the feature is null

removeAllValues

void removeAllValues(SingleFeatureBean feature)

Removes all values of the specified feature.

Parameters:

feature - the bean identifying the multi-valued attribute

Throws:

NullPointerException - if the feature is null

sizeOfValue

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

Returns the number of value of the specified feature.

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.

Throws:

NullPointerException - if the feature is null