Generator

ilog.rules.studio.res.generator

JRules 6.0

Allows plug-ins to declare a new generator for the New Client Project for RuleApps or Artifacts for RuleApps wizards.

<!ELEMENT extension (generator* | category* | primaryGenerator*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - A fully qualified identifier of the target extension point.
id - An optional identifier of the extension instance.
name - An optional name of the extension instance.

<!ELEMENT generator EMPTY>

<!ATTLIST generator

name CDATA #REQUIRED

id CDATA #REQUIRED

description CDATA #REQUIRED

enabled (true | false)

class CDATA #REQUIRED

wizardClass CDATA #IMPLIED

pageId CDATA #REQUIRED

creationWizardClass CDATA #IMPLIED

creationWizardPlugin CDATA #IMPLIED

completionWizardClass CDATA #IMPLIED

completionWizardPlugin CDATA #IMPLIED

category CDATA #IMPLIED>

name - The name of the generator as it appears in the New Client Project for RuleApps wizard.
id - A unique ID in Eclipse for the generator.
description - The description of the generator that as it appears in the New Client Project for RuleApps wizard.
enabled - If set to true, the generator appears in the list of generators in the New Client Project for RuleApps wizard.
class - The class that extends the IlrFileGenerator class.
wizardClass - The class that extends the IWizard class to define the pages displayed in the New Client Project for RuleApps wizard according to the selected generator.
pageId - The value must be: ilog.rules.studio.res.generator.generatorChooserPage or ilog.rules.studio.res.generator.generatorChooserPage.create or ilog.rules.studio.res.generator.generatorChooserPage.complete.
creationWizardClass - The class that extends the IWizard class to define the pages displayed in the New Client Project for RuleApps wizard according to the selected generator. Since JRules 6.5
creationWizardPlugin - The class that extends the IWizard class to define the pages displayed in the New Client Project for RuleApps wizard according to the selected generator. Since JRules 6.5
completionWizardClass - The class that extends the IWizard class to define the pages displayed in the New Artifacts for RuleApps wizard according to the selected generator. Since JRules 6.5
completionWizardPlugin - The class that extends the IWizard class to define the pages displayed in the New Artifacts for RuleApps wizard according to the selected generator. Since JRules 6.5
category - a slash-delimited path ('/') of category IDs. Each token in the path must represent a valid category ID previously defined by this or some other plug-in. If omitted, the wizard will be added to the "Other" category. Since JRules 6.5

<!ELEMENT category EMPTY>

<!ATTLIST category

id CDATA #REQUIRED

name CDATA #REQUIRED

parentCategory CDATA #IMPLIED

pageId CDATA #REQUIRED>

since JRules 6.5

id - a unique name that can be used to identify this category
name - a translatable name of the category that will be used in the wizard page
parentCategory - a path to another category if this category should be added as a child
pageId - The value must be: ilog.rules.studio.res.generator.generatorChooserPage or ilog.rules.studio.res.generator.generatorChooserPage.create or ilog.rules.studio.res.generator.generatorChooserPage.complete.

<!ELEMENT primaryGenerator EMPTY>

<!ATTLIST primaryGenerator

id CDATA #REQUIRED

pageId CDATA #REQUIRED>

since JRules 6.5

id - the id of a generator that should be made primary.
pageId - The value must be: ilog.rules.studio.res.generator.generatorChooserPage or ilog.rules.studio.res.generator.generatorChooserPage.create or ilog.rules.studio.res.generator.generatorChooserPage.complete.

The following examples show how to declare a generator which will appear in the 'Other' category.

<extension point=
"ilog.rules.studio.res.generator"
> 
     <generator 
            class=
"ilog.rules.studio.res.generator.impl.IlrPOJOGenerator"

            wizardClass=
"ilog.rules.studio.res.ui.generator.impl.IlrPOJOGeneratorWizard"

            name=
"MyGenerator"

            enabled=
"true"

            description=
"Generate a java project with my own classes"

            pageId=
"ilog.rules.studio.res.generator.generatorChooserPage"

            id=
"myplugin.MyGenerator"
>
     </generator>
</extension>

The following example show how to declare a generator which will appear in the 'My Category' category.

<extension point=
"ilog.rules.studio.res.generator"
>  
     <category id=
"mycategory"

             name=
"My Category"

             pageId=
"ilog.rules.studio.res.generator.generatorChooserPage"
 /> 
     <generator 
            class=
"ilog.rules.studio.res.generator.impl.IlrPOJOGenerator"

            wizardClass=
"ilog.rules.studio.res.ui.generator.impl.IlrPOJOGeneratorWizard"

            name=
"MyGenerator"

            enabled=
"true"

            description=
"Generate a java project with my own classes"

            pageId=
"ilog.rules.studio.res.generator.generatorChooserPage"

            id=
"myplugin.MyGenerator"

            category=
"mycategory"
 >
     </generator>
</extension>

The following example show how to declare a generator which will appear in the 'My Sub Category' category in the 'My Category' category.

<extension point=
"ilog.rules.studio.res.generator"
>  
     <category id=
"mycategory"

             name=
"My Category"

             pageId=
"ilog.rules.studio.res.generator.generatorChooserPage"
 />   
     <category id=
"mysubcategory"

             name=
"My Sub Category"

             pageId=
"ilog.rules.studio.res.generator.generatorChooserPage"

             parentCategory=
"mycategory"
 /> 
     <generator 
            class=
"ilog.rules.studio.res.generator.impl.IlrPOJOGenerator"

            wizardClass=
"ilog.rules.studio.res.ui.generator.impl.IlrPOJOGeneratorWizard"

            name=
"MyGenerator"

            enabled=
"true"

            description=
"Generate a java project with my own classes"

            pageId=
"ilog.rules.studio.res.generator.generatorChooserPage"

            id=
"myplugin.MyGenerator"

            category=
"mycategory/mysubcategory"
 >
     </generator>
</extension>

If you want your generator to be visible outside the categories as a primary generator, add the following :

<extension point=
"ilog.rules.studio.res.generator"
>  
     ... 
     <primaryGenerator id=
"myplugin.MyGenerator"
/>
     ... 
</extension>

The class named in the class property must implement the ilog.rules.studio.res.generator.IlrFileGenerator interface.

The platform uses this mechanism to add a generator in the proposed list of generators in the New Client Project for RuleApp or Artifacts for RuleApps wizards.

Generator

Identifier:

Since:

Description:

Configuration Markup:

Examples:

API Information:

Supplied Implementation: