fr.inria.atlanmod.neoemf.data.mapping

Class AbstractDataMapperChain<M extends DataMapper>

java.lang.Object

fr.inria.atlanmod.neoemf.data.mapping.AbstractDataMapper

fr.inria.atlanmod.neoemf.data.mapping.AbstractDataMapperChain<M>

Type Parameters:

M - the type of the inner DataMapper

All Implemented Interfaces:

ClassMapper, ContainerMapper, DataMapper, ManyReferenceMapper, ManyValueMapper, ReferenceMapper, ValueMapper, Saveable, Closeable, AutoCloseable, Copiable<DataMapper>

Direct Known Subclasses:

AbstractStore, NoopStore

@ParametersAreNonnullByDefault
public abstract class AbstractDataMapperChain<M extends DataMapper>
extends AbstractDataMapper

An abstract DataMapper that delegates method calls to a DataMapper chain.

Constructor Summary

Constructors

Constructor and Description
AbstractDataMapperChain()

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.
<V> void	addAllValues(ManyFeatureBean feature, List<? extends V> 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.
<V> void	addValue(ManyFeatureBean feature, V value) Adds the value to the specified feature at a defined position.
Stream<Id>	allInstancesOf(ClassBean metaClass, boolean strict) Retrieves all instances of the given metaClass.
Stream<Id>	allInstancesOf(Set<ClassBean> metaClasses) Retrieves all instances of the given metaClasses.
Stream<Id>	allReferencesOf(SingleFeatureBean feature) Retrieves all references of the specified feature.
<V> Stream<V>	allValuesOf(SingleFeatureBean feature) Retrieves all values of the specified feature.
int	appendAllReferences(SingleFeatureBean feature, List<Id> collection) Adds all the collection to the specified feature from the last position.
<V> int	appendAllValues(SingleFeatureBean feature, List<? extends V> collection) Adds all the collection to the specified feature from the last position.
int	appendReference(SingleFeatureBean feature, Id reference) Adds the reference to the specified feature at the last position.
<V> int	appendValue(SingleFeatureBean feature, V value) Adds the value to the specified feature at the last position.
void	close() Cleanly closes this manager, clear all data in-memory and releases any system resources associated with it.
void	containerFor(Id id, SingleFeatureBean container) Stores the container for the specified id.
Optional<SingleFeatureBean>	containerOf(Id id) Retrieves the container for the specified id.
void	copyTo(DataMapper target)
boolean	metaClassFor(Id id, ClassBean metaClass) Stores the metaClass for the specified id.
Optional<ClassBean>	metaClassOf(Id id) Retrieves the meta-class for the specified id.
protected M	next() Returns the next mapper to notify.
protected void	next(M next) Defines the next mapper to notify.
Optional<Id>	referenceFor(ManyFeatureBean feature, Id reference) Defines the reference of the specified feature at a defined position.
Optional<Id>	referenceFor(SingleFeatureBean feature, Id reference) Defines the reference of the specified feature.
Optional<Id>	referenceOf(ManyFeatureBean feature) Retrieves the reference of the specified feature at a defined position.
Optional<Id>	referenceOf(SingleFeatureBean feature) Retrieves the reference of the specified feature.
void	removeAllReferences(SingleFeatureBean feature) Removes all references of the specified feature.
void	removeAllValues(SingleFeatureBean feature) Removes all values of the specified feature.
void	removeContainer(Id id) Removes the container of the specified id.
Optional<Id>	removeReference(ManyFeatureBean feature) Removes the reference of the specified feature at a defined position.
void	removeReference(SingleFeatureBean feature) Removes the reference of the specified feature.
<V> Optional<V>	removeValue(ManyFeatureBean feature) Removes the value of the specified feature at a defined position.
void	removeValue(SingleFeatureBean feature) Removes the value of the specified feature.
void	save() Saves all changes made on this manager since the last call.
Optional<Integer>	sizeOfReference(SingleFeatureBean feature) Returns the number of reference of the specified feature.
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>	valueFor(SingleFeatureBean feature, V value) Defines the value of the specified feature.
<V> Optional<V>	valueOf(ManyFeatureBean feature) Retrieves the value of the specified feature at a defined position.
<V> Optional<V>	valueOf(SingleFeatureBean feature) Retrieves the value of the specified feature.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDataMapperChain

public AbstractDataMapperChain()

Method Detail

next

@Nonnull
protected M next()

Returns the next mapper to notify.

Returns:

the next mapper

next

protected void next(M next)

Defines the next mapper to notify.

Parameters:

next - the next mapper

close

@OverridingMethodsMustInvokeSuper
public void close()

Description copied from interface: Saveable

Cleanly closes this manager, clear all data in-memory and releases any system resources associated with it. All modifications are saved before closing.

If the manager is already closed, then invoking this method has no effect.

save

@OverridingMethodsMustInvokeSuper
public void save()

Description copied from interface: Saveable

Saves all changes made on this manager since the last call.

copyTo

@OverridingMethodsMustInvokeSuper
public void copyTo(DataMapper target)

containerOf

@Nonnull
 @OverridingMethodsMustInvokeSuper
public Optional<SingleFeatureBean> containerOf(Id id)

Description copied from interface: ContainerMapper

Retrieves the container for the specified id.

Parameters:

id - the Id of the contained element

Returns:

an Optional containing the container, or Optional.empty() if the id has no defined container.

containerFor

@OverridingMethodsMustInvokeSuper
public void containerFor(Id id,
                                                            SingleFeatureBean container)

Description copied from interface: ContainerMapper

Stores the container for the specified id.

Parameters:

id - the Id of the contained element

container - the containing element's container information to store

removeContainer

@OverridingMethodsMustInvokeSuper
public void removeContainer(Id id)

Description copied from interface: ContainerMapper

Removes the container of the specified id.

The container must be completely removed, so that a call to ContainerMapper.containerOf(Id) returns Optional.empty().

Parameters:

id - the Id of the contained element

metaClassOf

@Nonnull
 @OverridingMethodsMustInvokeSuper
public Optional<ClassBean> metaClassOf(Id id)

Description copied from interface: ClassMapper

Retrieves the meta-class for the specified id.

Parameters:

id - the Id of the element

Returns:

an Optional containing the meta-class, or Optional.empty() if the id has no defined meta-class.

metaClassFor

@OverridingMethodsMustInvokeSuper
public boolean metaClassFor(Id id,
                                                               ClassBean metaClass)

Description copied from interface: ClassMapper

Stores the metaClass for the specified id.

Parameters:

id - the Id of the element

metaClass - the containing element's meta-class information to store

Returns:

true if the meta-class has been defined, false if the id already has a meta-class

allInstancesOf

@Nonnull
 @OverridingMethodsMustInvokeSuper
public Stream<Id> allInstancesOf(ClassBean metaClass,
                                                                               boolean strict)

Description copied from interface: ClassMapper

Retrieves all instances of the given metaClass.

Parameters:

metaClass - the meta-class to compute the instances of

strict - true if the lookup searches for strict instances

Returns:

an Stream containing the instances of the metaClass

allInstancesOf

@Nonnull
 @OverridingMethodsMustInvokeSuper
public Stream<Id> allInstancesOf(Set<ClassBean> metaClasses)

Description copied from interface: ClassMapper

Retrieves all instances of the given metaClasses.

Parameters:

metaClasses - the meta-classes to compute the instances of

Returns:

a Stream containing the instances of the metaClasses

valueOf

@Nonnull
 @OverridingMethodsMustInvokeSuper
public <V> Optional<V> valueOf(SingleFeatureBean feature)

Description copied from interface: ValueMapper

Retrieves the value of the specified feature.

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the value

Returns:

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

valueFor

@Nonnull
 @OverridingMethodsMustInvokeSuper
public <V> Optional<V> valueFor(SingleFeatureBean feature,
                                                                              V value)

Description copied from interface: ValueMapper

Defines the value of the specified feature.

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the value

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

removeValue

@OverridingMethodsMustInvokeSuper
public void removeValue(SingleFeatureBean feature)

Description copied from interface: ValueMapper

Removes the value of the specified feature.

Parameters:

feature - the bean identifying the value

referenceOf

@Nonnull
 @OverridingMethodsMustInvokeSuper
public Optional<Id> referenceOf(SingleFeatureBean feature)

Description copied from interface: ReferenceMapper

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

referenceFor

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

Description copied from interface: ReferenceMapper

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

removeReference

@OverridingMethodsMustInvokeSuper
public void removeReference(SingleFeatureBean feature)

Description copied from interface: ReferenceMapper

Removes the reference of the specified feature.

Parameters:

feature - the bean identifying the reference

valueOf

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

Description copied from interface: ManyValueMapper

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

allValuesOf

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

Description copied from interface: ManyValueMapper

Retrieves all values of the specified feature.

Parameters:

feature - the bean identifying the multi-valued attribute

Returns:

an immutable ordered Stream over all values

valueFor

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

Description copied from interface: ManyValueMapper

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

See Also:

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

addValue

@OverridingMethodsMustInvokeSuper
public <V> void addValue(ManyFeatureBean feature,
                                                            V value)

Description copied from interface: ManyValueMapper

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

addAllValues

@OverridingMethodsMustInvokeSuper
public <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.

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

collection - the values to add

appendValue

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

Description copied from interface: ManyValueMapper

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

See Also:

ManyValueMapper.addValue(ManyFeatureBean, Object)

appendAllValues

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

Description copied from interface: ManyValueMapper

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

See Also:

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

removeValue

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

Description copied from interface: ManyValueMapper

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

removeAllValues

@OverridingMethodsMustInvokeSuper
public void removeAllValues(SingleFeatureBean feature)

Description copied from interface: ManyValueMapper

Removes all values of the specified feature.

Parameters:

feature - the bean identifying the multi-valued attribute

sizeOfValue

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

Description copied from interface: ManyValueMapper

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.

referenceOf

@Nonnull
 @OverridingMethodsMustInvokeSuper
public Optional<Id> referenceOf(ManyFeatureBean feature)

Description copied from interface: ManyReferenceMapper

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

allReferencesOf

@Nonnull
 @OverridingMethodsMustInvokeSuper
public Stream<Id> allReferencesOf(SingleFeatureBean feature)

Description copied from interface: ManyReferenceMapper

Retrieves all references of the specified feature.

Parameters:

feature - the bean identifying the multi-valued reference

Returns:

an immutable ordered Stream over all references

referenceFor

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

Description copied from interface: ManyReferenceMapper

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

See Also:

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

addReference

@OverridingMethodsMustInvokeSuper
public void addReference(ManyFeatureBean feature,
                                                            Id reference)

Description copied from interface: ManyReferenceMapper

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

addAllReferences

public 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.

Parameters:

feature - the bean identifying the multi-valued attribute

collection - the values to add

appendReference

@Nonnegative
 @OverridingMethodsMustInvokeSuper
public int appendReference(SingleFeatureBean feature,
                                                                             Id reference)

Description copied from interface: ManyReferenceMapper

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

See Also:

ManyReferenceMapper.addReference(ManyFeatureBean, Id)

appendAllReferences

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

Description copied from interface: ManyReferenceMapper

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

See Also:

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

removeReference

@Nonnull
 @OverridingMethodsMustInvokeSuper
public Optional<Id> removeReference(ManyFeatureBean feature)

Description copied from interface: ManyReferenceMapper

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

removeAllReferences

@OverridingMethodsMustInvokeSuper
public void removeAllReferences(SingleFeatureBean feature)

Description copied from interface: ManyReferenceMapper

Removes all references of the specified feature.

Parameters:

feature - the bean identifying the multi-valued reference

sizeOfReference

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

Description copied from interface: ManyReferenceMapper

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