fr.inria.atlanmod.neoemf.data.mapping

Interface ClassMapper

All Known Subinterfaces:

Backend, BerkeleyDbBackend, BlueprintsBackend, DataMapper, HBaseBackend, InMemoryBackend, 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 ClassMapper

An object capable of mapping meta-classes.

See Also:

ClassBean

Method Summary

Modifier and Type	Method and Description
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.
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.

Method Detail

metaClassOf

@Nonnull
Optional<ClassBean> metaClassOf(Id id)

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.

Throws:

NullPointerException - if any parameter is null

metaClassFor

boolean metaClassFor(Id id,
                     ClassBean metaClass)

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

Throws:

NullPointerException - if any parameter is null

allInstancesOf

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

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

Throws:

NullPointerException - if any parameter is null

UnsupportedOperationException - if the mapper doesn't support the lookup of all instances

allInstancesOf

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

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

Throws:

NullPointerException - if any parameter is null

UnsupportedOperationException - if the mapper doesn't support the lookup of all instances