Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Simplified third-party JSON import (no port alignment/path precalculation required) #341

Merged
merged 3 commits into from
Nov 11, 2024
Merged

fix: Simplified third-party JSON import (no port alignment/path precalculation required) #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5588eb
fix: The import of JSON from third-party providers has been simplifie…
aiAdrian Nov 11, 2024
9e4a1cb
fix: documentation
aiAdrian Nov 11, 2024
c563c94
fix: title JSON-Based Data Import from 3rd Party Data Providers
aiAdrian Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions documentation/DATA_MODEL_JSON.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ To export the current Netzgrafik use the `Export netzgrafik as JSON` button.
#### Import
The exported data in JSON format can be imported again using the `Import netzgrafik as JSON` button.

##### JSON-Based Data Import from 3rd Party Data Providers
If nodes have no port objects or if no TrainrunSection has a defined path element, the import process will automatically adjust,
respectively create the required elements. This adjustment ensures that all nodes are created first, followed by the systematic
insertion of each train, section by section. Inserting each section by section ensures that the Netzgrafik drawing gets well routed.
This streamlines the import process, making the exchange of data much more straightforward and efficient.
The 3rd party has to care about the nodes' position only. The TrainrunSection routing gets computed while importing,
thus no complex calculation must be reimplemented by the 3rd party provider.

## JSON Description (basic data structure)

```json
Expand Down
66 changes: 57 additions & 9 deletions src/app/view/editor-tools-view-component/editor-tools-view.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,22 @@ import {VersionControlService} from "../../services/data/version-control.service
import {
HaltezeitFachCategories,
NetzgrafikDto,
NodeDto,
TrainrunCategoryHaltezeit,
TrainrunSectionDto,
} from "../../data-structures/business.data.structures";
import {downloadBlob} from "../util/download-utils";
import {map} from "rxjs/operators";
import {LabelService} from "../../services/data/label.serivce";
import {NetzgrafikColoringService} from "../../services/data/netzgrafikColoring.service";
import {ViewportCullService} from "../../services/ui/viewport.cull.service";
import {LevelOfDetailService} from "../../services/ui/level.of.detail.service";
import {_ViewRepeaterItemContext} from "@angular/cdk/collections";
import {buildEdges, computeNeighbors, computeShortestPaths, topoSort} from "../util/origin-destination-graph";
import {
buildEdges,
computeNeighbors,
computeShortestPaths,
topoSort
} from "../util/origin-destination-graph";

@Component({
selector: "sbb-editor-tools-view-component",
Expand Down Expand Up @@ -67,20 +73,62 @@ export class EditorToolsViewComponent {
const file = param.target.files[0];
const reader = new FileReader();
reader.onload = () => {
const netzgrafikDto = JSON.parse(reader.result.toString());
const netzgrafikDto: NetzgrafikDto = JSON.parse(reader.result.toString());
if (
"nodes" in netzgrafikDto &&
"trainrunSections" in netzgrafikDto &&
"trainruns" in netzgrafikDto &&
"resources" in netzgrafikDto &&
"metadata" in netzgrafikDto
) {
this.logger.log("onLoad; load netzgrafik: ", netzgrafikDto);
// prepare JSON import
this.uiInteractionService.showNetzgrafik();
this.uiInteractionService.closeNodeStammdaten();
this.uiInteractionService.closePerlenkette();
this.nodeService.unselectAllNodes();
this.dataService.loadNetzgrafikDto(netzgrafikDto);

// check for 3rd Party JSON generated files
const detect3rdParty =
netzgrafikDto.nodes.find((n: NodeDto) =>
n.ports === undefined) !== undefined
||
netzgrafikDto.nodes.filter((n: NodeDto) =>
n.ports?.length === 0).length === netzgrafikDto.nodes.length
||
netzgrafikDto.trainrunSections.find((ts: TrainrunSectionDto) =>
ts.path === undefined ||
ts.path?.path === undefined ||
ts.path?.path?.length === 0
) !== undefined;

// import data
if (
netzgrafikDto.trainrunSections.length === 0
||
!detect3rdParty
) {
// -----------------------------------------------
// Default: Netzgrafik-Editor exported JSON
// -----------------------------------------------
this.dataService.loadNetzgrafikDto(netzgrafikDto);
// -----------------------------------------------
} else {
// --------------------------------------------------------------------------------
// 3rd party generated JSON detected
// --------------------------------------------------------------------------------
console.log("Import: Automatic Port Alignment Detection - 3rd Party Data Import.");
// --------------------------------------------------------------------------------
// (Step 1) Import only nodes
// (Step 2) Import nodes and trainrunSectiosn by trainrun inseration (copy => create)
const netzgrafikOnlyNodeDto: NetzgrafikDto = JSON.parse(reader.result.toString());
netzgrafikOnlyNodeDto.trainruns = [];
netzgrafikOnlyNodeDto.trainrunSections = [];
this.dataService.loadNetzgrafikDto(netzgrafikOnlyNodeDto);
this.dataService.insertCopyNetzgrafikDto(netzgrafikDto);
this.trainrunService.propagateInitialConsecutiveTimes();
}

// recompute viewport
this.uiInteractionService.viewportCenteringOnNodesBoundingBox();
}
};
Expand Down Expand Up @@ -207,7 +255,7 @@ export class EditorToolsViewComponent {
return this.versionControlService.getVariantIsWritable();
}

private buildCSVString(headers: string[], rows: string[][]): string{
private buildCSVString(headers: string[], rows: string[][]): string {
const separator = ";";

const contentData: string[] = [];
Expand Down Expand Up @@ -503,7 +551,7 @@ export class EditorToolsViewComponent {
// TODO: ideally this would be 24 hours, but performance is a concern.
// One idea to optimize would be to consider the minimum time window before the schedule repeats (LCM).
// Draft here: https://colab.research.google.com/drive/1Z1r2uU2pgffWxCbG_wt2zoLStZKzWleE#scrollTo=F6vOevK6znee
const timeLimit = 16*60;
const timeLimit = 16 * 60;

const headers: string[] = [];
headers.push($localize`:@@app.view.editor-side-view.editor-tools-view-component.origin:Origin`);
Expand Down Expand Up @@ -547,8 +595,8 @@ export class EditorToolsViewComponent {
}
const [totalCost, connections] = costs;
const row = [origin.getBetriebspunktName(), destination.getBetriebspunktName(),
(totalCost-connections*connectionPenalty).toString(),
connections.toString(), totalCost.toString()];
(totalCost - connections * connectionPenalty).toString(),
connections.toString(), totalCost.toString()];
rows.push(row);
});
});
Expand Down