How To Guide

From Skyway Wiki

Contents 1 Create a JET Project 2 Create a New Template 3 Replace the Old Template with the New Template 4 Launch a New Workspace With Your Changes

Create a JET Project

You don't have to use JET to generate your artifacts (source files, configuration files, etc). However, we've used JET for all of our core templates so these instructions assume you are using JET as well.

1. Create an EMFT JET Transformation Project call ReplaceArtifact. This is an Eclipse plug-in project that supports JET template development.
2. Open plugin.xml.
3. Click the Dependencies tab. Add these dependencies to your project (these represent a common set of dependencies you will likely need):
   1. org.eclipse.jet
   2. org.skyway.core
   3. org.eclipse.core.runtime
   4. org.skyway.integration.java
   5. org.eclipse.emf.ecore
   6. org.skyway.integration.java.spring
4. Click the Extensions tab. Expand the org.eclipse.jet.transform extension (this was added automatically when you created your EMFT JET Transformation Project). Expand the (transform) and (tagLibraries) nodes. Add the following two tag libraries:
   1. id:org.skyway.integration.java.skywayCodeGenTags, usePrefix:sw, autoImport:true
   2. id:org.skyway.integration.data.persistence.skywayPersistenceTags, usePrefix:persistence, autoImport:true

Create a New Template

1. Right click on the /templates folder and select New and File.
2. Type Exception.jet into the File name field and click Finish.
3. Paste the following code into the file and save.

<%@ jet 
package="org.skyway.deploy.templates" 
class="NewExceptionTemplate" 
%>
<%@taglib id="org.eclipse.jet.javaTags" prefix="java"%>
<%@taglib prefix="ws" id="org.eclipse.jet.workspaceTags"%>
<%@taglib prefix="c" id="org.eclipse.jet.controlTags"%>
<%@taglib prefix="sw" id="org.skyway.integration.java.skywayCodeGenTags"%>

package <sw:package select="$model" var="pkg"/>;
<sw:javaType select="$model" package="true" var="fullyQualifiedClassName" emit="false"/>
<java:importsLocation package="{$pkg}"/>
<java:impliedImport name="{$fullyQualifiedClassName}"/>

/**
 * THIS IS MY OVERRIDDEN TEMPLATE!
 * <sw:documentation select="$model" />
 * @generated
 */
public class  <sw:javaType select="$model" /> extends <java:import>org.skyway.execution.exception.SkywayException</java:import> {
	private static final long serialVersionUID = 1L;
	
	/**
	* Default Constructor
 	* @generated
	*/
	public <sw:javaType select="$model" /> () {
		super();
	}
	
	/**
	* Constructor taking message
 	* @generated
	*/
	public <sw:javaType select="$model" /> (String message) {
		super (message);
	}
	
	/**
	* Constructor taking root cause
 	* @generated
	*/
	public <sw:javaType select="$model" /> (Throwable t) {
		super (t);
	}

	/**
	* Constructor taking message and root cause
 	* @generated
	*/
	public <sw:javaType select="$model" /> (String message, Throwable t) {
		super (message, t);
	}
}

Replace the Old Template with the New Template

1. Open plugin.xml (if not already open).
2. Click the Extensions tab.
3. Click the Add button.
4. Type jetArtifactDefinitionSet into the Extension Point filter field.
5. Select the org.skyway.core.jetArtifactDefinitionSet extension point and click Finish.
6. It should have added and selected a node for you. The node will have a name like ReplaceArtifact.set2 (set).
7. Enter org.skyway.integration.java.spring.artifactset into the id field. This is the id of the core Skyway artifact set that you are modifying.
8. Enter a 1 into the priority field. The priority of all core artifacts is 0, so anything greater than 0 will take precedence.
9. Click back on the ReplaceArtifact.set2 (set) node and you should notice it now has a different name based on what you typed into the id field.
10. Right click this node and select New and override.
11. It should have added and selected a node for you. The node will have a name like ReplaceArtifact.jetArtifactDefinition2 (jetArtifactDefinition).
12. Click the Browse button next to the template field and select the Exception.jet template that you just created.
13. Enter org.skyway.core.generation.java.JavaArtifactDefinition into the type field. This is the name of a class that implements IArtifactDefinition. JavaArtifactDefinition is a generic super class that defines how to generate a Java class.
14. Leave the destination field blank.
15. Click back on the ReplaceArtifact.jetArtifactDefinition2 (jetArtifactDefinition) node and you should notice it now has a different name based on what you typed into the template field.
16. Now click on its parent node. It should have a name like ReplaceArtifact.override3 (override).
17. Enter templates/Exception.jet into the originalTemplate field. This is the template that we are overriding.
18. Save your changes to plugin.xml.

Launch a New Workspace With Your Changes

1. Open the Run Dialog.
2. Right click Eclipse Application and select New.
3. On the Main tab under Program to Run select the Run a product radio and select the org.skyway.visualperspectives.product product.
4. Create a new Skyway Project called MyProject.
5. Add a Web Controller called MyController to this project.
6. Add an Exception called MyException to this controller.
7. Type Ctrl-Shift-T to open the Eclipse type chooser.
8. Type MyException and select the MyException class.
9. You should notice that the exception class was built using your template.