Release Notes

There are numerous bug fixes and improvements included with this build, some of which are described below. Where the description applies to a fix for a bug reported through Bugzilla, the Bugzilla number is included after the description.

• Better JET encoding support has been added. UTF-8 encoded templates are supported now. (Bugzilla 38074, 38075, 38078, 41723)
• The org.eclipse.emf.codegen.jet.JETSkeleton.java class has been changed to generate code with platform-specific linefeeds. (Bugzilla 24371)
• The org.eclipse.emf.codegen.jmerge.JMerger.java class has been changed to accommodate platform-dependent line separator character(s).
• The org.eclipse.emf.common.util.BasicEMap.java class has been updated to fix a recursive cycle bug encountered when using the putEntry(Entry entry, Object value) method to put a new value to an existing key.
• The org.eclipse.emf.common.util.URI.java class has been updated to handle resolution of JAR-scheme URIs. Also, comparison of schemes has been made case-insensitive in all URI operations, including testing equality.
• Changes have been made to handle xsi:noNamespaceSchemaLocation in XML and XMI instance documents. (Bugzilla 39440)
• The setAttribValue(EObject object, String name, String value) in the org.eclipse.emf.ecore.xmi.impl.XMLHandler.java class has been changed to properly handle qualified attributes.
• The org.eclipse.emf.edit.ui.celleditor.FeatureEditorDialog.java class has been modified to make it more generally useful. A new constructor has been added that enables you to instantiate a FeatureEditorDialog that can be used to edit any set of values that are passed to it during construction, rather than the values of a specified feature of a specified EObject. The new constructor is used by the createPropertyEditor(Composite composite) method in the org.eclipse.emf.edit.ui.provider.PropertyDescriptor.java class, which fixes a problem that can occur when using an ItemPropertyDescriptorDecorator to customize a multi-valued property.
• Drag and drop for the generated editor has been fixed on Linux. (Bugzilla 39151)
• The next() method in the org.eclipse.emf.common.util.AbstractTreeIterator.java class has been changed so that it doesn't return the root if it's not supposed to, even if the hasNext() method hasn't been called. (Bugzilla 39893)

There are bug fixes and improvements included with this build, some of which are described below. Where the description applies to a bug reported through Bugzilla, the Bugzilla number is included after the description.

• The eBasicSetContainer(InternalEObject newContainer, int newContainerFeatureID, NotificationChain msgs) method in the org.eclipse.emf.ecore.impl.EObjectImpl.java class has been changed so that eBasicSetContainer(newContainer, newContainerFeatureID) is called before newResource.attached(this). (Bugzilla 41907)
• The painting problem with the ExtendedTableTreeViewer on Linux-GTK has been fixed. (Bugzilla 39707)
• The version numbers for the plugins in the feature.xml files have been updated to 1.1.1. Additionally, in the feature.xml file for the org.eclipse.emf feature, the following updates have been made in the requires element:
  • in the import element for the org.eclipse.core.resources plugin, the version has been changed to 2.1.1
  • in the import element for the org.apaches.xerces plugin, the version has been changed to 4.0.13

There are bug fixes and improvements included with this build, some of which are described below. Where the description applies to a bug reported through Bugzilla, the Bugzilla number is included after the description.

• The org.eclipse.emf.ecore.util.EcontentAdapter.java class has been improved. Included are the following changes:
  • REMOVING_ADAPTER notification is now used to remove children recursively.
  • (Bugzilla 43417)
  • super.setTarget(target) is now called during the setTarget(Notifier target) method.
  • (Bugzilla 43416)
• Importing a Rose model containing a reference from a class to another class that is stereotyped <<datatype>> is now supported. Previously, this would result in a ClassCastException. (Bugzilla 41993)
• EMF now avoids generating methods that collide with feature methods. For example, suppose that you have an interface A, and that A extends an interface containing a method with the signature Foo getFoo(). If A also has an attribute named foo of type Foo,then the accessor method with the signature Foo getFoo() would collide with the method from the parent interface. In this case, the generated interface A will contain only one Foo getFoo() method. Further, the implementation of the Foo getFoo() method in the generated AImpl.java class will be that for the accessor method. (Bugzilla 38602)
• The package name resolution algorithm in the method resolve(EModelElement eModelElement, String typeName, boolean recordDemandCreatedEDataType) in the org.eclipse.emf.codegen.ecore.JavaEcoreBuilder.java class has been improved. (Bugzilla 44080)
• The braceLine attribute in the org.eclipse.emf.codegen.jmerge.JMerger.java class has been changed to escape the brace. (Bugzilla 45182)
• EMF now throws a PackageNotFoundException if you try to reference a Resource that references an unregistered package. (Bugzilla 43123)
• The resetPropertyValue(Object object) method in the org.eclipse.emf.edit.provider.ItemPropertyDescriptior.java class has now been implemented. (Bugzilla 41706)

Only XSD has changed for this maintenance release.

1. Eclipse 2.1 based

   As with EMF 1.0.2, the EMF 1.1.0 drivers will only work well with Eclipse 2.1 or Eclipse 2.1.1. They should work with 2.0.2, but they won't get the CLASSPATH correct for .editor projects.

2. Migration from 1.0.2

   Code regeneration of 1.0.2 projects is recommended, but not required. (See "Bug Fixes and Improvements" below.)

3. New Mapping Plugins

   Two new mapping plugins (org.eclipse.emf.mapping and org.eclipse.emf.mapping.ui) have been added. Documentation for these new plugins will be forthcoming soon. A sample of their use is provided by the two xsd2ecore plugins (org.eclipse.emf.mapping.xsd2ecore and org.eclipse.emf.mapping.xsd2ecore.editor) in the XSD (XML Schema Infoset Model) Eclipse Tools Subproject, Version 1.1.0.

There are numerous bug fixes and improvements included with this build, some of which are described below. Where the description applies to a fix for a bug reported through Bugzilla, the Bugzilla number is included after the description.

• XMI files created by the org.eclipse.emf.ecore.xmi plugin are now saved with a system-specific line separator. (Bugzilla 36913).
• You can now use the empty String ("") as the default value for a String attribute in your Rose model.
• EMF now writes the .ecore and .genmodel files using UTF-8 as the encoding when the default Java locale's language is not English.
• EMF can now read a Rose .mdl file created by a Japanese version of Rose (Rose 2001A.04.00 Japanese version). (Bugzilla 36651).
• The EMF code generator now supports classes (or more generally types) whose names end in "Impl". (Bugzilla 35952).
• A number of improvements have been made to the XSD to Ecore conversion, including improvements in the ability to parse according to the originating schema.
• The implementation for dynamic EMF has been reworked to be faster and to use less space.
• We have introduced org.eclipse.emf.common.util.DelegatingEList, org.eclipse.emf.common.notify.impl.DelegatingNotifyingListImpl, and org.eclipse.emf.ecore.util.DelegatingEcoreEList to allow clients to wrap an existing list implementation that they may have as the "backing store" for a list that implements all the correct EMF behaviors.
• Important! Template changes to improve performance and to ensure that dynamic EMF works properly for multiple inheritance will be picked up only if clients regenerate their models, so it is recommended but not required that clients regenerate.

There are numerous bug fixes and improvements included with this build, some of which are described below. Where the description applies to a fix for a bug reported through Bugzilla, the Bugzilla number is included after the description. You can link directly to the Bugzilla bug using this number.

• The method URI.createDeviceURI is deprecated in favor of using URI.createURI which will always recognize a leading device component just as URI.createDeviceURI did previously. We ask that clients remove uses of createDeviceURI so that we can remove the method from a subsequent drop. In general, any deprecation warning should be eliminated in anticipation of the support disappearing.
• The feature order of serialized instances is now preserved when going from XSD to Ecore.
• The infinite loop caused by a missing resource for the org.eclipse.emf.common plugin has been fixed. (Bugzilla 37193).
• The generated model editor wizard now provides an encoding choice. Important! Because of this change, a newly generated editor plugin will now require (and include) the following import in its plugin.xml file:

  <import plugin="org.eclipse.emf.ecore.xmi"/>

  However, because the plugin.xml file is not regenerated or merged, clients who are regenerating an editor that they have generated before will need either to remove the plugin.xml file and let it be regenerated anew, or to add this import manually to the existing plugin.xml file. (Bugzilla 37366).

• The .properties file used by the generated editor plugin is now ISO-8859-1 encoded. (Bugzilla 37367).
• The getPropertyDescriptor(Object object, Object propertyId) method in the org.eclipse.emf.edit.provider.ItemProviderAdapter.java now demand creates properties. (Bugzilla 37190).
• OPTION_ENCODING is now supported an an alternative/override to setEncoding() when saving an XMLResource (org.eclipse.emf.ecore.xmi.XMLResource). An example of its use is as follows:

      Map options = new HashMap();
      options.put(XMLResource.OPTION_ENCODING, initialObjectCreationPage.getEncoding());
      resource.save(options);
  

• Some minor API changes include removing the empty XMIHelper interface, eliminating XMLResource.changed in favor of supporting repeating calls to XMLResource.setID, and changing EObject.eContainmentFeature's result type from EStructuralFeature to EReference.
• Notification.CREATE in org.eclipse.emf.common.notify.Notification.java has been deprecated. We ask that clients remove uses of Notification.CREATE so that we can remove it from a subsequent drop. In general, any deprecation warning should be eliminated in anticipation of the support disappearing.

There are numerous bug fixes and improvements included with this build, some of which are described below.

• The following now applies to the xsd2ecore mapping:
  • If an attribute's type is primitive (or it is an enum), it should be unsettable when mapped to Ecore.
  • If its type is not primitive (and not an enum) and it has a default value different from null, it should be unsettable when mapped to Ecore.
  • Also, support for promoting a primitive type to a wrapper type for nillable elements has been added.
• The eSettingDelegate() accessor method in the EObjectImpl.java class has been added to provide access to SettingDelegate.
• For the EMF .ecore/.genmodel editors and the generated model editors, the menubar Edit menu items are now enabled when the outline and properties views have focus.
• Multiline @model annotations are now supported.
• A check has been added to ensure that the GenPackage's prefix is always made to begin with an uppercase letter, if it does not already.

There are some bug fixes and improvements included with this build, some of which are described below.

• The prepare() method in ReplaceCommand has been corrected to accept objects of the correct class. (Bugzilla 37953).
• Both IntegerCellEditor and FloatCellEditor have been deprecated in org.eclipse.emf.edit.ui.provider.PropertyDescriptor.java; EDataTypeCellEditor should be used instead. We ask that clients remove uses of both IntegerCellEditor and FloatCellEditor so that we can remove them from a subsequent drop. In general, any deprecation warning should be eliminated in anticipation of the support disappearing.
• In the org.eclipse.emf.codegen.jet package, two constructors have been added to the JETEmitter.java class to enable the class loader to be provided explicitly. Also, the GenModelImpl.java class in the org.eclipse.emf.codegen.ecore.genmodel.impl package has been changed to use them.
• When using Java annotations, the following will be ignored: -an interface that appears in the @extends or @implements notation in the comment (i.e., an interface that is being extended or implemented) The reasoning for this is as follows: If you want to model this, you would not use @extends (or @implements, as appropriate). Therefore, the appearance of an interface in the @extends/@implements implies that it is intentionally outside of the model.

There are some bug fixes and improvements included with this build, some of which are described below.

• In the org.eclipse.emf.ecore.util package, the following EcoreEList subclass inheritance bugs have been fixed:
  • EObjectContainmentElist.Unsettable now extends EObjectContainmentEList instead of EObjectEList.
  • EObjectWithInverseResolvingEList.Unsettable.ManyInverse now extends EObjectWithInverseResolvingEList.Unsettable instead of EObjectWithInverseEList.Unsettable.
• The org.eclipse.emf.ecore.util.ECoreUtil class has been made noninstantiable.
• The visibility of the prepare() method in the org.eclipse.emf.edit.command.SetCommand class has been changed from public to protected.

There are some bug fixes and improvements included with this build, some of which are described below.

• The change that made the org.eclipse.emf.ecore.util.ECoreUtil class noninstantiable has been reversed.

There are some bug fixes and improvements included with this build, some of which are described below.

• The setSelectionToWidget((List list, boolean reveal) method in the org.eclipse.emf.mapping.presentation.MappingEditor.java class has been changed to guard against the list being null. (Bugzilla 38693)
• The generated code for an attribute with isUnique=False now ensures that isUnique is set to false.
• The prerequisites section of the "Generating an EMF Model Using XML Schema" tutorial has been updated to include a link to the XSD Downloads page. (Bugzilla 38217)

There are some bug fixes and improvements included with this build, some of which are described below.

• The value of FEEDBACK_INSERT_AFTER has been changed in the org.eclipse.emf.edit.command.DragAndDropFeedback.java class as a reault of changes in the SWT constants.
• When JETEmitter creates the .JETEmitters project, it now checks for the existence of the "src" and "runtime" folders before trying to create them. (Bugzilla 38238)
• The org.eclipse.emf.codegen.CodeGenPlugin.java class has been changed to be an EMFPlugin so that exceptions can be easily logged. (Bugzilla 38087)
• <package prefix=...> elements have been addded to the plugin.xml files for all the EMF and XSD plugins. (Bugzilla 38225)
• As per the newsgroup discussion, the following two constructors have been added in the org.eclipse.emf.common.ui.celleditor.ExtendedComboBoxEditor.java class:
  • public ExtendedComboBoxCellEditor(Composite composite, List list, ILabelIProvider labelProvider, int style)
  • public ExtendedComboBoxCellEditor(Composite composite, List list, ILabelProvider labelProvider, boolean sorted, int style)
  The existing constructors have been updated to call these with the default value for the style argument set to use SWT.READ_ONLY.

This build is a refresh of EMF being delivered with the corresponding build of XSD.

1. Eclipse 2.1 based

   The EMF 1.0.2 drivers will only work well with Eclipse 2.1. They should work with 2.0.2, but they won't get the CLASSPATH correct for .editor projects. Sorry.

• EcoreUtil.Copier.copyContainment's first argument has changed from EStructuralFeature to EReference.
• New icons for EMF.Edit, Ecore, and GenModel.
• Bug fixes...

• Eliminated unneeded imports in generated files
• Performance improvement in eNotify() method
• Performance improvement in Dynamic EMF - array instead of Map based implementation
• Bug fixes...

• Bug fixes...

• Doc fixes...

1. 1.0.0 Incompatibility

   EMF 1.0.1 uses classpath variables in the java projects it creates. The generator also updates the classpath during generation (although this feature can be turned off via a genmodel property). The gist of this is that there can be conflicts with the bare jar classpath entries used in 1.0.0 projects and therefore, you need to delete old 1.0.0 classpath entries and then regenerate to create them correctly. Also, although plugin.property's merge correctly now (see below), plugin.xml's do not. Because of this, you should delete old 1.0.0 plugin.xml's and regenerate them for 1.0.1. We also recommend deleting 1.0.0 genmodels, and recreating them in 1.0.1, because they now support proper reload with persistent genmodel settings, while the 1.0.0 versions do not.

2. Documentation Plugin

   There is now a documentation plugin, org.eclipse.emf.doc, included in the download. All the EMF documentation is now available from the desktop Help menu. We've put the documentation plugin into the Runtime zip file, so its download size has increased by more than 2M. We're thinking about moving it into the Source zip, or maybe into its own zip file, in the future. If you have an opinion, please feel free to post it to the emf newsgroup.

3. Bug Fixes
   • Importing a Rose model with nested packages, where the parent package(s) have no classes in them, caused the generator to ignore (not generate) all of the classes in the nested package(s).
   • If you imported annotated Java classes that were in the default Java package (i.e., no explicit package), the importer crashed and produced an empty editor window. Now it produces an error message instead.
   • Java @model annotations no longer need to be on a line by themselves in the comment. The importer will recognize @model followed by 0 or more name=value pairs, anywhere in the comment. This fixes a problem several people were having with the tutorial, whereby the import from annotation wasn't finding any classes because of the formatting of the comments.
   • Other minor bug fixes. Details available upon request.
4. Generator Enhancements
   • The Ecore Model Project wizard now lets you create a genmodel from an Ecore XMI file. In 1.0.0 it was only possible to create a genmodel from a Rose model or annotated Java files.
   • You can now reload a genmodel from any source, not just from Rose. The "Reload from Rose" menu item is now just "Reload...".
   • Added the ability to control whether you want the edit and editor code to be generated into their own plugin/project or not. In 1.0.0, you had no choice but to generate the edit and editor components into separate plugins.
   • Added more flexibility in the EMF.Edit generation. You can now choose (by setting properties in the genmodel editor) which classes to generate item providers for. In 1.0.0, you were forced to have one for every class. Also, which features should be properties and which should generate notification, is now user controllable.
   • The generator now merges plugin.properties as well as Java files. In 1.0.0, if you regenerated an edit or editor plugin, it would not change or overwrite an existing plugin.properties file. If the model had new properties, you needed to manually add them, or delete the old plugin.properties file before regenerating. Plugin.xml's still need to be deleted if you want to regenerate them.
5. Added a basic EMF-generated Ecore model editor

   You can use it, instead of the text editor, to view or edit ".ecore" model files. Of course, once we have nice graphical Ecore editors, this won't be nearly as interesting.

6. Technology Preview - Import model from XML Schema

   In EMF 1.0.1 you can import your ecore model from an XML Schema, in addition to Rose or annotated Java. To enable this support, you need to download and install the XML Schema Project plugins first. Here is library.xsd, the Library model expressed in XML Schema. To use it, run the Ecore Model Project wizard and choose "Load from XML Schema" when prompted. This is documented in this tutorial. Give it a try.

   One very important difference (advantage) to using XML Schema to define the model is that, in addition to the default XMI, instances of the model will (not currently, but in the coming weeks) be serializable according to the Schema.

   Another interesting observation is that the "Book.author" and "Writer.books" reference types, and the fact that they are opposite ends of a bidirectional association, are not expressed in the XML Schema. Consequently, the generator will simply treat them as two independent one-way references of type EObject. We're looking into ways of annotating the schema (similar to the Java annotation approach) with the missing information. If you have any ideas or suggestions, please feel free to post them to the emf newsgroup.

   Note: This support is very preliminary and highly subject to change. It is meant to demonstrate the concepts and works well only with simple schemas.

7. Proposal to add annotations to Ecore model objects

   Class EAnnotation has been added to the Ecore model as a proposed design for supporting annotations which follows closely the design of the XML Schema model's XSDAnnotation. The current design uses a <<0..*>> details : String, which we recognize is unacceptably limiting and plan to change it, probably to a Map, once we've worked out the details of serialization support for a Map. We would like to solicit feedback on the EAnnotation design. It will definitely change before the design is committed to a Release Build. For example, adding a black diamond relation from EAnnotation to EObject would make it essentially identical in function to XSDAnnotation; it would mean that no one would ever have to extend EAnnotation in order to add annotations and it would ensure that the arbitrary EObjects are well separated and have a well managed lifetime relative to that which they annotate.

• Generated code is now formatted according to the project (Java Code Formatter) preferences.
• EMF.Edit (e.g., item providers) can now be used in stand-alone applications (see FAQ for details).
• More XML Schema Technology preview. Along with the Java classes, an XML Schema can now be generated for an Ecore model. This is the opposite of the import from Schema support (described above).
• EAnnotation design (described above) has been completed.
• Added support for map (i.e., EMap) type attributes. See EAnnotation (attribute "details") for an example.
• Some XMI and XML Resource implementation restructuring.
• Added simple logging support. There is now a log() method callable on generated Plugin classes.
• More minor bug fixes and cleanup...

• Code is now compiled with debug information (-g).
• Source plugin is now properly structured for Eclipse development.
• Support Empty EMF project creation.
• New reflective item provider and editor.
• Second tutorial added to documentation plugin.
• Added reconcile() method on GenModel.
• More minor bug fixes...

• Generated editors now include property editing for multi-valued features.
• More bug fixes...

• Unsettable reference support. The unsettable feature has been moved from EAttribute to EStructuralFeature.
• More bug fixes...
• This is the candiate 1.0.1 "release" build. If no problems are encountered we will publish this build as the "Latest Release" and then start dropping 1.0.2 builds (which will be based on Eclipse 2.1).
• The online JavaDoc (and Ecore class diagram) has been updated to reflect this build (i.e., the latest release).