Skip to content

Commit 8586298

Browse files
committed
Replace or remove references to SDS and OMP
1 parent 54f7279 commit 8586298

File tree

307 files changed

+1036
-1070
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

307 files changed

+1036
-1070
lines changed

.github/workflows/release-workflow.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Release SDS SDK
1+
name: Release ESMF SDK
22
on:
33
workflow_dispatch:
44
inputs:
@@ -74,9 +74,9 @@ jobs:
7474
- name: Create GitHub release
7575
if: ${{ !contains( github.event.inputs.release_version, '-M' ) }}
7676
uses: softprops/action-gh-release@v1
77-
id: sds_sdk_release
77+
id: esmf_sdk_release
7878
with:
79-
body: "Release of the BAMM SDK in version v${{ github.event.inputs.release_version }}."
79+
body: "Release of ESMF SDK in version v${{ github.event.inputs.release_version }}."
8080
tag_name: v${{ github.event.inputs.release_version }}
8181
target_commitish: ${{ env.release_branch_name }}
8282
draft: false
@@ -87,7 +87,7 @@ jobs:
8787
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8888
- name: Publish to OSSRH
8989
if: ${{ !contains( github.event.inputs.release_version, '-M' ) }}
90-
run: mvn -B clean -pl '!sds-sdk-test-report,!documentation,!tools/samm-cli' deploy -DskipTests -Prelease-build,sign
90+
run: mvn -B clean -pl '!esmf-sdk-test-report,!documentation,!tools/samm-cli' deploy -DskipTests -Prelease-build,sign
9191
env:
9292
OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
9393
OSSRH_TOKEN: ${{ secrets.OSSRH_TOKEN }}
@@ -100,9 +100,9 @@ jobs:
100100
- name: Create GitHub release
101101
if: contains( github.event.inputs.release_version, '-M' )
102102
uses: softprops/action-gh-release@v1
103-
id: sds_sdk_milestone_release
103+
id: esmf_sdk_milestone_release
104104
with:
105-
body: "Release of the BAMM SDK in version v${{ github.event.inputs.release_version }}."
105+
body: "Release of ESMF SDK in version v${{ github.event.inputs.release_version }}."
106106
tag_name: v${{ github.event.inputs.release_version }}
107107
target_commitish: ${{ env.release_branch_name }}
108108
draft: false
@@ -142,7 +142,7 @@ jobs:
142142
write-mode: overwrite
143143
- name: Publish to Github
144144
if: contains( github.event.inputs.release_version, '-M' )
145-
run: mvn -s ./settings.xml -B clean -pl '!sds-sdk-test-report,!documentation,!tools/samm-cli' deploy -DskipTests -Pmilestone-build,sign
145+
run: mvn -s ./settings.xml -B clean -pl '!esmf-sdk-test-report,!documentation,!tools/samm-cli' deploy -DskipTests -Pmilestone-build,sign
146146
env:
147147
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
148148
PGP_KEY_PASSWORD: ${{ secrets.PGP_KEY_PASSWORD }}

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,8 @@ build
145145
/core/sds-aspect-meta-model-legacy*/target
146146

147147
# Directories where classes are generated during unit tests
148-
core/sds-aspect-model-java-generator/src/test/java/io/openmanufacturing/test
149-
core/sds-aspect-model-jackson/src/main/java/io/openmanufacturing/test
148+
core/esmf-aspect-model-java-generator/src/test/java/org/eclipse/esmf/test
149+
core/esmf-aspect-model-jackson/src/main/java/org/eclipse/esmf/test
150150

151151
# jqwik
152152
.jqwik-database

CONVENTIONS.md

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
# SDS SDK Code Conventions
2-
The following document contains a compilation of conventions and guidelines to format, structure and write code for the
3-
SDS SDK.
1+
# ESMF Code Conventions
2+
The following document contains a compilation of conventions and guidelines to format, structure and
3+
write code for the ESMF SDK.
44

55
## General Conventions
6-
Our code conventions are based on the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) but
7-
detailed and adjusted for the needs of the SDS SDK.
6+
Our code conventions are based on the [Google Java Style
7+
Guide](https://google.github.io/styleguide/javaguide.html) but detailed and adjusted for the needs
8+
of the ESMF SDK.
89

910
## Copyright header
1011
See [CONTRIBUTING](CONTRIBUTING.md)
1112

1213
## Code Recommendations
1314

1415
### Utility Classes
15-
[Utility classes](https://wiki.c2.com/?UtilityClasses) as such should be avoided - domain concepts must be expressed in domain classes.
16-
Thus, only for "real", non-domain operations not belonging to any class, utility methods and classes may be used.
17-
However, chances are pretty close to 100% that all of everyday utility needs are already covered by high-quality
18-
3rd-party libraries.
16+
[Utility classes](https://wiki.c2.com/?UtilityClasses) as such should be avoided - domain concepts
17+
must be expressed in domain classes. Thus, only for "real", non-domain operations not belonging to
18+
any class, utility methods and classes may be used. However, chances are pretty close to 100% that
19+
all of everyday utility needs are already covered by high-quality 3rd-party libraries.
1920

2021
Usually we apply the following rule to decide on the introduction of new libraries
2122
1. Check your framework's and its dependency's utility/static constants classes (e.g. Spring or Vert.x)
@@ -24,11 +25,11 @@ Usually we apply the following rule to decide on the introduction of new librari
2425
4. If really not covered, write your own (highly unlikely)
2526

2627
### Optional<> usage
27-
The Optional<> type, common for some time in Guava and in the Java core since Version 8, has found widespread use for
28-
return values, however still a lot of discussions emerge concerning a fitting scope of usage.
29-
You may not return null where an Optional<> is expected
30-
Whenever an Optional<> is passed, you may safely assume it to be non-null.
31-
So the following snippet must never appear anywhere:
28+
The Optional<> type, common for some time in Guava and in the Java core since Version 8, has found
29+
widespread use for return values, however still a lot of discussions emerge concerning a fitting
30+
scope of usage. You may not return null where an Optional<> is expected Whenever an Optional<> is
31+
passed, you may safely assume it to be non-null. So the following snippet must never appear
32+
anywhere:
3233
```
3334
if (someOptional != null && someOptional.isPresent()) ...
3435
```
@@ -44,21 +45,20 @@ if (someOptional != null && someOptional.isPresent()) ...
4445
* You should be using Objects.requireNonNull() for those sort of checks (or Guava's Preconditions if you're having more types of assertions than non-null and aim for a maximum of consistency).
4546

4647
### Lombok
47-
We use Lombok in the SDS SDK.
48-
Project Lombok is a Java library that automatically plugs into your editor and build tools.
49-
It removes the burden to write getter or equals methods, adds fully featured builders to a class with one annotation,
50-
automates logging variables, and much more.
51-
Consider using its features if you are in the need to do something like that.
48+
We use Lombok in the ESMF SDK. Project Lombok is a Java library that automatically plugs into your
49+
editor and build tools. It removes the burden to write getter or equals methods, adds fully featured
50+
builders to a class with one annotation, automates logging variables, and much more. Consider using
51+
its features if you are in the need to do something like that.
5252

5353
## Documentation
5454

5555
### Source Code Documentation
56-
Public classes and interfaces should carry appropriate JavaDoc explaining the responsibility of the class.
57-
All public methods except getters/setters/toString etc. must be documented as well.
58-
Private methods should be simple enough and well-named such that they don't need documentation. If appropriate they of
59-
course may be documented as well. Inline comments, especially those that merely separate logical blocks of code, must be
60-
avoided as they are usually an indicator that a private method can be extracted or that bad naming was used that needs
61-
explaining.
56+
Public classes and interfaces should carry appropriate JavaDoc explaining the responsibility of the
57+
class. All public methods except getters/setters/toString etc. must be documented as well. Private
58+
methods should be simple enough and well-named such that they don't need documentation. If
59+
appropriate they of course may be documented as well. Inline comments, especially those that merely
60+
separate logical blocks of code, must be avoided as they are usually an indicator that a private
61+
method can be extracted or that bad naming was used that needs explaining.
6262

6363
### Developer Documentation
6464
Developer documentation is put into a README.md placed in the project root. This should contain documentation like:
@@ -82,7 +82,3 @@ way more targeted towards writing fully fledged documents and with its multitude
8282
very good source format.
8383
Publishing is realized by means of [Github pages](https://docs.antora.org/antora/2.3/publish-to-github-pages/).
8484

85-
### High Level Documentation
86-
Technical documentation targeted towards components and architecture should be accessible via the developer documentation.
87-
Corresponding discussions on design etc. can be placed in the project wiki on
88-
[Github](https://github.com/OpenManufacturingPlatform/sds-sdk/wiki).

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/metamodel/loader/Instantiator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ private ScalarValue buildScalarValue( final Literal literal ) {
220220
// 1. A custom parser for rdf:langString values can not be registered with Jena, because it would only receive from Jena during parsing
221221
// the lexical representation of the value without the language tag (this is handled specially in Jena).
222222
// 2. This means that a Literal we receive here which has a type URI of rdf:langString will be of type org.apache.jena.datatypes.xsd.impl.RDFLangString
223-
// but _not_ io.openmanufacturing.sds.metamodel.datatypes.LangString as we would like to.
223+
// but _not_ org.eclipse.esmf.metamodel.datatypes.LangString as we would like to.
224224
// 3. So we construct an instance of LangString here from the RDFLangString.
225225
if ( literal.getDatatypeURI().equals( RDF.langString.getURI() ) ) {
226226
final LangString langString = new LangString( literal.getString(), Locale.forLanguageTag( literal.getLanguage() ) );

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/metamodel/loader/MetaModelBaseAttributes.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
import org.eclipse.esmf.aspectmodel.vocabulary.SAMM;
3535
import org.eclipse.esmf.samm.KnownVersion;
36-
import org.eclipse.esmf.aspectmodel.resolver.services.SdsAspectMetaModelResourceResolver;
36+
import org.eclipse.esmf.aspectmodel.resolver.services.SammAspectMetaModelResourceResolver;
3737
import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
3838
import org.eclipse.esmf.metamodel.datatypes.LangString;
3939

@@ -42,7 +42,7 @@
4242
*/
4343
public class MetaModelBaseAttributes {
4444

45-
private static final SdsAspectMetaModelResourceResolver metaModelResourceResolver = new SdsAspectMetaModelResourceResolver();
45+
private static final SammAspectMetaModelResourceResolver metaModelResourceResolver = new SammAspectMetaModelResourceResolver();
4646
private final KnownVersion metaModelVersion;
4747
private final Optional<AspectModelUrn> urn;
4848
private final String name;

core/esmf-aspect-meta-model-java/src/test/java/org/eclipse/esmf/metamodel/loader/AspectMetaModelInstantiatorTest.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public void testAspectTransformationExpectSuccess( final KnownVersion metaModelV
5757
final Aspect aspect = loadAspect( TestAspect.ASPECT_WITH_SEE, metaModelVersion );
5858
final AspectModelUrn expectedAspectModelUrn = TestAspect.ASPECT_WITH_SEE.getUrn();
5959
assertBaseAttributes( aspect, expectedAspectModelUrn, "AspectWithSee", "Test Aspect With See",
60-
"This is a test description", "http://example.com/omp" );
60+
"This is a test description", "http://example.com/" );
6161
}
6262

6363
@ParameterizedTest
@@ -72,7 +72,7 @@ public void testPropertyInstantiationExpectSuccess( final KnownVersion metaModel
7272
final Property property = aspect.getProperties().get( 0 );
7373

7474
assertBaseAttributes( property, expectedAspectModelUrn, "testProperty", "Test Property",
75-
"This is a test property.", "http://example.com/me", "http://example.com/omp" );
75+
"This is a test property.", "http://example.com/me", "http://example.com/" );
7676
assertThat( property.getExampleValue() ).map( value -> value.as( ScalarValue.class ).getValue() ).contains( "Example Value" );
7777
assertThat( property.isOptional() ).isFalse();
7878
assertThat( property.getCharacteristic().get().getName() ).isEqualTo( "Text" );
@@ -91,7 +91,7 @@ public void testOptionalPropertyInstantiationExpectSuccess( final KnownVersion m
9191
final Property property = aspect.getProperties().get( 0 );
9292

9393
assertBaseAttributes( property, expectedAspectModelUrn, "testProperty", "Test Property",
94-
"This is a test property.", "http://example.com/me", "http://example.com/omp" );
94+
"This is a test property.", "http://example.com/me", "http://example.com/" );
9595

9696
assertThat( property.getExampleValue() ).isEmpty();
9797
assertThat( property.isOptional() ).isTrue();
@@ -111,7 +111,7 @@ public void testNotInPayloadPropertyInstantiationExpectSuccess( final KnownVersi
111111
final Property property = entity.getProperties().get( 1 );
112112

113113
assertBaseAttributes( property, expectedAspectModelUrn, "description", "Test Property",
114-
"This is a test property.", "http://example.com/me", "http://example.com/omp" );
114+
"This is a test property.", "http://example.com/me", "http://example.com/" );
115115

116116
assertThat( property.getExampleValue() ).isEmpty();
117117
assertThat( property.isOptional() ).isFalse();
@@ -130,7 +130,7 @@ public void testPropertyWithPayloadNameInstantiationExpectSuccess( final KnownVe
130130
final Property property = aspect.getProperties().get( 0 );
131131

132132
assertBaseAttributes( property, expectedAspectModelUrn, "testProperty", "Test Property",
133-
"This is a test property.", "http://example.com/me", "http://example.com/omp" );
133+
"This is a test property.", "http://example.com/me", "http://example.com/" );
134134

135135
assertThat( property.getExampleValue() ).isEmpty();
136136
assertThat( property.isOptional() ).isFalse();
@@ -150,7 +150,7 @@ public void testEitherCharacteristicInstantiationExpectSuccess( final KnownVersi
150150
final Either either = (Either) aspect.getProperties().get( 0 ).getCharacteristic().get();
151151

152152
assertBaseAttributes( either, expectedAspectModelUrn, "TestEither",
153-
"Test Either", "This is a test Either.", "http://example.com/omp" );
153+
"Test Either", "This is a test Either.", "http://example.com/" );
154154

155155
Assertions.assertThat( either.getDataType() ).isNotPresent();
156156
Assertions.assertThat( either.getLeft().getName() ).isEqualTo( "Text" );
@@ -168,7 +168,7 @@ public void testSingleEntityCharacteristicInstantiationExpectSuccess( final Know
168168
final SingleEntity singleEntity = (SingleEntity) aspect.getProperties().get( 0 ).getCharacteristic().get();
169169

170170
assertBaseAttributes( singleEntity, expectedAspectModelUrn, "EntityCharacteristic",
171-
"Test Entity Characteristic", "This is a test Entity Characteristic", "http://example.com/omp" );
171+
"Test Entity Characteristic", "This is a test Entity Characteristic", "http://example.com/" );
172172

173173
Assertions.assertThat( singleEntity.getDataType().get() ).isInstanceOf( Entity.class );
174174
}
@@ -216,7 +216,7 @@ public void testCodeCharacteristicInstantiationExpectSuccess( final KnownVersion
216216
final Code code = (Code) aspect.getProperties().get( 0 ).getCharacteristic().get();
217217

218218
assertBaseAttributes( code, expectedAspectModelUrn, "TestCode",
219-
"Test Code", "This is a test code.", "http://example.com/omp" );
219+
"Test Code", "This is a test code.", "http://example.com/" );
220220

221221
final Scalar scalar = (Scalar) code.getDataType().get();
222222
assertThat( scalar.getUrn() ).isEqualTo( XSD.xint.getURI() );
@@ -230,7 +230,7 @@ public void testCollectionAspectInstantiationExpectSuccess( final KnownVersion m
230230

231231
assertBaseAttributes( aspect, expectedAspectModelUrn, "AspectWithList", "Test Aspect",
232232
"This is a test description",
233-
"http://example.com/omp" );
233+
"http://example.com/" );
234234

235235
assertThat( aspect.getProperties() ).hasSize( 1 );
236236
assertThat( aspect.isCollectionAspect() ).isTrue();
@@ -245,7 +245,7 @@ public void testAspectWithTwoCollectionsInstantiationExpectSuccess( final KnownV
245245

246246
assertBaseAttributes( aspect, expectedAspectModelUrn, "AspectWithTwoLists", "Test Aspect",
247247
"This is a test description",
248-
"http://example.com/omp" );
248+
"http://example.com/" );
249249

250250
assertThat( aspect.getProperties() ).hasSize( 2 );
251251
assertThat( aspect.isCollectionAspect() ).isFalse();
@@ -259,7 +259,7 @@ public void testAspectWithListAndAdditionalPropertyInstantiationExpectSuccess( f
259259
final AspectModelUrn expectedAspectModelUrn = TestAspect.ASPECT_WITH_LIST_AND_ADDITIONAL_PROPERTY.getUrn();
260260

261261
assertBaseAttributes( aspect, expectedAspectModelUrn, "AspectWithListAndAdditionalProperty",
262-
"Test Aspect", "This is a test description", "http://example.com/omp" );
262+
"Test Aspect", "This is a test description", "http://example.com/" );
263263

264264
assertThat( aspect.getProperties() ).hasSize( 2 );
265265
assertThat( aspect.isCollectionAspect() ).isTrue();

0 commit comments

Comments
 (0)