Added support for sorting views by the order in which they are created.

Author: simonbrowndotje

build.gradle

@@ -14,7 +14,7 @@ subprojects { proj ->
 
     description = 'Structurizr'
     group = 'com.structurizr'
-    version = '1.12.1'
+    version = '1.12.2'
 
     repositories {
         mavenCentral()

docs/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.12.2 (30th March 2022)
+
+- Added support for sorting views by the order in which they are created.
+
 ## 1.12.1 (2nd March 2022)
 
 - Renamed `Decision.Link.type` to `Decision.Link.description`. 

structurizr-core/src/com/structurizr/view/FilteredView.java

@@ -15,6 +15,7 @@ public final class FilteredView {
     private String baseViewKey;
 
     private String key;
+    private int order;
     private String description = "";
 
     private FilterMode mode = FilterMode.Exclude;
@@ -60,6 +61,19 @@ void setKey(String key) {
         this.key = key;
     }
 
+    /**
+     * Gets the order of this view.
+     *
+     * @return  a positive integer
+     */
+    public int getOrder() {
+        return order;
+    }
+
+    void setOrder(int order) {
+        this.order = Math.max(1, order);
+    }
+
     public String getDescription() {
         return description;
     }

structurizr-core/src/com/structurizr/view/View.java

@@ -24,6 +24,7 @@ public abstract class View {
     private String softwareSystemId;
     private String description = "";
     private String key;
+    private int order;
     private PaperSize paperSize = null;
     private Dimensions dimensions = null;
     private AutomaticLayout automaticLayout = null;
@@ -125,6 +126,19 @@ void setKey(String key) {
         this.key = key;
     }
 
+    /**
+     * Gets the order of this view.
+     *
+     * @return  a positive integer
+     */
+    public int getOrder() {
+        return order;
+    }
+
+    void setOrder(int order) {
+        this.order = Math.max(1, order);
+    }
+
     /**
      * Gets the paper size that should be used to render this view.
      *

structurizr-core/src/com/structurizr/view/ViewSet.java

@@ -53,6 +53,7 @@ public CustomView createCustomView(String key, String title, String description)
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         CustomView view = new CustomView(model, key, title, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         customViews.add(view);
         return view;
@@ -70,6 +71,7 @@ public SystemLandscapeView createSystemLandscapeView(String key, String descript
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         SystemLandscapeView view = new SystemLandscapeView(model, key, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         systemLandscapeViews.add(view);
         return view;
@@ -89,6 +91,7 @@ public SystemContextView createSystemContextView(SoftwareSystem softwareSystem,
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         SystemContextView view = new SystemContextView(softwareSystem, key, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         systemContextViews.add(view);
         return view;
@@ -108,6 +111,7 @@ public ContainerView createContainerView(SoftwareSystem softwareSystem, String k
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         ContainerView view = new ContainerView(softwareSystem, key, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         containerViews.add(view);
         return view;
@@ -127,6 +131,7 @@ public ComponentView createComponentView(Container container, String key, String
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         ComponentView view = new ComponentView(container, key, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         componentViews.add(view);
         return view;
@@ -144,6 +149,7 @@ public DynamicView createDynamicView(String key, String description) {
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         DynamicView view = new DynamicView(model, key, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         dynamicViews.add(view);
         return view;
@@ -170,6 +176,7 @@ public DynamicView createDynamicView(SoftwareSystem softwareSystem, String key,
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         DynamicView view = new DynamicView(softwareSystem, key, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         dynamicViews.add(view);
         return view;
@@ -197,6 +204,7 @@ public DynamicView createDynamicView(Container container, String key, String des
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         DynamicView view = new DynamicView(container, key, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         dynamicViews.add(view);
         return view;
@@ -214,6 +222,7 @@ public DeploymentView createDeploymentView(String key, String description) {
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         DeploymentView view = new DeploymentView(model, key, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         deploymentViews.add(view);
         return view;
@@ -233,6 +242,7 @@ public DeploymentView createDeploymentView(SoftwareSystem softwareSystem, String
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         DeploymentView view = new DeploymentView(softwareSystem, key, description);
+        view.setOrder(getNextOrder());
         view.setViewSet(this);
         deploymentViews.add(view);
         return view;
@@ -253,6 +263,7 @@ public FilteredView createFilteredView(StaticView view, String key, String descr
         assertThatTheViewKeyIsSpecifiedAndUnique(key);
 
         FilteredView filteredView = new FilteredView(view, key, description, mode, tags);
+        filteredView.setOrder(getNextOrder());
         filteredViews.add(filteredView);
         return filteredView;
     }
@@ -624,6 +635,21 @@ private void checkViewKeysAreUnique() {
         }
     }
 
+    private synchronized int getNextOrder() {
+        int order = 0;
+
+        order = Math.max(order, customViews.stream().max(Comparator.comparingInt(View::getOrder)).map(View::getOrder).orElse(0));
+        order = Math.max(order, systemLandscapeViews.stream().max(Comparator.comparingInt(View::getOrder)).map(View::getOrder).orElse(0));
+        order = Math.max(order, systemContextViews.stream().max(Comparator.comparingInt(View::getOrder)).map(View::getOrder).orElse(0));
+        order = Math.max(order, containerViews.stream().max(Comparator.comparingInt(View::getOrder)).map(View::getOrder).orElse(0));
+        order = Math.max(order, componentViews.stream().max(Comparator.comparingInt(View::getOrder)).map(View::getOrder).orElse(0));
+        order = Math.max(order, dynamicViews.stream().max(Comparator.comparingInt(View::getOrder)).map(View::getOrder).orElse(0));
+        order = Math.max(order, deploymentViews.stream().max(Comparator.comparingInt(View::getOrder)).map(View::getOrder).orElse(0));
+        order = Math.max(order, filteredViews.stream().max(Comparator.comparingInt(FilteredView::getOrder)).map(FilteredView::getOrder).orElse(0));
+
+        return order + 1;
+    }
+
     /**
      * Gets the configuration object associated with this set of views.
      *

structurizr-core/test/unit/com/structurizr/view/ViewSetTests.java

@@ -1094,4 +1094,32 @@ public void test_copyLayoutInformationFrom_DoesNothing_WhenMergeFromRemoteIsSetT
         assertNull(view2.getPaperSize());
     }
 
+    @Test
+    public void test_view_ordering() {
+        Workspace workspace = new Workspace("Name", "Description");
+        SoftwareSystem softwareSystem = workspace.getModel().addSoftwareSystem("Software System");
+        Container container = softwareSystem.addContainer("Container");
+        ViewSet views = workspace.getViews();
+
+        CustomView customView = views.createCustomView("custom1", "Title", "Description");
+        SystemLandscapeView systemLandscapeView1 = views.createSystemLandscapeView("landscape1", "Description");
+        FilteredView filteredView = views.createFilteredView(systemLandscapeView1, "filtered1", "Description", FilterMode.Include, "Tag 1");
+        SystemContextView systemContextView = views.createSystemContextView(softwareSystem, "context1", "Description");
+        ContainerView containerView = views.createContainerView(softwareSystem, "container1", "Description");
+        ComponentView componentView = views.createComponentView(container, "component1", "Description");
+        DynamicView dynamicView = views.createDynamicView("dynamic1", "Description");
+        DeploymentView deploymentView = views.createDeploymentView("deployment1", "Description");
+        SystemLandscapeView systemLandscapeView2 = views.createSystemLandscapeView("landscape2", "Description");
+
+        assertEquals(1, customView.getOrder());
+        assertEquals(2, systemLandscapeView1.getOrder());
+        assertEquals(3, filteredView.getOrder());
+        assertEquals(4, systemContextView.getOrder());
+        assertEquals(5, containerView.getOrder());
+        assertEquals(6, componentView.getOrder());
+        assertEquals(7, dynamicView.getOrder());
+        assertEquals(8, deploymentView.getOrder());
+        assertEquals(9, systemLandscapeView2.getOrder());
+    }
+
 }