ch.sahits.codegen.model
Interface IJetGatewayConfiguration

All Known Implementing Classes:

Config

public interface IJetGatewayConfiguration

Configuration for a JET gateway

Since:

1.2.0

Author:

Andi Hotz, Sahits GmbH

Method Summary

java.lang.String	getClasspathVariable() Returns the classpath variable name to bind to the first jar in the plugin identified by getPluginId().
java.lang.Object	getModel() Returns the model object to pass to the JET template.
java.lang.String	getPackageName() Returns the package name of the resource to generate.
java.lang.String	getPluginId() Returns the plugin id of the plugin containing the JET template file, the JMerge control model XML file, and the runtime library JAR file containing any classes necessary to compile the translated JET template implementation class.
IProject	getProject()
java.lang.String	getTargetFile() Returns the file name of the file where the generated code should be saved.
java.lang.String	getTargetFolder() Returns the target folder (relative to the workspace root) where the generated code should be saved.
java.lang.String	getTemplateFullUri() Returns the full URI of the JET template.
java.lang.String	getTemplateRelativeUri() Returns the relative uri of the JET template file.
boolean	isBundledRecource() Check wether the requested Resource is in the bundle
boolean	isForceOverwrite() Returns whether existing read-only files should be overwritten.
java.util.List<java.lang.String>	plugInIDs() Retrieve an immutable list of plug-ins needed for the classpath

Method Detail

getModel

java.lang.Object getModel()

Returns the model object to pass to the JET template.

Returns:

the model object to pass to the JET template

getPluginId

java.lang.String getPluginId()

Returns the plugin id of the plugin containing the JET template file, the JMerge control model XML file, and the runtime library JAR file containing any classes necessary to compile the translated JET template implementation class.

Returns:

the plugin id

getTemplateRelativeUri

java.lang.String getTemplateRelativeUri()

Returns the relative uri of the JET template file.

Returns:

the relative uri of the JET template file

getTargetFolder

java.lang.String getTargetFolder()

Returns the target folder (relative to the workspace root) where the generated code should be saved.

Returns:

the target folder (relative to the workspace root) where the generated code should be saved

getPackageName

java.lang.String getPackageName()

Returns the package name of the resource to generate.

Returns:

the package name of the resource to generate

isForceOverwrite

boolean isForceOverwrite()

Returns whether existing read-only files should be overwritten. This method returns true by default.

Returns:

whether existing read-only files should be overwritten

getTemplateFullUri

java.lang.String getTemplateFullUri()

Returns the full URI of the JET template. This URI is found by appending the relative template URI to the installation URI of the plugin specified by the plugin id.

Returns:

the full URI of the JET template

getTargetFile

java.lang.String getTargetFile()

Returns the file name of the file where the generated code should be saved.

Returns:

the file name of the file where the generated code should be saved

getClasspathVariable

java.lang.String getClasspathVariable()

Returns the classpath variable name to bind to the first jar in the plugin identified by getPluginId().

Returns:

classpath variable name

getProject

IProject getProject()

Returns:

the mProject

isBundledRecource

boolean isBundledRecource()

Check wether the requested Resource is in the bundle

Returns:

the mBundledRecource

plugInIDs

java.util.List<java.lang.String> plugInIDs()

Retrieve an immutable list of plug-ins needed for the classpath

Returns:

List of plug-in IDs

Since:

1.2.0