-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[333] Add migration participant to remove useless StringValueStyle
The representations created before the previous commit, that fixes the unexpected creation of StringValueStyle, can contain some kind of "empty StringValueStyle". The goal of this commit is to remove them. This commit also adds tests to check migration effect. Bug: #333
- Loading branch information
Showing
4 changed files
with
165 additions
and
2 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
122 changes: 122 additions & 0 deletions
122
...sirius/diagram/elk/migration/EmptyJunctionPointsStringValueStyleMigrationParticipant.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,122 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024 Obeo | ||
| * | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License 2.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.diagram.elk.migration; | ||
|
|
||
| import java.util.Optional; | ||
| import java.util.stream.Stream; | ||
| import java.util.stream.StreamSupport; | ||
|
|
||
| import org.eclipse.gmf.runtime.notation.Diagram; | ||
| import org.eclipse.gmf.runtime.notation.Edge; | ||
| import org.eclipse.gmf.runtime.notation.NotationPackage; | ||
| import org.eclipse.gmf.runtime.notation.StringValueStyle; | ||
| import org.eclipse.gmf.runtime.notation.View; | ||
| import org.eclipse.sirius.business.api.migration.AbstractRepresentationsFileMigrationParticipant; | ||
| import org.eclipse.sirius.business.api.query.DViewQuery; | ||
| import org.eclipse.sirius.diagram.DDiagram; | ||
| import org.eclipse.sirius.diagram.elk.GmfLayoutCommand; | ||
| import org.eclipse.sirius.diagram.ui.business.api.query.DDiagramGraphicalQuery; | ||
| import org.eclipse.sirius.viewpoint.DAnalysis; | ||
| import org.eclipse.sirius.viewpoint.DRepresentationDescriptor; | ||
| import org.eclipse.sirius.viewpoint.DView; | ||
| import org.osgi.framework.Version; | ||
|
|
||
| /** | ||
| * | ||
| * This migration participant fixes the GMF edges that contain an empty "junctionPoints" StringValueStyle. These empty | ||
| * "junctionPoints" StringValueStyle were created due to a bug in ELK./Sirius integration. This migration participant | ||
| * simply removes the empty "junctionPoints" StringValueStyle. | ||
| * | ||
| * @author Laurent Redor | ||
| * | ||
| */ | ||
| public class EmptyJunctionPointsStringValueStyleMigrationParticipant extends AbstractRepresentationsFileMigrationParticipant { | ||
|
|
||
| /** | ||
| * Migration version. | ||
| */ | ||
| public static final Version MIGRATION_VERSION = new Version("15.4.1.202403251543"); //$NON-NLS-1$ | ||
|
|
||
| @Override | ||
| public Version getMigrationVersion() { | ||
| return MIGRATION_VERSION; | ||
| } | ||
|
|
||
| /** | ||
| * Update the styles of this <code>edge</code> if it contains empty "junctionPoints" StringValueStyle. In this case, | ||
| * this style is removed. | ||
| * | ||
| * @param edge | ||
| * the GMF edge | ||
| */ | ||
| private void updateEdge(View edge) { | ||
| StringValueStyle stringValueStyle = (StringValueStyle) edge.getStyle(NotationPackage.Literals.STRING_VALUE_STYLE); | ||
| if (stringValueStyle != null && GmfLayoutCommand.JUNCTION_POINTS_STYLE_NAME.equals(stringValueStyle.getName()) && "()".equals(stringValueStyle.getStringValue())) { //$NON-NLS-1$ | ||
| edge.getStyles().remove(stringValueStyle); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Update the GMF diagram to migrate all invalid edges. | ||
| * | ||
| * @param diagram | ||
| * the GMF diagram | ||
| */ | ||
| @SuppressWarnings("unchecked") | ||
| private void migrateDiagram(Diagram diagram) { | ||
| StreamSupport.stream(diagram.getEdges().spliterator(), false).filter(Edge.class::isInstance).forEach(edge -> updateEdge((Edge) edge)); | ||
| } | ||
|
|
||
| /** | ||
| * This method returns the associated GMF diagram of a Sirius diagram. | ||
| * | ||
| * @param dDiagram | ||
| * the Sirius diagram | ||
| * @return the associated GMF diagram if present | ||
| */ | ||
| private Optional<Diagram> getGMFDiagram(DDiagram dDiagram) { | ||
| DDiagramGraphicalQuery query = new DDiagramGraphicalQuery(dDiagram); | ||
| return Optional.ofNullable(query.getAssociatedGMFDiagram().get()); | ||
| } | ||
|
|
||
| /** | ||
| * This method returns all representations descriptors of a view. | ||
| * | ||
| * @param dView | ||
| * the Sirius viewpoint. | ||
| * @return java stream of all representation descriptors of the <code>dView</code>. | ||
| */ | ||
| private Stream<DRepresentationDescriptor> getRepresentationsDescriptors(DView dView) { | ||
| return new DViewQuery(dView).getLoadedRepresentationsDescriptors().stream(); | ||
| } | ||
|
|
||
| /** | ||
| * This method is overridden to fix file with inconsistent GMF edges, ie having an empty "junctionPoints" | ||
| * StringValueStyle. | ||
| */ | ||
| @Override | ||
| protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) { | ||
| if (loadedVersion.compareTo(MIGRATION_VERSION) < 0) { // loadedVersion < MIGRATION_VERSION | ||
| // for each diagrams of each viewpoints | ||
| dAnalysis.getOwnedViews().stream() // | ||
| .flatMap(this::getRepresentationsDescriptors) // | ||
| .map(descriptor -> descriptor.getRepresentation()) // | ||
| .filter(representation -> representation instanceof DDiagram) // | ||
| .map(representation -> (DDiagram) representation) // | ||
| .map(this::getGMFDiagram) // | ||
| .flatMap(Optional::stream) // | ||
| .forEach(this::migrateDiagram); | ||
| } | ||
| } | ||
| } |
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