fr.inria.atlanmod.neoemf.data.mapping

Interface ManyReferenceAs<M>

Type Parameters:

M - the type of the references after mapping

All Superinterfaces:

ManyReferenceMapper, ManyValueMapper, ReferenceMapper, ValueMapper

All Known Subinterfaces:

AllReferenceAs<M>

All Known Implementing Classes:

AbstractInMemoryBackend, BoundInMemoryBackend, DefaultInMemoryBackend

@ParametersAreNonnullByDefault
public interface ManyReferenceAs<M>
extends ManyValueMapper, ManyReferenceMapper

A ManyReferenceMapper that provides a default behavior to use M instead of Id for multi-valued references.

Method Summary

Modifier and Type	Method and Description
default void	addAllReferences(ManyFeatureBean feature, List<Id> collection) Adds all the collection to the specified feature from the position of the feature.
default void	addReference(ManyFeatureBean feature, Id reference) Adds the reference to the specified feature at a defined position.
default Stream<Id>	allReferencesOf(SingleFeatureBean feature) Retrieves all references of the specified feature.
default int	appendAllReferences(SingleFeatureBean feature, List<Id> collection) Adds all the collection to the specified feature from the last position.
default int	appendReference(SingleFeatureBean feature, Id reference) Adds the reference to the specified feature at the last position.
Converter<Id,M>	manyReferenceConverter() Returns the converter used to transform a multi-valued reference to the desired type.
default Optional<Id>	referenceFor(ManyFeatureBean feature, Id reference) Defines the reference of the specified feature at a defined position.
default Optional<Id>	referenceOf(ManyFeatureBean feature) Retrieves the reference of the specified feature at a defined position.
default void	removeAllReferences(SingleFeatureBean feature) Removes all references of the specified feature.
default Optional<Id>	removeReference(ManyFeatureBean feature) Removes the reference of the specified feature at a defined position.
default Optional<Integer>	sizeOfReference(SingleFeatureBean feature) Returns the number of reference of the specified feature.

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

addAllValues, addValue, allValuesOf, appendAllValues, appendValue, removeAllValues, removeValue, sizeOfValue, valueFor, valueOf

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

removeValue, valueFor, valueOf

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

referenceFor, referenceOf, removeReference

Method Detail

referenceOf

@Nonnull
default Optional<Id> referenceOf(ManyFeatureBean feature)

Description copied from interface: ManyReferenceMapper

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

Specified by:

referenceOf in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued reference

Returns:

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

allReferencesOf

@Nonnull
default Stream<Id> allReferencesOf(SingleFeatureBean feature)

Description copied from interface: ManyReferenceMapper

Retrieves all references of the specified feature.

Specified by:

allReferencesOf in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued reference

Returns:

an immutable ordered Stream over all references

referenceFor

@Nonnull
default Optional<Id> referenceFor(ManyFeatureBean feature,
                                            Id reference)

Description copied from interface: ManyReferenceMapper

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

Specified by:

referenceFor in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued reference

reference - the reference to set

Returns:

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

See Also:

ManyReferenceMapper.addReference(ManyFeatureBean, Id), ManyReferenceMapper.appendReference(SingleFeatureBean, Id)

addReference

default void addReference(ManyFeatureBean feature,
                          Id reference)

Description copied from interface: ManyReferenceMapper

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

Specified by:

addReference in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued reference

reference - the reference to add

addAllReferences

default void addAllReferences(ManyFeatureBean feature,
                              List<Id> collection)

Description copied from interface: ManyReferenceMapper

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

Specified by:

addAllReferences in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued attribute

collection - the values to add

appendReference

default int appendReference(SingleFeatureBean feature,
                            Id reference)

Description copied from interface: ManyReferenceMapper

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

Specified by:

appendReference in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued reference

reference - the reference to add

Returns:

the position to which the reference was added

See Also:

ManyReferenceMapper.addReference(ManyFeatureBean, Id)

appendAllReferences

default int appendAllReferences(SingleFeatureBean feature,
                                List<Id> collection)

Description copied from interface: ManyReferenceMapper

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

Specified by:

appendAllReferences in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued reference

collection - the references to add

Returns:

the position to which the first reference was added

See Also:

ManyReferenceMapper.addReference(ManyFeatureBean, Id), ManyReferenceMapper.appendReference(SingleFeatureBean, Id)

removeReference

@Nonnull
default Optional<Id> removeReference(ManyFeatureBean feature)

Description copied from interface: ManyReferenceMapper

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

Specified by:

removeReference in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued reference

Returns:

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

removeAllReferences

default void removeAllReferences(SingleFeatureBean feature)

Description copied from interface: ManyReferenceMapper

Removes all references of the specified feature.

Specified by:

removeAllReferences in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued reference

sizeOfReference

@Nonnull
default Optional<Integer> sizeOfReference(SingleFeatureBean feature)

Description copied from interface: ManyReferenceMapper

Returns the number of reference of the specified feature.

Specified by:

sizeOfReference in interface ManyReferenceMapper

Parameters:

feature - the bean identifying the multi-valued reference

Returns:

an Optional containing the number of reference of the feature, or Optional.empty() if the feature hasn't any reference

manyReferenceConverter

@Nonnull
Converter<Id,M> manyReferenceConverter()

Returns the converter used to transform a multi-valued reference to the desired type.

Returns:

the converter