Avoid clashes in ModelBuilder by reusing existing model elements #272
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates
ModelBuilderso that it checks whether a model element with a givenidalready exists before creating a new one. This avoids clashes and duplicate elements when
using
ModelBuilderto extend or modify existing models.The following methods now reuse existing elements if present:
buildModel(String id, String name)→ reuses the existing model in theSBMLDocumentif set.buildCompartment(...)→ usesmodel.getCompartment(id)if available.buildParameter(...)→ usesmodel.getParameter(id)if available.buildReaction(...)→ usesmodel.getReaction(id)if available.buildSpecies(...)→ usesmodel.getSpecies(id)if available.buildUnitDefinition(...)→ usesmodel.getUnitDefinition(id)if available.In each case, a new element is only created if no element with the given
idalready exists.Rationale
Previously,
ModelBuilderalways calledcreateXXX(id)on the model, assuming that elementswith the given IDs did not exist yet. When extending an existing model, this could lead to
clashes or exceptions if an element with that
idwas already present.With these changes,
ModelBuilderbecomes safer to use for both new and existing models.Related issue