-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bug: #3333 Signed-off-by: Michaël Charfadi <michael.charfadi@obeosoft.com>
- Loading branch information
Showing
18 changed files
with
889 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
177 changes: 177 additions & 0 deletions
177
...nents-emf/src/main/java/org/eclipse/sirius/components/emf/migration/MigrationService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024 Obeo. | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Obeo - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.sirius.components.emf.migration; | ||
|
|
||
| import java.util.Comparator; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
|
|
||
| import org.eclipse.emf.ecore.EClass; | ||
| import org.eclipse.emf.ecore.EClassifier; | ||
| import org.eclipse.emf.ecore.EObject; | ||
| import org.eclipse.emf.ecore.EPackage; | ||
| import org.eclipse.emf.ecore.EStructuralFeature; | ||
| import org.eclipse.emf.ecore.util.BasicExtendedMetaData; | ||
| import org.eclipse.sirius.components.emf.migration.api.IMigrationParticipant; | ||
| import org.eclipse.sirius.components.emf.migration.api.MigrationData; | ||
| import org.eclipse.sirius.components.emf.ResourceMetadataAdapter; | ||
| import org.eclipse.sirius.emfjson.resource.JsonResource; | ||
|
|
||
| import com.google.gson.Gson; | ||
| import com.google.gson.JsonObject; | ||
|
|
||
| /** | ||
| * Specialized BasicExtendedMetaData. | ||
| * | ||
| * @author mcharfadi | ||
| */ | ||
| public class MigrationService extends BasicExtendedMetaData implements JsonResource.IJsonResourceProcessor { | ||
| private MigrationData documentMigrationData; | ||
|
|
||
| private final List<IMigrationParticipant> migrationParticipants; | ||
|
|
||
| public MigrationService(List<IMigrationParticipant> migrationParticipants) { | ||
| this.migrationParticipants = Objects.requireNonNull(migrationParticipants); | ||
| this.documentMigrationData = new MigrationData("none", "0"); | ||
| } | ||
|
|
||
| private boolean isCandidateVersion(IMigrationParticipant migrationParticipant) { | ||
| return migrationParticipant.getVersion().compareTo(this.documentMigrationData.migrationVersion()) > 0; | ||
| } | ||
|
|
||
| @Override | ||
| public EStructuralFeature getElement(EClass eClass, String namespace, String eStructuralFeatureName) { | ||
| EStructuralFeature structuralFeature = eClass.getEStructuralFeature(eStructuralFeatureName); | ||
| var migrationParticipantsCandidate = migrationParticipants.stream() | ||
| .filter(this::isCandidateVersion) | ||
| .sorted(Comparator.comparing(IMigrationParticipant::getVersion)) | ||
| .toList(); | ||
| for (IMigrationParticipant migrationParticipant : migrationParticipantsCandidate) { | ||
| EStructuralFeature newStructuralFeature = migrationParticipant.getEStructuralFeature(eClass, eStructuralFeatureName); | ||
| if (newStructuralFeature != null) { | ||
| structuralFeature = newStructuralFeature; | ||
| } | ||
| } | ||
| return structuralFeature; | ||
| } | ||
|
|
||
| @Override | ||
| public EClassifier getType(EPackage ePackage, String typeName) { | ||
| EClassifier eClassifier = ePackage.getEClassifier(typeName); | ||
| var migrationParticipantsCandidate = migrationParticipants.stream() | ||
| .filter(this::isCandidateVersion) | ||
| .sorted(Comparator.comparing(IMigrationParticipant::getVersion)) | ||
| .toList(); | ||
| for (IMigrationParticipant migrationParticipant : migrationParticipantsCandidate) { | ||
| EClassifier newEClassifier = migrationParticipant.getEClassifier(ePackage, typeName); | ||
| if (newEClassifier != null) { | ||
| eClassifier = newEClassifier; | ||
| } | ||
| } | ||
| return eClassifier; | ||
| } | ||
|
|
||
| @Override | ||
| public EPackage getPackage(String nsURI) { | ||
| EPackage ePackage = super.getPackage(nsURI); | ||
| var migrationParticipantsCandidate = migrationParticipants.stream() | ||
| .filter(this::isCandidateVersion) | ||
| .sorted(Comparator.comparing(IMigrationParticipant::getVersion)) | ||
| .toList(); | ||
| for (IMigrationParticipant migrationParticipant : migrationParticipantsCandidate) { | ||
| EPackage newEPackage = migrationParticipant.getPackage(nsURI); | ||
| if (newEPackage != null) { | ||
| ePackage = newEPackage; | ||
| } | ||
| } | ||
| return ePackage; | ||
| } | ||
|
|
||
| @Override | ||
| public void preDeserialization(JsonResource resource, JsonObject jsonObject) { | ||
| this.setMigrationDataFromDocumentContent(jsonObject); | ||
| this.setResourceMetadataAdapterMigrationData(resource, this.documentMigrationData); | ||
| var migrationParticipantsCandidates = migrationParticipants.stream() | ||
| .filter(this::isCandidateVersion) | ||
| .sorted(Comparator.comparing(IMigrationParticipant::getVersion)) | ||
| .toList(); | ||
| for (IMigrationParticipant migrationParticipant : migrationParticipantsCandidates) { | ||
| migrationParticipant.preDeserialization(resource, jsonObject); | ||
| setResourceMetadataAdapterMigrationData(resource, new MigrationData(migrationParticipant.getClass().getSimpleName(), migrationParticipant.getVersion())); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void postSerialization(JsonResource resource, JsonObject jsonObject) { | ||
| getOptionalResourceMetadataAdapter(resource).ifPresent(resourceMetadataAdapter -> { | ||
| if (resourceMetadataAdapter.getMigrationData() != null) { | ||
| var rootMigration = new Gson().toJsonTree(resourceMetadataAdapter.getMigrationData(), MigrationData.class); | ||
| if (rootMigration != null) { | ||
| jsonObject.add(MigrationData.JSON_OBJECT_ROOT, rootMigration); | ||
| } | ||
| } | ||
| }); | ||
| var migrationParticipantsCandidates = migrationParticipants.stream() | ||
| .filter(this::isCandidateVersion) | ||
| .sorted(Comparator.comparing(IMigrationParticipant::getVersion)) | ||
| .toList(); | ||
| for (IMigrationParticipant migrationParticipant : migrationParticipantsCandidates) { | ||
| migrationParticipant.postSerialization(resource, jsonObject); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void postObjectLoading(EObject eObject, JsonObject jsonObject, boolean isTopObject) { | ||
| var migrationParticipantsCandidates = migrationParticipants.stream() | ||
| .filter(this::isCandidateVersion) | ||
| .sorted(Comparator.comparing(IMigrationParticipant::getVersion)) | ||
| .toList(); | ||
| for (IMigrationParticipant migrationParticipant : migrationParticipantsCandidates) { | ||
| migrationParticipant.postObjectLoading(eObject, jsonObject); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Object getValue(EObject object, EStructuralFeature feature, Object value) { | ||
| Object returnValue = value; | ||
| var migrationParticipantsCandidates = migrationParticipants.stream() | ||
| .filter(this::isCandidateVersion) | ||
| .sorted(Comparator.comparing(IMigrationParticipant::getVersion)) | ||
| .toList(); | ||
| for (IMigrationParticipant migrationParticipant : migrationParticipantsCandidates) { | ||
| Object newValue = migrationParticipant.getValue(object, feature, value); | ||
| if (newValue != null) { | ||
| returnValue = newValue; | ||
| } | ||
| } | ||
| return returnValue; | ||
| } | ||
|
|
||
| private Optional<ResourceMetadataAdapter> getOptionalResourceMetadataAdapter(JsonResource resource) { | ||
| return resource.eAdapters().stream() | ||
| .filter(ResourceMetadataAdapter.class::isInstance) | ||
| .map(ResourceMetadataAdapter.class::cast) | ||
| .findFirst(); | ||
| } | ||
|
|
||
| private void setResourceMetadataAdapterMigrationData(JsonResource resource, MigrationData migrationData) { | ||
| getOptionalResourceMetadataAdapter(resource).ifPresent(resourceMetadataAdapter -> resourceMetadataAdapter.setMigrationData(migrationData)); | ||
| } | ||
|
|
||
| private void setMigrationDataFromDocumentContent(JsonObject jsonObject) { | ||
| var optionalMigrationData = Optional.ofNullable(jsonObject.getAsJsonObject(MigrationData.JSON_OBJECT_ROOT)) | ||
| .map(migrationRootElement -> new Gson().fromJson(migrationRootElement, MigrationData.class)).stream().findFirst(); | ||
| optionalMigrationData.ifPresent(migrationData -> this.documentMigrationData = migrationData); | ||
| } | ||
| } |
128 changes: 128 additions & 0 deletions
128
.../src/main/java/org/eclipse/sirius/components/emf/migration/api/IMigrationParticipant.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024 Obeo. | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Obeo - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.sirius.components.emf.migration.api; | ||
|
|
||
| import org.eclipse.emf.ecore.EClass; | ||
| import org.eclipse.emf.ecore.EClassifier; | ||
| import org.eclipse.emf.ecore.EObject; | ||
| import org.eclipse.emf.ecore.EPackage; | ||
| import org.eclipse.emf.ecore.EStructuralFeature; | ||
| import org.eclipse.sirius.emfjson.resource.JsonResource; | ||
|
|
||
| import com.google.gson.JsonObject; | ||
|
|
||
| /** | ||
| * Interface of MigrationParticipant. | ||
| * | ||
| * @author mcharfadi | ||
| */ | ||
| public interface IMigrationParticipant { | ||
| String getVersion(); | ||
|
|
||
| /** | ||
| * Called before a JsonResource is serialized. | ||
| * | ||
| * @param resource | ||
| * The JsonResource that is serialized | ||
| * @param jsonObject | ||
| * The root jsonObject | ||
| */ | ||
| default void preDeserialization(JsonResource resource, JsonObject jsonObject) { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Called after a JsonResource is serialized. | ||
| * | ||
| * @param resource | ||
| * The JsonResource that is serialized | ||
| * @param jsonObject | ||
| * The root jsonObject | ||
| */ | ||
| default void postSerialization(JsonResource resource, JsonObject jsonObject) { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Called during the parsing of JsonResources after loading an eObject. As such the eObject will have all his | ||
| * features set. The jsonObject is the one that was used to set the features and can be used to retrieve values | ||
| * of unknown features. | ||
| * | ||
| * @param eObject | ||
| * the eObject that have been loaded. | ||
| * @param jsonObject | ||
| * the jsonObject used to load the eObject. | ||
| */ | ||
| default void postObjectLoading(EObject eObject, JsonObject jsonObject) { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Called during the parsing of JsonResources (at loading time). If a feature value has changed since a previous | ||
| * version, use this method to return the correct expected value or null if it did not change. | ||
| * | ||
| * @param eObject | ||
| * the object containing the feature. | ||
| * @param feature | ||
| * the feature to set value. | ||
| * @param value | ||
| * the initial serialized value. | ||
| * @return the new value, or null otherwise. | ||
| */ | ||
| default Object getValue(EObject eObject, EStructuralFeature feature, Object value) { | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * Called during the parsing of JsonResources (at loading time). It allows to | ||
| * retrieve a renamed EStructuralFeature from its old name. For example, if a | ||
| * feature 'aaa' has been renamed to 'bbb', then your MigrationParticipant | ||
| * should return the 'bbb' feature when given the 'aaa' name. | ||
| * | ||
| * @param eClass | ||
| * the given eClass. | ||
| * @param eStructuralFeatureName | ||
| * the feature name before migration. | ||
| * @return the new structural feature or null if not found. The attribute | ||
| * corresponding to given old name into given eClass. | ||
| */ | ||
| default EStructuralFeature getEStructuralFeature(EClass eClass, String eStructuralFeatureName) { | ||
| return eClass.getEStructuralFeature(eStructuralFeatureName); | ||
| } | ||
|
|
||
| /** | ||
| * Called during the parsing of JsonResources (at loading time). If an | ||
| * EClassifier name has changed, then you should return the correct one. | ||
| * | ||
| * @param ePackage | ||
| * the package where looking for classifier. | ||
| * @param typeName | ||
| * the old classifier name before migration. | ||
| * @return the new classifier corresponding to the old given name into given | ||
| * ePackage or null if not found. | ||
| */ | ||
| default EClassifier getEClassifier(EPackage ePackage, String typeName) { | ||
| return ePackage.getEClassifier(typeName); | ||
| } | ||
|
|
||
| /** | ||
| * Return the EPackage to use for the given namespace. | ||
| * | ||
| * @param nsURI | ||
| * the nsURI of the package we are looking for. | ||
| * @return an EPackage if some new mapping exists, null otherwise. | ||
| */ | ||
| default EPackage getPackage(String nsURI) { | ||
| return null; | ||
| } | ||
| } |
Oops, something went wrong.