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

[32] Add the ability to retrieve information during the serialization #33

Merged
merged 2 commits into from
Mar 7, 2024
Merged

[32] Add the ability to retrieve information during the serialization #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80dbda5
[32] Add the ability to retrieve information during the serialization
sbegaudeau Mar 7, 2024
52e00fe
[releng] Bump version to 2.3.7
sbegaudeau Mar 7, 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
2 changes: 1 addition & 1 deletion bundles/org.eclipse.sirius.emfjson.ide/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %Bundle-Name
Bundle-SymbolicName: org.eclipse.sirius.emfjson.ide;singleton:=true
Bundle-Version: 2.3.6.qualifier
Bundle-Version: 2.3.7.qualifier
Bundle-RequiredExecutionEnvironment: JavaSE-1.8
Bundle-Localization: bundle
Require-Bundle: org.eclipse.sirius.emfjson;bundle-version="2.1.0",
Expand Down
4 changes: 2 additions & 2 deletions bundles/org.eclipse.sirius.emfjson.ide/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@
<parent>
<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>org.eclipse.sirius.emfjson.releng</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<relativePath>../../releng/org.eclipse.sirius.emfjson.releng</relativePath>
</parent>


<artifactId>org.eclipse.sirius.emfjson.ide</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>

<name>Sirius EMF JSON - IDE Integration</name>
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.eclipse.sirius.emfjson/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %Bundle-Name
Bundle-SymbolicName: org.eclipse.sirius.emfjson
Bundle-Version: 2.3.6.qualifier
Bundle-Version: 2.3.7.qualifier
Bundle-Vendor: %Bundle-Vendor
Bundle-RequiredExecutionEnvironment: JavaSE-1.8
Bundle-Localization: bundle
Expand Down
4 changes: 2 additions & 2 deletions bundles/org.eclipse.sirius.emfjson/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@
<parent>
<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>org.eclipse.sirius.emfjson.releng</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<relativePath>../../releng/org.eclipse.sirius.emfjson.releng</relativePath>
</parent>


<artifactId>org.eclipse.sirius.emfjson</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>

<name>Sirius EMF JSON</name>
Expand Down
71 changes: 71 additions & 0 deletions ...clipse.sirius.emfjson/src/main/java/org/eclipse/sirius/emfjson/resource/JsonResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.ecore.resource.Resource;

Expand Down Expand Up @@ -425,6 +426,75 @@ interface IEObjectHandler {
*/
Object OPTION_SAVE_FEATURES_ORDER_COMPARATOR = "OPTION_SAVE_FEATURES_ORDER_COMPARATOR"; //$NON-NLS-1$

/**
* An option to provide an ISerializationListener.
*/
String OPTION_SERIALIZATION_LISTENER = "OPTION_SERIALIZATION_LISTENER"; //$NON-NLS-1$

/**
* Used to listen to various events during the serialization.
*
* @author <a href="mailto:[email protected]">Stephane Begaudeau</a>
*/
interface ISerializationListener {

/**
* Called when an entry is added to the namespace header.
*
* @param nsPrefix
* The prefix of the ePackage added
* @param nsURI
* The URI of the ePackage added
*/
void onNsHeaderEntryAdded(String nsPrefix, String nsURI);

/**
* Called when an object is serialized.
*
* @param eObject
* The EObject serialized
* @param jsonElement
* The serialization of the EObject
*/
void onObjectSerialized(EObject eObject, JsonElement jsonElement);

/**
* Called when a proxy to an object located in another resource has been created.
*
* @param eObject
* The object for which the URI is created
* @param eReference
* The reference containing the object
* @param uri
* The uri created
*/
void onCrossReferenceURICreated(EObject eObject, EReference eReference, String uri);

/**
* Implementation of the listener which does nothing.
*
* @author <a href="mailto:[email protected]">Stephane Begaudeau</a>
*/
class NoOp implements ISerializationListener {

@Override
public void onNsHeaderEntryAdded(String nsPrefix, String nsURI) {
// Do nothing
}

@Override
public void onObjectSerialized(EObject eObject, JsonElement jsonElement) {
// Do nothing
}

@Override
public void onCrossReferenceURICreated(EObject eObject, EReference eReference, String uri) {
// Do nothing
}

}
}

/**
* Associate an ID to the {@link EObject}.
*
Expand All @@ -434,4 +504,5 @@ interface IEObjectHandler {
* the id
*/
void setID(EObject eObject, String id);

}
19 changes: 15 additions & 4 deletions ....sirius.emfjson/src/main/java/org/eclipse/sirius/emfjson/utils/GsonEObjectSerializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
import org.eclipse.sirius.emfjson.resource.JsonResource;
import org.eclipse.sirius.emfjson.resource.JsonResource.EStructuralFeaturesFilter;
import org.eclipse.sirius.emfjson.resource.JsonResource.IEObjectHandler;
import org.eclipse.sirius.emfjson.resource.JsonResource.ISerializationListener;
import org.eclipse.sirius.emfjson.resource.JsonResource.ResourceEntityHandler;
import org.eclipse.sirius.emfjson.resource.exception.DanglingHREFException;

Expand Down Expand Up @@ -127,6 +128,8 @@ public class GsonEObjectSerializer implements JsonSerializer<List<EObject>> {
*/
private IEObjectHandler eObjectHandler;

private ISerializationListener serializationListener;

/**
* The constructor.
*
Expand Down Expand Up @@ -166,7 +169,11 @@ public GsonEObjectSerializer(Resource resource, Map<?, ?> options) {
this.helper.setExtendedMetaData(this.extendedMetaData);
}

this.eObjectHandler = (JsonResource.IEObjectHandler) serializedOptions.get(JsonResource.OPTION_EOBJECT_HANDLER);
this.eObjectHandler = (IEObjectHandler) serializedOptions.get(JsonResource.OPTION_EOBJECT_HANDLER);
this.serializationListener = (ISerializationListener) serializedOptions.get(JsonResource.OPTION_SERIALIZATION_LISTENER);
if (this.serializationListener == null) {
this.serializationListener = new ISerializationListener.NoOp();
}

this.declareSchemaLocation = Boolean.TRUE.equals(options.get(JsonResource.OPTION_SCHEMA_LOCATION));

Expand Down Expand Up @@ -236,6 +243,8 @@ private JsonElement createData(EObject eObject) {
this.eObjectHandler.processSerializedContent(jsonElement, eObject);
}

this.serializationListener.onObjectSerialized(eObject, jsonElement);

return jsonElement;
}

Expand Down Expand Up @@ -835,6 +844,7 @@ private JsonElement createNsHeader() {
List<String> nsPrefixes = this.helper.getPrefixes(ePackage);
for (String nsPrefix : nsPrefixes) {
jsonObject.add(nsPrefix, new JsonPrimitive(nsURI));
this.serializationListener.onNsHeaderEntryAdded(nsPrefix, nsURI);
}
}
}
Expand Down Expand Up @@ -1381,7 +1391,7 @@ private JsonElement serializeMultipleNonContainmentEReference(EObject eObject, E
break;
case CROSS_DOC:
if (value != null) {
jsonArray.add(new JsonPrimitive(this.saveHref(value, null)));
jsonArray.add(new JsonPrimitive(this.saveHref(value, eReference)));
}
break;
default:
Expand Down Expand Up @@ -1495,6 +1505,7 @@ private String saveHref(EObject object, EReference eReference) {
// TODO: element Handler if statement : look at XMLSaveImpl line 2308
value += href;
}
this.serializationListener.onCrossReferenceURICreated(object, eReference, value);
return value;
}

Expand Down Expand Up @@ -1540,8 +1551,8 @@ private int docKindSingle(EObject eObject, EReference eReference) {
}

/**
* Return the the URI fragment if the pointed resource URI schema is the same of the Resource URI schema. Return the
* all URI otherwise.
* Return the URI fragment if the pointed resource URI schema is the same of the Resource URI schema. Return the all
* URI otherwise.
*
* @param pointedResourceUri
* the pointed resource URI
Expand Down
2 changes: 1 addition & 1 deletion features/org.eclipse.sirius.emfjson.feature.ide/feature.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<feature
id="org.eclipse.sirius.emfjson.feature.ide"
label="%Feature-name"
version="2.3.6.qualifier"
version="2.3.7.qualifier"
provider-name="%Feature-vendor">

<description url="">
Expand Down
4 changes: 2 additions & 2 deletions features/org.eclipse.sirius.emfjson.feature.ide/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
<parent>
<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>org.eclipse.sirius.emfjson.releng</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<relativePath>../../releng/org.eclipse.sirius.emfjson.releng</relativePath>
</parent>


<artifactId>org.eclipse.sirius.emfjson.feature.ide</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<packaging>eclipse-feature</packaging>

<name>Sirius EMF JSON - IDE Integration Feature</name>
Expand Down
2 changes: 1 addition & 1 deletion features/org.eclipse.sirius.emfjson.feature/feature.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<feature
id="org.eclipse.sirius.emfjson.feature"
label="%Feature-name"
version="2.3.6.qualifier"
version="2.3.7.qualifier"
provider-name="%Feature-vendor">

<description url="">
Expand Down
4 changes: 2 additions & 2 deletions features/org.eclipse.sirius.emfjson.feature/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
<parent>
<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>org.eclipse.sirius.emfjson.releng</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<relativePath>../../releng/org.eclipse.sirius.emfjson.releng</relativePath>
</parent>


<artifactId>org.eclipse.sirius.emfjson.feature</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<packaging>eclipse-feature</packaging>

<name>Sirius EMF JSON Feature</name>
Expand Down
2 changes: 1 addition & 1 deletion releng/org.eclipse.sirius.emfjson.releng/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>org.eclipse.sirius.emfjson.releng</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<packaging>pom</packaging>

<name>Sirius EMF JSON</name>
Expand Down
4 changes: 2 additions & 2 deletions releng/org.eclipse.sirius.emfjson.targetplatforms/2019-06/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
<parent>
<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>org.eclipse.sirius.emfjson.releng</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<relativePath>../../org.eclipse.sirius.emfjson.releng</relativePath>
</parent>

<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>emfjson-2019-06</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<packaging>eclipse-target-definition</packaging>

</project>
4 changes: 2 additions & 2 deletions releng/org.eclipse.sirius.emfjson.targetplatforms/luna/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
<parent>
<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>org.eclipse.sirius.emfjson.releng</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<relativePath>../../org.eclipse.sirius.emfjson.releng</relativePath>
</parent>

<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>emfjson-luna</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<packaging>eclipse-target-definition</packaging>

</project>
2 changes: 1 addition & 1 deletion repositories/org.eclipse.sirius.emfjson.repository/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>org.eclipse.sirius.emfjson.releng</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<relativePath>../../releng/org.eclipse.sirius.emfjson.releng</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion tests/org.eclipse.sirius.emfjson.tests/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %Bundle-Name
Bundle-SymbolicName: org.eclipse.sirius.emfjson.tests
Bundle-Version: 2.3.6.qualifier
Bundle-Version: 2.3.7.qualifier
Bundle-Vendor: %Bundle-Vendor
Bundle-RequiredExecutionEnvironment: JavaSE-1.8
Bundle-Localization: bundle
Expand Down
4 changes: 2 additions & 2 deletions tests/org.eclipse.sirius.emfjson.tests/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
<parent>
<groupId>org.eclipse.sirius.emfjson</groupId>
<artifactId>org.eclipse.sirius.emfjson.releng</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<relativePath>../../releng/org.eclipse.sirius.emfjson.releng</relativePath>
</parent>


<artifactId>org.eclipse.sirius.emfjson.tests</artifactId>
<version>2.3.6-SNAPSHOT</version>
<version>2.3.7-SNAPSHOT</version>
<packaging>eclipse-test-plugin</packaging>

<name>Sirius EMF JSON - Tests</name>
Expand Down
22 changes: 22 additions & 0 deletions ...n.tests/src/main/java/org/eclipse/sirius/emfjson/tests/internal/AbstractEMFJsonTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EPackage;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.EcorePackage;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
Expand Down Expand Up @@ -67,6 +68,11 @@ public abstract class AbstractEMFJsonTests {
*/
protected Map<Object, Object> options = new HashMap<Object, Object>();

/**
* Data saved by the serialization listener.
*/
protected Map<String, Object> listenerData = new HashMap<String, Object>();

/**
* Returns the path of the folder containing the models used during the tests of this class.
*
Expand All @@ -82,6 +88,8 @@ public abstract class AbstractEMFJsonTests {
* The name of the resource to save
*/
protected void testSave(String resourceName) {
this.listenerData.clear();

Resource modelResource = this.getModelResource(resourceName, true);

ResourceSet resourceSet = new ResourceSetImpl();
Expand All @@ -104,6 +112,20 @@ protected void testSave(String resourceName) {
this.options.put(JsonResource.OPTION_PRETTY_PRINTING_INDENT, JsonResource.INDENT_2_SPACES);
this.options.put(JsonResource.OPTION_SCHEMA_LOCATION, Boolean.TRUE);

JsonResource.ISerializationListener serializationListener = new JsonResource.ISerializationListener.NoOp() {
@Override
public void onNsHeaderEntryAdded(String nsPrefix, String nsURI) {
AbstractEMFJsonTests.this.listenerData.put("onNsHeaderEntryAdded", nsPrefix + " - " + nsURI); //$NON-NLS-1$//$NON-NLS-2$
}

@Override
public void onCrossReferenceURICreated(EObject eObject, EReference eReference, String uri) {
AbstractEMFJsonTests.this.listenerData.put("onCrossReferenceURICreated", uri); //$NON-NLS-1$
}
};

this.options.put(JsonResource.OPTION_SERIALIZATION_LISTENER, serializationListener);

resource.save(outputStream, this.options);

String json = new String(outputStream.toByteArray(), Charset.forName("utf-8")); //$NON-NLS-1$
Expand Down
Loading
Loading