fr.inria.atlanmod.neoemf.data.im

Class AbstractInMemoryBackend

java.lang.Object

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

fr.inria.atlanmod.neoemf.data.AbstractBackend

fr.inria.atlanmod.neoemf.data.im.AbstractInMemoryBackend

All Implemented Interfaces:

Backend, InMemoryBackend, AllReferenceAs<Long>, ClassMapper, ContainerMapper, DataMapper, ManyReferenceAs<Long>, ManyReferenceMapper, ManyValueMapper, ManyValueWithLists, ReferenceAs<Long>, ReferenceMapper, ValueMapper, Saveable, Closeable, AutoCloseable, Copiable<DataMapper>

Direct Known Subclasses:

BoundInMemoryBackend, DefaultInMemoryBackend

@ParametersAreNonnullByDefault
public abstract class AbstractInMemoryBackend
extends AbstractBackend
implements InMemoryBackend, ManyValueWithLists, AllReferenceAs<Long>

An abstract InMemoryBackend that provides the default behavior of containers and meta-classes management.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractInMemoryBackend.Sizes Some statistics about the size of key and values.

Field Summary

Fields

Modifier and Type	Field and Description
protected static BeanSerializerFactory	SERIALIZER_FACTORY The BeanSerializerFactory to use for creating the BinarySerializer instances.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInMemoryBackend() Constructs a new AbstractInMemoryBackend.
protected	AbstractInMemoryBackend(String name) Constructs a new AbstractInMemoryBackend with the given name.

Method Summary

Modifier and Type	Method and Description
Stream<Id>	allInstancesOf(Set<ClassBean> metaClasses) Retrieves all instances of the given metaClasses.
protected void	checkFeature(FeatureBean feature) Checks the specified feature before using 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.
protected abstract Map<Id,SingleFeatureBean>	containers() Returns the map that holds all containers.
protected abstract Map<SingleFeatureBean,Object>	features() Returns the map that holds single-features.
protected abstract Map<Id,ClassBean>	instances() Returns the map that holds all instances.
void	internalSave() Saves all modifications made on this back-end since the last call.
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.
Converter<Id,Long>	referenceConverter() Returns the converter used to transform a reference to the desired type.
void	removeContainer(Id id) Removes the container of the specified id.
void	removeValue(SingleFeatureBean feature) Removes the value of the specified feature.
<V> Optional<V>	valueFor(SingleFeatureBean feature, V value) Defines the value of the specified feature.
<V> Optional<V>	valueOf(SingleFeatureBean feature) Retrieves the value of the specified feature.

Methods inherited from class fr.inria.atlanmod.neoemf.data.AbstractBackend

allInstancesOf, close, copyTo, internalClose, internalCopyTo, save, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.inria.atlanmod.neoemf.data.im.InMemoryBackend

isDistributed, isPersistent

Methods inherited from interface fr.inria.atlanmod.neoemf.data.Saveable

close, save

Methods inherited from interface org.atlanmod.commons.Copiable

copyTo

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

allInstancesOf

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

addAllReferences, addReference, allReferencesOf, appendAllReferences, appendReference, referenceFor, referenceOf, removeAllReferences, removeReference, sizeOfReference

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

referenceFor, referenceOf, removeReference

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

addAllValues, addValue, allValuesOf, getOrCreateList, removeAllValues, removeValue, sizeOfValue, valueFor, valueOf

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

manyReferenceConverter

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

referenceFor, referenceOf, removeReference

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

addAllReferences, addReference, allReferencesOf, appendAllReferences, appendReference, referenceFor, referenceOf, removeAllReferences, removeReference, sizeOfReference

Field Detail

SERIALIZER_FACTORY

@Nonnull
protected static final BeanSerializerFactory SERIALIZER_FACTORY

The BeanSerializerFactory to use for creating the BinarySerializer instances.

Constructor Detail

AbstractInMemoryBackend

protected AbstractInMemoryBackend()

Constructs a new AbstractInMemoryBackend.

AbstractInMemoryBackend

protected AbstractInMemoryBackend(@Nullable
                                  String name)

Constructs a new AbstractInMemoryBackend with the given name.

Parameters:

name - the unique name of this backend

Method Detail

internalSave

public void internalSave()

Description copied from class: AbstractBackend

Saves all modifications made on this back-end since the last call.

Specified by:

internalSave in class AbstractBackend

containers

@Nonnull
protected abstract Map<Id,SingleFeatureBean> containers()

Returns the map that holds all containers.

Returns:

a mutable map

instances

@Nonnull
protected abstract Map<Id,ClassBean> instances()

Returns the map that holds all instances.

Returns:

a mutable map

features

@Nonnull
protected abstract Map<SingleFeatureBean,Object> features()

Returns the map that holds single-features.

Returns:

a mutable map

checkFeature

protected void checkFeature(FeatureBean feature)

Checks the specified feature before using it.

Parameters:

feature - the feature to check

containerOf

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

Description copied from interface: ContainerMapper

Retrieves the container for the specified id.

Specified by:

containerOf in interface ContainerMapper

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

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

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

Parameters:

id - the Id of the contained element

metaClassOf

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

Description copied from interface: ClassMapper

Retrieves the meta-class for the specified id.

Specified by:

metaClassOf in interface ClassMapper

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

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

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
public Stream<Id> allInstancesOf(Set<ClassBean> metaClasses)

Description copied from interface: ClassMapper

Retrieves all instances of the given metaClasses.

Specified by:

allInstancesOf in interface ClassMapper

Parameters:

metaClasses - the meta-classes to compute the instances of

Returns:

a Stream containing the instances of the metaClasses

valueOf

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

Description copied from interface: ValueMapper

Retrieves the value of the specified feature.

Specified by:

valueOf in interface ValueMapper

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

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

Parameters:

feature - the bean identifying the value

referenceConverter

@Nonnull
public Converter<Id,Long> referenceConverter()

Description copied from interface: ReferenceAs

Returns the converter used to transform a reference to the desired type.

Specified by:

referenceConverter in interface ReferenceAs<Long>

Returns:

the converter