fr.inria.atlanmod.neoemf.data.store

Class AutoSavingStore

java.lang.Object

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

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

fr.inria.atlanmod.neoemf.data.store.AbstractStore

fr.inria.atlanmod.neoemf.data.store.AutoSavingStore

All Implemented Interfaces:

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

@ParametersAreNonnullByDefault
public class AutoSavingStore
extends AbstractStore

A Store wrapper that automatically saves modifications as calls are made.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_CHUNK The default number of allowed changes between saves.

Constructor Summary

Constructors

Constructor and Description
AutoSavingStore() Constructs a new AutoSavingStore with the default number of modifications between saves.
AutoSavingStore(Long chunk) Constructs a new AutoSavingStore with the given chunk.

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.
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.
boolean	metaClassFor(Id id, ClassBean metaClass) Stores the metaClass for the specified id.
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.
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.
<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.

Methods inherited from class fr.inria.atlanmod.neoemf.data.store.AbstractStore

backend, compareTo, equals, hashCode, next, toString

Methods inherited from class fr.inria.atlanmod.neoemf.data.mapping.AbstractDataMapperChain

allInstancesOf, allInstancesOf, allReferencesOf, allValuesOf, containerOf, copyTo, metaClassOf, next, referenceOf, referenceOf, sizeOfReference, sizeOfValue, valueOf, valueOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.atlanmod.commons.Copiable

copyTo

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

containerOf

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

allInstancesOf, allInstancesOf, metaClassOf

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

allValuesOf, sizeOfValue, valueOf

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

valueOf

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

allReferencesOf, referenceOf, sizeOfReference

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

referenceOf

Field Detail

DEFAULT_CHUNK

@Nonnegative
public static final long DEFAULT_CHUNK

The default number of allowed changes between saves.

Constructor Detail

AutoSavingStore

public AutoSavingStore(Long chunk)

Constructs a new AutoSavingStore with the given chunk.

Parameters:

chunk - the number of modifications between saves

AutoSavingStore

public AutoSavingStore()

Constructs a new AutoSavingStore with the default number of modifications between saves.

Method Detail

close

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.

Specified by:

close in interface Saveable

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractDataMapperChain<Store>

save

public void save()

Description copied from interface: Saveable

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

Specified by:

save in interface Saveable

Overrides:

save in class AbstractDataMapperChain<Store>

containerFor

public void containerFor(Id id,
                         SingleFeatureBean container)

Description copied from interface: ContainerMapper

Stores the container for the specified id.

Specified by:

containerFor in interface ContainerMapper

Overrides:

containerFor in class AbstractDataMapperChain<Store>

Parameters:

id - the Id of the contained element

container - the containing element's container information to store

removeContainer

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().

Specified by:

removeContainer in interface ContainerMapper

Overrides:

removeContainer in class AbstractDataMapperChain<Store>

Parameters:

id - the Id of the contained element

metaClassFor

public boolean metaClassFor(Id id,
                            ClassBean metaClass)

Description copied from interface: ClassMapper

Stores the metaClass for the specified id.

Specified by:

metaClassFor in interface ClassMapper

Overrides:

metaClassFor in class AbstractDataMapperChain<Store>

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

valueFor

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

Description copied from interface: ValueMapper

Defines the value of the specified feature.

Specified by:

valueFor in interface ValueMapper

Overrides:

valueFor in class AbstractDataMapperChain<Store>

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

public void removeValue(SingleFeatureBean feature)

Description copied from interface: ValueMapper

Removes the value of the specified feature.

Specified by:

removeValue in interface ValueMapper

Overrides:

removeValue in class AbstractDataMapperChain<Store>

Parameters:

feature - the bean identifying the value

referenceFor

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

Description copied from interface: ReferenceMapper

Defines the reference of the specified feature.

Specified by:

referenceFor in interface ReferenceMapper

Overrides:

referenceFor in class AbstractDataMapperChain<Store>

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

public void removeReference(SingleFeatureBean feature)

Description copied from interface: ReferenceMapper

Removes the reference of the specified feature.

Specified by:

removeReference in interface ReferenceMapper

Overrides:

removeReference in class AbstractDataMapperChain<Store>

Parameters:

feature - the bean identifying the reference

valueFor

@Nonnull
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.

Specified by:

valueFor in interface ManyValueMapper

Overrides:

valueFor in class AbstractDataMapperChain<Store>

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

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

Description copied from interface: ManyValueMapper

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

Specified by:

addValue in interface ManyValueMapper

Overrides:

addValue in class AbstractDataMapperChain<Store>

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

value - the value to add

addAllValues

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.

Specified by:

addAllValues in interface ManyValueMapper

Overrides:

addAllValues in class AbstractDataMapperChain<Store>

Type Parameters:

V - the type of value

Parameters:

feature - the bean identifying the multi-valued attribute

collection - the values to add

appendValue

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

Description copied from interface: ManyValueMapper

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

Specified by:

appendValue in interface ManyValueMapper

Overrides:

appendValue in class AbstractDataMapperChain<Store>

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

Specified by:

appendAllValues in interface ManyValueMapper

Overrides:

appendAllValues in class AbstractDataMapperChain<Store>

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
public <V> Optional<V> removeValue(ManyFeatureBean feature)

Description copied from interface: ManyValueMapper

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

Specified by:

removeValue in interface ManyValueMapper

Overrides:

removeValue in class AbstractDataMapperChain<Store>

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

public void removeAllValues(SingleFeatureBean feature)

Description copied from interface: ManyValueMapper

Removes all values of the specified feature.

Specified by:

removeAllValues in interface ManyValueMapper

Overrides:

removeAllValues in class AbstractDataMapperChain<Store>

Parameters:

feature - the bean identifying the multi-valued attribute

referenceFor

@Nonnull
public 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

Overrides:

referenceFor in class AbstractDataMapperChain<Store>

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

public 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

Overrides:

addReference in class AbstractDataMapperChain<Store>

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.

Specified by:

addAllReferences in interface ManyReferenceMapper

Overrides:

addAllReferences in class AbstractDataMapperChain<Store>

Parameters:

feature - the bean identifying the multi-valued attribute

collection - the values to add

appendReference

@Nonnegative
public 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

Overrides:

appendReference in class AbstractDataMapperChain<Store>

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

Specified by:

appendAllReferences in interface ManyReferenceMapper

Overrides:

appendAllReferences in class AbstractDataMapperChain<Store>

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

Overrides:

removeReference in class AbstractDataMapperChain<Store>

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

public void removeAllReferences(SingleFeatureBean feature)

Description copied from interface: ManyReferenceMapper

Removes all references of the specified feature.

Specified by:

removeAllReferences in interface ManyReferenceMapper

Overrides:

removeAllReferences in class AbstractDataMapperChain<Store>

Parameters:

feature - the bean identifying the multi-valued reference