GH-3: Allow any cim namespace URIs by bern-soptim · Pull Request #5 · SOPTIM/OpenCGMES

bern-soptim · 2026-01-17T21:08:30Z

The CIMXML library now supports any cim namespace and a configurable mapping of cim namespace URIs to custom CimProfile implementations besides the existing CimProfile16, CimProfile17 and CimProfile18.

For this mapping, the CimNamespaceMapper has been introduced.

The static enum CimVersion has be removed and all usages have been replaced by the namespace URIs.

Before, there was a fixed set of cim namespaces supported by the CIMXML library:

"http://iec.ch/TC57/2013/CIM-schema-cim16#" -> CimVersion.CIM_16; "http://iec.ch/TC57/CIM100#" -> CimVersion.CIM_17; "https://cim.ucaiug.io/ns#" -> CimVersion.CIM_18;
anything else: CimVersion.NO_CIM;

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimGraph.java

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimNamespaceMapper.java

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimProfile.java

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimProfile17.java

shinji-san · 2026-02-05T20:00:59Z

cimxml/src/main/java/de/soptim/opencgmes/cimxml/rdfs/CimProfileRegistryStd.java

+        Objects.requireNonNull(cimNamespace, "cimNamespace");
+        final var profile = headerProfilesByCimNamespace.get(cimNamespace);
        if (profile == null)
            return null;


Just a note on this code path: This method is public and returns a Map, so it should not return null. Please return an empty map instead (e.g., Map.of()), so callers don’t need additional null checks and we avoid potential NullPointerExceptions.

Suggested change

return null;

return Map.of();

Thanks. I use Collections.emptyMap() now.

shinji-san · 2026-02-05T20:08:30Z

cimxml/src/main/java/de/soptim/opencgmes/cimxml/rdfs/CimProfileRegistryStd.java

Creating a HashMap via ctor with known capacity, the requested capacity is not fully allocated by default.

Suggested change

final var map = HashMap.newHashMap(1_024);

That was not the intention here, it should simply not start too small, as there are typically a few hundred properties in CIM/CGMES.

shinji-san · 2026-02-05T20:36:18Z

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimNamespaceMapper.java

+import java.util.concurrent.ConcurrentHashMap;
+import java.util.function.Function;
+
+public class CimNamespaceMapper {


This sounds like a naming smell. The class has members to register factories. It also has members to unregister factories.
Pls rename it.

Suggested change

public class CimNamespaceMapper {

public class CimNamespaceFactoryCatalog {

Suggested change

public class CimNamespaceMapper {

public class CimNamespaceFactoryRegistry {

Great name, using CimNamespaceFactoryRegistry now.

shinji-san · 2026-02-05T20:53:57Z

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimProfile17.java

+        if(!isHeaderProfile) {
+            if (!CimProfile17.hasOntology(graph)) {
+                throw new IllegalArgumentException("Graph does not contain the required ontology subject for a CIM profile.");
+            }
+            if (!CimProfile17.hasVersionIRIAndKeyword(graph)) {
+                throw new IllegalArgumentException("Graphs ontology does not contain the required versionIRI and keyword for a CIM profile.");
+            }
+        }


Reduce nesting

Suggested change

if(!isHeaderProfile) {

if (!CimProfile17.hasOntology(graph)) {

throw new IllegalArgumentException("Graph does not contain the required ontology subject for a CIM profile.");

}

if (!CimProfile17.hasVersionIRIAndKeyword(graph)) {

throw new IllegalArgumentException("Graphs ontology does not contain the required versionIRI and keyword for a CIM profile.");

}

}

if (isHeaderProfile) {

return;

}

if (!CimProfile17.hasOntology(graph)) {

throw new IllegalArgumentException("Graph does not contain the required ontology subject for a CIM profile.");

}

if (!CimProfile17.hasVersionIRIAndKeyword(graph)) {

throw new IllegalArgumentException("Graphs ontology does not contain the required versionIRI and keyword for a CIM profile.");

}

thanks, I applied this as suggested

shinji-san

I am sorry. During a second review, I found a few more points.

shinji-san · 2026-02-16T17:48:56Z

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimNamespaceFactoryRegistry.java

+    }
+
+    public static void registerProfileFactory(String namespace, Function<Graph, CimProfile> factory) {
+        Objects.requireNonNull(namespace, "namespace");


Pls define a constant instead of duplicating this literal value (namespace) four times.

shinji-san · 2026-02-16T20:13:15Z

cimxml/src/main/java/de/soptim/opencgmes/cimxml/CimHeaderVocabulary.java

-    public final static Node GRAPH_PRECONDITIONS = NodeFactory.createURI(GRAPH_PRECONDITIONS_URI);
+    public static final Node GRAPH_FORWARD_DIFFERENCES = NodeFactory.createURI(GRAPH_FORWARD_DIFFERENCES_URI);
+    public static final Node GRAPH_REVERSE_DIFFERENCES = NodeFactory.createURI(GRAPH_REVERSE_DIFFERENCES_URI);
+    public static final Node GRAPH_PRECONDITIONS = NodeFactory.createURI(GRAPH_PRECONDITIONS_URI);


Maybe, to prevent the class from being instantiated, you can define a private constructor. This will prevent the compiler from implicitly generating a public parameterless constructor.

shinji-san · 2026-02-16T20:16:32Z

cimxml/src/test/java/de/soptim/opencgmes/parser/TestParserCIMXMLConformity.java

 import de.soptim.opencgmes.cimxml.graph.CimProfile;
+import de.soptim.opencgmes.cimxml.graph.CimProfile17;
+import de.soptim.opencgmes.cimxml.graph.CimProfile18;
+import de.soptim.opencgmes.cimxml.parser.CimXmlParser;


Unused. Can be removed

cimxml/src/main/java/de/soptim/opencgmes/cimxml/parser/system/StreamCimXmlToDatasetGraph.java

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimModelHeader.java

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimProfile17.java

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/DisjointMultiUnion.java

cimxml/src/main/java/de/soptim/opencgmes/cimxml/sparql/core/LinkedCimDatasetGraph.java

cimxml/src/test/java/de/soptim/opencgmes/cimxml/rdfs/CimProfileRegistryStdTest.java

.gitignore

cimxml/src/test/java/de/soptim/opencgmes/parser/TestConvertCimXmlToJsonLd.java

wilu-soptim · 2026-03-17T13:26:27Z

Please resolve the merge conflicts in the gitignore and pom.xml

The CIMXML library now supports any cim namespace and a configurable mapping of cim namespace URIs to custom `CimProfile` implementations besides the existing `CimProfile16`, `CimProfile17` and `CimProfile18`. For this mapping, the `CimNamespaceFactoryRegistry` has been introduced. The static enum `CimVersion` has be removed and all usages have been replaced by the namespace URIs. Before, there was a fixed set of cim namespaces supported by the CIMXML library: "http://iec.ch/TC57/2013/CIM-schema-cim16#" -> `CimVersion.`; "http://iec.ch/TC57/CIM100#" -> `CimVersion.CIM_17`; "https://cim.ucaiug.io/ns#" -> `CimVersion.CIM_18`; anything else: `CimVersion.NO_CIM`; New public method CimProfileRegistry#getMatchingProfiles to find matching profile for a given set of `owlVerionIRIs`. --> this enables for generich JSON-LD export demonstrated in `TestConvertCimXmlToJsonLd` Upgraded to Jena 5.6.0 Using Apache Jena `GraphFactory.createGraphMem()` instead of specific graph implementations. This makes migration easier. Especially with the renamed graph implementation in Jena 6.0 . - added several code quality plugins - spotbugs-maven-plugin - maven-checkstyle-plugin - maven-pmd-plugin - jacoco-maven-plugin - license-maven-plugin - cyclonedx-maven-plugin (for SBOM) - using the Google coding conventions for Java (checkstyle) - configured IntelliJ for Google coding conventions for Java Refactored CIMXML handling: rename classes and methods for consistency, add code style configuration, and update .gitignore. Updated keyword for FileHeaderProfiles for compatibility with CGMES 3.0 and refactor URI handling in conversion.

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimModelHeader.java

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/DisjointMultiUnion.java

… documentation in DisjointMultiUnion

wilu-soptim

All of my feedback has been adressed. Thank you!

wilu-soptim requested changes Feb 3, 2026

View reviewed changes

shinji-san suggested changes Feb 5, 2026

View reviewed changes

bern-soptim force-pushed the GT-3-Allow-any-cim-namespace-URIs branch from d99c4c2 to 1a5e544 Compare February 13, 2026 13:25

shinji-san suggested changes Feb 16, 2026

View reviewed changes

spah-soptim linked an issue Mar 2, 2026 that may be closed by this pull request

Allow any cim namespace URIs #3

Open

bern-soptim force-pushed the GT-3-Allow-any-cim-namespace-URIs branch from 72a39f0 to 7856af0 Compare March 7, 2026 20:07

wilu-soptim requested changes Mar 17, 2026

View reviewed changes

bern-soptim force-pushed the GT-3-Allow-any-cim-namespace-URIs branch from 7856af0 to 3af063e Compare March 17, 2026 20:31

wilu-soptim requested changes Mar 19, 2026

View reviewed changes

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/CimModelHeader.java Outdated Show resolved Hide resolved

cimxml/src/main/java/de/soptim/opencgmes/cimxml/graph/DisjointMultiUnion.java Outdated Show resolved Hide resolved

bern-soptim added 2 commits March 19, 2026 14:28

refactor: Improve model retrieval logic in CimModelHeader and enhance…

a9ed530

… documentation in DisjointMultiUnion

refactor: Improve model retrieval logic in CimModelHeader and enhance…

e6b0555

… documentation in DisjointMultiUnion

wilu-soptim approved these changes Mar 20, 2026

View reviewed changes

	public class CimNamespaceMapper {
	public class CimNamespaceFactoryCatalog {

	public class CimNamespaceMapper {
	public class CimNamespaceFactoryRegistry {

Conversation

bern-soptim commented Jan 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shinji-san left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wilu-soptim commented Mar 17, 2026

Uh oh!

Uh oh!

Uh oh!

wilu-soptim left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants