Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "EDT:How to move RBD app to EDT"

(Move code to an EDT project)
(edits)
Line 1: Line 1:
An EDT project has different layout with an RBD project, the best way to make RBD code working in EDT is to create a new EDT project and copy the code to it. There have also been some changes to the EGL language that may require you to change your RBD-developed code to be modified prior to running on EDT. 
+
An EDT project has a different layout than an RBD project. The best way to make RBD code work in EDT is to create a new EDT project and copy the code to it. There have also been some changes to the EGL language that may require you to change your RBD-developed code to be modified prior to running on EDT.   
  
== Move code to an EDT project ==
+
== Move code to an EDT project ==
  
 
#Create a new EDT project.  
 
#Create a new EDT project.  
##If the application contains RUI Handlers, choose either '''Web2.0 client application''' or '''Web 2.0 client application with service''' depends on whether the application contains services.  
+
##If the application contains RUI Handlers, choose either '''Web2.0 client application''' or '''Web 2.0 client application with service''' depending on whether the application contains services.  
##If the application contains only Programs and common code, choose '''Basic'''.
+
##If the application contains only Programs and common code, choose '''Basic'''.  
#Copy EGL files and packages from the RBD project to the EDT project
+
#Copy EGL files and packages from the RBD project to the EDT project.
#Configure EGL Compiler and generators. Compiler setting is a new feature in EDT which allows setting of different generators for each package or file. The only chice
+
#Configure the EGL Compiler and generators. The Compiler setting is a new feature in EDT which allows specifying generators for each package or file.  
##Select JavaScript Generator for Rich UI Handlers, Widgets and any common parts(Record, Library) which are referenced by Rich UI Handlers or Widgets
+
##Select JavaScript Generator for Rich UI Handlers, Widgets and any common parts (Record, Library) which are referenced by Rich UI Handlers or Widgets.
##Select Java Generator for Services, Programs and any common parts referenced by Services or Programs
+
##Select Java Generator for Services, Programs and any common parts referenced by Services or Programs.
##Common parts require both JavaScript Generator and Java Generator are suggest to be put into a separate package which is configured with both Generators
+
##Common parts that require both JavaScript Generator and Java Generator should be put into a separate package configured with both Generators.
##Compiler setting of a parent resource is inherited by the children. Setting the package is usually good enough.
+
##The compiler setting of a parent resource is inherited by the children, so setting at the package level is usually good enough.
##Refactor package and code is sometimes necessary
+
##Refactoring packages and code is sometimes necessary.
  
 
== Modify EGL code  ==
 
== Modify EGL code  ==
 +
 
#Use Organize Imports (Ctrl+Shift+O) to let EDT import the correct widgets and system parts. This is needed for almost all EGL files because of the package name changes.  
 
#Use Organize Imports (Ctrl+Shift+O) to let EDT import the correct widgets and system parts. This is needed for almost all EGL files because of the package name changes.  
#Below is a handy list of things to modify. It is recorded when we move RBD samples and test apps to EDT. See the [http://wiki.eclipse.org/EDT:EGL_Language_conversion EGL Language conversion page] for more information about updates to EGL. The [http://wiki.eclipse.org/EDT:Code_snippets Code snippets page] is also a good place to find code.  
+
#Below is a handy list of things to modify. It is recorded when we moved RBD samples and test apps to EDT. See the [http://wiki.eclipse.org/EDT:EGL_Language_conversion EGL Language conversion page] for more information about updates to EGL. The [http://wiki.eclipse.org/EDT:Code_snippets Code snippets page] is also a good place to find code.
  
 
{| class="wikitable"
 
{| class="wikitable"
! style="width: 35%" | RBD
 
! style="width: 35%" | EDT
 
|Comments
 
 
|-
 
|-
|<source lang="java">
+
! bgcolor="#bbbbb" align="center" style="width: 35%" | RBD
 +
! bgcolor="#bbbbb" align="center" style="width: 35%" | EDT
 +
! bgcolor="#bbbbb" align="center" | Comments
 +
|-
 +
| <source lang="java">
 
employeeList Employee[0];
 
employeeList Employee[0];
</source>
+
</source>  
|<source lang="java">
+
| <source lang="java">
 
employeeList Employee[];
 
employeeList Employee[];
</source>
+
</source>  
|Dimension is not allowed on Array declaration, change to [ ].  
+
| Dimension is not allowed on an Array declaration, change to [ ].
 
|-
 
|-
|<source lang="java">
+
|-
 +
| <source lang="java">
 
program MyProgram type BasicProgram {}
 
program MyProgram type BasicProgram {}
 
library MyLibrary type BasicLibrary {}
 
library MyLibrary type BasicLibrary {}
 
record recordName type BasicRecord
 
record recordName type BasicRecord
</source>
+
</source>  
|<source lang="java">
+
| <source lang="java">
 
program MyProgram
 
program MyProgram
 
record recordName
 
record recordName
 
library MyLibrary
 
library MyLibrary
</source>
+
</source>  
|Basic stereotypes including BasicLibrary, BasicProgram, BasicRecord are removed. A part without stereotype is the basic type  
+
| Basic stereotypes including BasicLibrary, BasicProgram, BasicRecord are removed. A part without stereotype is the basic type.
 
|-
 
|-
|<source lang="java">
+
| <source lang="java">
 
myService1 MyService {@DedicatedService};
 
myService1 MyService {@DedicatedService};
</source>
+
</source>  
|<source lang="java">
+
| <source lang="java">
 
myService1 MyService?{@DedicatedService};
 
myService1 MyService?{@DedicatedService};
</source>
+
</source>  
|Service-access variable has to be defined as nullable with a ?
+
| Service-access variable has to be defined as nullable with a&nbsp;?
 
|-
 
|-
|<source lang="java">
+
| <source lang="java">
 
myService1 MyService {@bindService{bindingKey = "abc"}};
 
myService1 MyService {@bindService{bindingKey = "abc"}};
</source>
+
</source>  
|<source lang="java">
+
| <source lang="java">
 
myService1 MyService?{@Resource {bindingKey = "abc"}};
 
myService1 MyService?{@Resource {bindingKey = "abc"}};
  
Line 61: Line 64:
 
myService1 MyService?;
 
myService1 MyService?;
 
myService1 = SysLib.getResource("abc");
 
myService1 = SysLib.getResource("abc");
</source>
+
</source>  
|@Resource annotation is new in EDT. Search "resource annotation" in help for the details.
+
| The @Resource annotation is new in EDT. For details, search the Help for "resource annotation".
 
|-
 
|-
|<source lang="java">
+
| <source lang="java">
 
writeStderr("hello world!");
 
writeStderr("hello world!");
</source>
+
</source>  
|<source lang="java">
+
| <source lang="java">
 
Syslib.writeStderr("hello world!");
 
Syslib.writeStderr("hello world!");
</source>
+
</source>  
|all needs to be fully qualified with library name i.e. sysLib, dateTimeLib, serviceLib, xmlLib...etc.
+
| All needs to be fully qualified with library name i.e. sysLib, dateTimeLib, serviceLib, xmlLib...etc.
 
|-
 
|-
|<source lang="java">
+
| <source lang="java">
 
Record Attendee {
 
Record Attendee {
 
XMLStructure = XMLStructureKind.simpleContent}
 
XMLStructure = XMLStructureKind.simpleContent}
Line 80: Line 83:
  
 
target String{@JavaScriptProperty {}};
 
target String{@JavaScriptProperty {}};
</source>
+
</source>  
|<source lang="java">
+
| <source lang="java">
 
Record Attendee {@XMLValue {
 
Record Attendee {@XMLValue {
 
kind = XMLStructureKind.simpleContent}}
 
kind = XMLStructureKind.simpleContent}}
Line 89: Line 92:
  
 
target String{@Property {}};
 
target String{@Property {}};
</source>
+
</source>  
| See [http://wiki.eclipse.org/EDT:EGL_Language_conversion EGL Language conversion page] for more annotation changes.
+
| See the [[EDT:EGL_Language_conversion | EGL Language conversion page]] for more annotation changes.
 
|-
 
|-
|<source lang="java">
+
| <source lang="java">
 
egl.defineWidget('utils', 'QueryUtils',  
 
egl.defineWidget('utils', 'QueryUtils',  
 
'egl.ui.rui', 'Widget',  
 
'egl.ui.rui', 'Widget',  
</source>
+
</source>  
|<source lang="java">
+
| <source lang="java">
 
egl.defineWidget('utils', 'QueryUtils',  
 
egl.defineWidget('utils', 'QueryUtils',  
 
'eglx.ui.rui', 'Widget',  
 
'eglx.ui.rui', 'Widget',  
</source>
+
</source>  
| EGL Widget package is changed from '''egl.ui.rui''' to '''eglx.ui.rui''', make corresponding changes when define custom widgets with JS.
+
| EGL Widget package is changed from '''egl.ui.rui''' to '''eglx.ui.rui''', make corresponding changes when defining custom widgets with JS.
|-
+
|}
 
+
 
+
 
+
 
+
 
+
 
+
  
 
[[Category:EDT]]
 
[[Category:EDT]]

Revision as of 21:55, 30 November 2011

An EDT project has a different layout than an RBD project. The best way to make RBD code work in EDT is to create a new EDT project and copy the code to it. There have also been some changes to the EGL language that may require you to change your RBD-developed code to be modified prior to running on EDT. 

Move code to an EDT project

  1. Create a new EDT project.
    1. If the application contains RUI Handlers, choose either Web2.0 client application or Web 2.0 client application with service depending on whether the application contains services.
    2. If the application contains only Programs and common code, choose Basic.
  2. Copy EGL files and packages from the RBD project to the EDT project.
  3. Configure the EGL Compiler and generators. The Compiler setting is a new feature in EDT which allows specifying generators for each package or file.
    1. Select JavaScript Generator for Rich UI Handlers, Widgets and any common parts (Record, Library) which are referenced by Rich UI Handlers or Widgets.
    2. Select Java Generator for Services, Programs and any common parts referenced by Services or Programs.
    3. Common parts that require both JavaScript Generator and Java Generator should be put into a separate package configured with both Generators.
    4. The compiler setting of a parent resource is inherited by the children, so setting at the package level is usually good enough.
    5. Refactoring packages and code is sometimes necessary.

Modify EGL code

  1. Use Organize Imports (Ctrl+Shift+O) to let EDT import the correct widgets and system parts. This is needed for almost all EGL files because of the package name changes.
  2. Below is a handy list of things to modify. It is recorded when we moved RBD samples and test apps to EDT. See the EGL Language conversion page for more information about updates to EGL. The Code snippets page is also a good place to find code.
RBD EDT Comments
employeeList Employee[0];
employeeList Employee[];
Dimension is not allowed on an Array declaration, change to [ ].
program MyProgram type BasicProgram {}
library MyLibrary type BasicLibrary {}
record recordName type BasicRecord
program MyProgram
record recordName
library MyLibrary
Basic stereotypes including BasicLibrary, BasicProgram, BasicRecord are removed. A part without stereotype is the basic type.
myService1 MyService {@DedicatedService};
myService1 MyService?{@DedicatedService};
Service-access variable has to be defined as nullable with a ?
myService1 MyService {@bindService{bindingKey = "abc"}};
myService1 MyService?{@Resource {bindingKey = "abc"}};
 
or 
 
myService1 MyService?;
myService1 = SysLib.getResource("abc");
The @Resource annotation is new in EDT. For details, search the Help for "resource annotation".
writeStderr("hello world!");
Syslib.writeStderr("hello world!");
All needs to be fully qualified with library name i.e. sysLib, dateTimeLib, serviceLib, xmlLib...etc.
Record Attendee {
XMLStructure = XMLStructureKind.simpleContent}
 
ExternalType BrowserUtils ... {
javaScriptName = "BrowserUtils" ...}	
 
target String{@JavaScriptProperty {}};
Record Attendee {@XMLValue {
kind = XMLStructureKind.simpleContent}}
 
ExternalType BrowserUtils ... {
externalName= "BrowserUtils" ...}
 
target String{@Property {}};
See the EGL Language conversion page for more annotation changes.
egl.defineWidget('utils', 'QueryUtils', 
'egl.ui.rui', 'Widget',
egl.defineWidget('utils', 'QueryUtils', 
'eglx.ui.rui', 'Widget',
EGL Widget package is changed from egl.ui.rui to eglx.ui.rui, make corresponding changes when defining custom widgets with JS.

Back to the top