fr.inria.atlanmod.neoemf.data.mapping

Interface ReferenceMapper

All Known Subinterfaces:

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

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

Method Summary

Modifier and Type	Method and Description
Optional<Id>	referenceFor(SingleFeatureBean feature, Id reference) Defines the reference of the specified feature.
Optional<Id>	referenceOf(SingleFeatureBean feature) Retrieves the reference of the specified feature.
void	removeReference(SingleFeatureBean feature) Removes the reference of the specified feature.

Method Detail

referenceOf

@Nonnull
Optional<Id> referenceOf(SingleFeatureBean feature)

Retrieves the reference of the specified feature.

Parameters:

feature - the bean identifying the reference

Returns:

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

Throws:

NullPointerException - if any parameter is null

referenceFor

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

Defines the reference of the specified feature.

Parameters:

feature - the bean identifying the 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

removeReference

void removeReference(SingleFeatureBean feature)

Removes the reference of the specified feature.

Parameters:

feature - the bean identifying the reference

Throws:

NullPointerException - if any parameter is null