fr.inria.atlanmod.neoemf.data.mapping

Interface ManyReferenceMapper

All Superinterfaces:

ReferenceMapper

All Known Subinterfaces:

AllReferenceAs<M>, Backend, BerkeleyDbBackend, BlueprintsBackend, DataMapper, HBaseBackend, InMemoryBackend, ManyReferenceAs<M>, ManyReferenceMergedAs<M>, 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 ManyReferenceMapper
extends ReferenceMapper

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

Method Summary

Modifier and Type	Method and Description
void	addAllReferences(ManyFeatureBean feature, List<Id> collection) Adds all the collection to the specified feature from the position of the feature.
void	addReference(ManyFeatureBean feature, Id reference) Adds the reference to the specified feature at a defined position.
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.
Optional<Id>	referenceFor(ManyFeatureBean feature, Id reference) Defines the reference of the specified feature at a defined position.
Optional<Id>	referenceOf(ManyFeatureBean feature) Retrieves the reference of the specified feature at a defined position.
void	removeAllReferences(SingleFeatureBean feature) Removes all references of the specified feature.
Optional<Id>	removeReference(ManyFeatureBean feature) Removes the reference of the specified feature at a defined position.
Optional<Integer>	sizeOfReference(SingleFeatureBean feature) Returns the number of reference of the specified feature.

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

referenceFor, referenceOf, removeReference

Method Detail

referenceOf

@Nonnull
Optional<Id> referenceOf(ManyFeatureBean feature)

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

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

Throws:

NullPointerException - if the feature is null

allReferencesOf

@Nonnull
Stream<Id> allReferencesOf(SingleFeatureBean feature)

Retrieves all references of the specified feature.

Parameters:

feature - the bean identifying the multi-valued reference

Returns:

an immutable ordered Stream over all references

Throws:

NullPointerException - if the feature is null

referenceFor

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

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

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

Throws:

NullPointerException - if any parameter is null

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

See Also:

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

addReference

void addReference(ManyFeatureBean feature,
                  Id reference)

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

Parameters:

feature - the bean identifying the multi-valued reference

reference - the reference to add

Throws:

NullPointerException - if any parameter is null

IndexOutOfBoundsException - if feature.position > size

addAllReferences

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

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

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

appendReference

@Nonnegative
default int appendReference(SingleFeatureBean feature,
                                          Id reference)

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

Parameters:

feature - the bean identifying the multi-valued reference

reference - the reference to add

Returns:

the position to which the reference was added

Throws:

NullPointerException - if any parameter is null

See Also:

addReference(ManyFeatureBean, Id)

appendAllReferences

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

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

Parameters:

feature - the bean identifying the multi-valued reference

collection - the references to add

Returns:

the position to which the first reference was added

Throws:

NullPointerException - if any parameter is null

See Also:

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

removeReference

@Nonnull
Optional<Id> removeReference(ManyFeatureBean feature)

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

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

Throws:

NullPointerException - if the feature is null

removeAllReferences

void removeAllReferences(SingleFeatureBean feature)

Removes all references of the specified feature.

Parameters:

feature - the bean identifying the multi-valued reference

Throws:

NullPointerException - if the feature is null

sizeOfReference

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

Returns the number of reference of the specified feature.

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

Throws:

NullPointerException - if the feature is null