de.espirit.firstspirit.feature

Interface FeatureModel

public interface FeatureModel

Interface representing the content model of a content transport feature. Provides means to browse and modify the feature content by adding or removingcontent objects (IDProvider or data records. To persist modifications to this feature call FeatureAgent.saveFeature(FeatureModel).

Missing References:
A feature model doesn't have to be enclosed. Therefore a feature can have missing references. These references are differentiated in essential references andoptional references. A feature is transportablealthough it has missing essential references but during installing the feature transport file to a target project the different types of missing references will be important. Missing essential references which couldn't be mapped to existing elements in target project will cause the feature to be not installable. In contrast missing optional references which couldn't be mapped will cause warnings but the feature will stay installable.

Since:

5.0.111

See Also:

FeatureAgent, FeatureDescriptor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FeatureModel.FeatureDatasetReference Definition of an feature reference referencing a dataset.
static interface	FeatureModel.FeatureElementReference Definition of an feature reference referencing a store node.
static interface	FeatureModel.FeatureReference<T extends IDProvider> Definition representing a feature reference.
static class	FeatureModel.FeatureReferencesType Type of feature references.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Collection<IDProvider> elementsToAdd) Adds the given elements collection to this feature model.
boolean	add(IDProvider elementToAdd) Adds the given element to this feature model.
Map<Schema,Map<EntityType,Collection<Dataset>>>	getDataRecords() Returns all data records contained in this feature model as an unmodifiable map.
Pair<Collection<FeatureModel.FeatureReference<?>>,Collection<FeatureModel.FeatureReference<?>>>	getMissingReferences() Returns all missing references of this feature model existing at time calling this method.
Map<Store.Type,Collection<IDProvider>>	getStoreNodes() Returns all store nodes contained in this feature model as an unmodifiable mapping from store typeto a collection of IdProvider.
boolean	remove(IDProvider toRemove) Removes the given element from this feature model.

Method Detail

add

boolean add(IDProvider elementToAdd)

Adds the given element to this feature model. Pass a dataset provided by Content2.getDataset(Entity)to add a data record to this feature.

Parameters:

elementToAdd - the element which should be added to the feature model

Since:

5.0.111

See Also:

FeatureAgent.saveFeature(FeatureModel)

add

boolean add(Collection<IDProvider> elementsToAdd)

Adds the given elements collection to this feature model. Pass datasets provided by Content2.getDataset(Entity)to add data records to this feature.

Parameters:

elementsToAdd - the elements which should be added to the feature model

Since:

5.0.111

See Also:

FeatureAgent.saveFeature(FeatureModel)

remove

boolean remove(IDProvider toRemove)

Removes the given element from this feature model. Pass a dataset provided by Content2.getDataset(Entity)to remove a data record from this feature.

Parameters:

toRemove - the element which should be removed

Since:

5.0.111

See Also:

FeatureAgent.saveFeature(FeatureModel)

getStoreNodes

Map<Store.Type,Collection<IDProvider>> getStoreNodes()

Returns all store nodes contained in this feature model as an unmodifiable mapping from store typeto a collection of IdProvider. Returned map contains only start nodes, therefore all children of these nodes are part of the feature too.
The map represents a snapshot of the current model at time calling this method. Therefore modifications via add(IDProvider)or remove(IDProvider) will not affect the returned map.

Since:

5.0.111

See Also:

getDataRecords()

getDataRecords

Map<Schema,Map<EntityType,Collection<Dataset>>> getDataRecords()

Returns all data records contained in this feature model as an unmodifiable map.
The map represents a snapshot of the current model at time calling this method. Therefore modifications via add(Dataset)or remove(Dataset) will not affect the returned map.

Since:

5.0.111

See Also:

getStoreNodes()

getMissingReferences

Pair<Collection<FeatureModel.FeatureReference<?>>,Collection<FeatureModel.FeatureReference<?>>> getMissingReferences()

Returns all missing references of this feature model existing at time calling this method. The returned pair contains missing essential references as Pair.getKey() key and missing optional references as value

Since:

5.0.111