Skip navigation links

ilog.rules.studio.res.generator
Class IlrTraceFileGenerator

java.lang.Object
  ilog.rules.studio.res.generator.IlrFileGenerator
      ilog.rules.studio.res.generator.IlrVelocityGenerator
          ilog.rules.studio.res.generator.IlrTraceFileGenerator

All Implemented Interfaces:

org.eclipse.jface.wizard.IWizardNode

Direct Known Subclasses:

IlrPOJOGenerator

public class IlrTraceFileGenerator
extends IlrVelocityGenerator

Adds a generator to the generator list in the New Client Project for RuleApps wizard. This class extends IlrVelocityGenerator. It uses velocity to generate and manage the properties file, tracefilter.properties.

Since:

JRules 6.5

Nested Class Summary

Nested classes/interfaces inherited from class ilog.rules.studio.res.generator.IlrFileGenerator

IlrFileGenerator.Parameter, IlrFileGenerator.RuleApp, IlrFileGenerator.RulesetArchive

Field Summary

Fields inherited from class ilog.rules.studio.res.generator.IlrFileGenerator

contentCreated

Constructor Summary

IlrTraceFileGenerator()
Constructs a new IlrTraceFileGenerator instance.

Method Summary

void	generateProjectContent(org.eclipse.jdt.core.IJavaProject javaProject) Generates the Java project content.
String	getInfoAllRules() Tests if the boolean filter on all rules is set.
String	getInfoAllTasks() Tests the boolean filter on all tasks is set.
String	getInfoBoundObjectByRule() Tests if the boolean filter on the object bound by the rules fired before execution is set.
String	getInfoExecutionDate() Tests if the boolean filter on execution date is set.
String	getInfoExecutionDuration() Tests if the boolean filter on execution duration is set.
String	getInfoExecutionEvents() Tests if the boolean filter on the environment is set.
String	getInfoNumRulesFired() Tests the boolean filter on the number of rules fired is set.
String	getInfoNumRulesNotFired() Tests if the boolean filter on the number of rules not fired is set.
String	getInfoNumTasksExecuted() Tests the boolean filter on the number of tasks executed is set.
String	getInfoNumTasksNotExecuted() Tests if the boolean filter on the number of tasks not executed is set.
String	getInfoOutputParameters() Deprecated. As of JRules 7.0 this filter has been removed.
String	getInfoOutputString() Deprecated. As of JRules 7.0 this filter has been removed.
String	getInfoRulesFired() Deprecated. Since JRules 7.0, this filter is deleted.
String	getInfoRulesNotFired() Tests if the boolean filter on rules not fired is set.
String	getInfoSystemProperties() Tests if the boolean filter on the system properties is set.
String	getInfoTasksFired() Deprecated. As of JRules 7.0 this filter has been removed.
String	getInfoTasksNotExecuted() Tests if the boolean filter on tasks not executed is set.
String	getInfoWorkingMemory() Checks if the boolean filter on working memory is set.
protected String	getTemplateDirectory() As it not used in this class, the location, that is, the absolute path, which template paths are relative to is the empty string.
String	getWorkingMemoryFilter() Returns a comma separated list containing the classnames to include in the working memory filter.
protected org.apache.velocity.VelocityContext	initializeContext(Object userData, org.apache.velocity.VelocityContext context) Initializes a velocity context.
boolean	isGeneratedTraceFile() Tests if the trace file must be generated.
void	setGeneratedTraceFile(boolean generateTraceFile) Sets if the trace filter properties file must be generated.
void	setInfoAllRules(boolean infoAllRules) Sets the boolean filter on all rules.
void	setInfoAllTasks(boolean infoAllTasks) Sets the boolean filter on all tasks.
void	setInfoBoundObjectByRule(boolean infoBoundObjectByRule) Sets the boolean filter on the object bound by the rules fired before execution.
void	setInfoExecutionDate(boolean infoExecutionDate) Sets the boolean filter on execution date.
void	setInfoExecutionDuration(boolean infoExecutionDuration) Sets the boolean filter on execution duration.
void	setInfoExecutionEvents(boolean infoExecutionEvents) Sets the boolean filter on the environment.
void	setInfoNumRulesFired(boolean infoNumRulesFired) Sets the boolean filter on the number of rules fired.
void	setInfoNumRulesNotFired(boolean infoNumRulesNotFired) Sets the boolean filter on the number of rules not fired.
void	setInfoNumTasksExecuted(boolean infoNumTasksExecuted) Sets the boolean filter on the number of tasks executed.
void	setInfoNumTasksNotExecuted(boolean infoNumTasksNotExecuted) Sets the boolean filter on the number of tasks not executed.
void	setInfoOutputParameters(boolean infoOutputParameters) Deprecated. As of JRules 7.0 this filter has been removed.
void	setInfoOutputString(boolean infoOutputString) Deprecated. Since JRules 7.0, this filter is deleted.
void	setInfoRulesFired(boolean infoRulesFired) Deprecated. As of JRules 7.0 this filter has been removed.
void	setInfoRulesNotFired(boolean infoRulesNotFired) Sets the boolean filter on rules not fired.
void	setInfoSystemProperties(boolean infoSystemProperties) Sets the boolean filter on the system properties.
void	setInfoTasksFired(boolean infoTasksFired) Deprecated. As of JRules 7.0 this filter has been removed.
void	setInfoTasksNotExecuted(boolean infoTasksNotExecuted) Sets the boolean filter on the tasks not executed.
void	setInfoWorkingMemory(boolean infoWorkingMemory) Sets the boolean filter on working memory.
void	setWorkingMemoryFilter(String workingMemoryFilter) Sets the names of the classes to include in the working memory filter.

Methods inherited from class ilog.rules.studio.res.generator.IlrVelocityGenerator

generateVelocityFile, generateVelocityFile, generateVelocityFileInSrc, generateVelocityFileInSrc, getGeneratedExtension, getGeneratedFileName, getGeneratedName

Methods inherited from class ilog.rules.studio.res.generator.IlrFileGenerator

addContainerEntryInClasspath, addLibraryEntryInClasspath, addProjectEntryInClasspath, addVariableEntryInClasspath, changeInClassName, changeInMethodName, completeProjectFromTemplate, copyFile, createPackage, createProjectFromTemplate, generateLaunchConfigurationFile, generateProjectContent, generateProjectContent, generateProjectContent, getCompletionWizard, getCreationWizard, getExecutionServerHome, getInParameters, getInParameters, getInParameters, getInParameters, getInParametersImports, getInParametersImports, getJavaProject, getJavaProjectNameAsClassName, getLaunchConfigurationName, getNewParameter, getNewRulesetArchive, getNotAllowedDescription, getOutParameters, getOutParameters, getOutParametersImports, getParameters, getParameters, getParametersImports, getProject, getRuleAppProject, getRulesetArchives, getRulesetArchives, getRuleStudioHome, getSignatures, getUTF8CharsetAsString, getWizard, getXOMPath, initialize, isAllowed, isJavaProject, setJavaNature, setSignatures

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jface.wizard.IWizardNode

dispose, getExtent, isContentCreated

Constructor Detail

IlrTraceFileGenerator

public IlrTraceFileGenerator()

Constructs a new IlrTraceFileGenerator instance. Any class that extends this one must declare a public default constructor which calls this constructor. The default constructor is the only one that can be called to create a generator.

Since:

JRules 6.6

Method Detail

getTemplateDirectory

protected String getTemplateDirectory()

As it not used in this class, the location, that is, the absolute path, which template paths are relative to is the empty string.

Specified by:

getTemplateDirectory in class IlrVelocityGenerator

Returns:

An empty string.

generateProjectContent

public void generateProjectContent(org.eclipse.jdt.core.IJavaProject javaProject)

Generates the Java project content.

This default implementation creates a src directory in the Java project.

Overrides:

generateProjectContent in class IlrVelocityGenerator

Parameters:

javaProject - The destination of the Java project files.

See Also:

IlrFileGenerator.generateProjectContent(IJavaProject)

initializeContext

protected org.apache.velocity.VelocityContext initializeContext(Object userData,
                                                                org.apache.velocity.VelocityContext context)

Initializes a velocity context. This method is called when the velocity context is initialized by calling IlrVelocityGenerator.generateVelocityFile(String,String,String,String,String,Object) method. It retrieves the parameters to put in the velocity template.

Specified by:

initializeContext in class IlrVelocityGenerator

Parameters:

userData - The object specified in IlrVelocityGenerator.generateVelocityFile(String,String,String,String,String,Object).

context - The velocity context to fill.

Returns:

The filled velocity context.

See Also:

IlrVelocityGenerator.initializeContext(java.lang.Object, org.apache.velocity.VelocityContext)

getInfoAllRules

public String getInfoAllRules()

Tests if the boolean filter on all rules is set.

Since:

JRules 7.0

Returns:

If the boolean filter on all rules is set, the String value true is returned.

setInfoAllRules

public void setInfoAllRules(boolean infoAllRules)

Sets the boolean filter on all rules.

Since:

JRules 7.0

Parameters:

infoAllRules - Set to true to filter on all rules.

getInfoAllTasks

public String getInfoAllTasks()

Tests the boolean filter on all tasks is set.

Since:

JRules 7.0

Returns:

If the boolean filter on all tasks is set, the String value true is returned.

setInfoAllTasks

public void setInfoAllTasks(boolean infoAllTasks)

Sets the boolean filter on all tasks.

Since:

JRules 7.0

Parameters:

infoAllTasks - Set to true to filter on all tasks.

getInfoExecutionEvents

public String getInfoExecutionEvents()

Tests if the boolean filter on the environment is set.

Since:

JRules 7.0

Returns:

If the boolean filter on the environment is set, the String value true is returned.

setInfoExecutionEvents

public void setInfoExecutionEvents(boolean infoExecutionEvents)

Sets the boolean filter on the environment.

Since:

JRules 7.0

Parameters:

infoExecutionEvents - Set to true to filter on the environment.

getInfoExecutionDate

public String getInfoExecutionDate()

Tests if the boolean filter on execution date is set.

Since:

7.5

Returns:

If the boolean filter on execution duration is set the String value true is returned.

setInfoExecutionDate

public void setInfoExecutionDate(boolean infoExecutionDate)

Sets the boolean filter on execution date.

Since:

7.5

Parameters:

infoExecutionDate - Set to true to filter on execution duration.

getInfoExecutionDuration

public String getInfoExecutionDuration()

Tests if the boolean filter on execution duration is set.

Since:

JRules 7.0

Returns:

If the boolean filter on execution duration is set the String value true is returned.

setInfoExecutionDuration

public void setInfoExecutionDuration(boolean infoExecutionDuration)

Sets the boolean filter on execution duration.

Since:

JRules 7.0

Parameters:

infoExecutionDuration - Set to true to filter on execution duration.

getInfoNumRulesFired

public String getInfoNumRulesFired()

Tests the boolean filter on the number of rules fired is set.

Returns:

If the boolean filter on the number of rules fired is set, the String value true is returned.

setInfoNumRulesFired

public void setInfoNumRulesFired(boolean infoNumRulesFired)

Sets the boolean filter on the number of rules fired.

Parameters:

infoNumRulesFired - Set to true to filter the number of rules fired.

getInfoNumRulesNotFired

public String getInfoNumRulesNotFired()

Tests if the boolean filter on the number of rules not fired is set.

Returns:

If the boolean filter on the number of rules not fired is set, the String value true is returned.

setInfoNumRulesNotFired

public void setInfoNumRulesNotFired(boolean infoNumRulesNotFired)

Sets the boolean filter on the number of rules not fired.

Parameters:

infoNumRulesNotFired - Set to true to filter on the number of rules not fired.

getInfoNumTasksExecuted

public String getInfoNumTasksExecuted()

Tests the boolean filter on the number of tasks executed is set.

Returns:

If the boolean filter on the number of tasks executed is set, the String value true is returned.

setInfoNumTasksExecuted

public void setInfoNumTasksExecuted(boolean infoNumTasksExecuted)

Sets the boolean filter on the number of tasks executed.

Parameters:

infoNumTasksExecuted - Set to true to filter on the number of tasks executed.

getInfoNumTasksNotExecuted

public String getInfoNumTasksNotExecuted()

Tests if the boolean filter on the number of tasks not executed is set.

Returns:

If the boolean filter on the number of tasks not executed is set, the String value true is returned.

setInfoNumTasksNotExecuted

public void setInfoNumTasksNotExecuted(boolean infoNumTasksNotExecuted)

Sets the boolean filter on the number of tasks not executed.

Parameters:

infoNumTasksNotExecuted - Set to true to filter on on the number of tasks not executed.

getInfoOutputParameters

public String getInfoOutputParameters()

Deprecated. As of JRules 7.0 this filter has been removed.

Gets the boolean filter on the output parameter values.

Returns:

The boolean filter on the output parameter values.

setInfoOutputParameters

public void setInfoOutputParameters(boolean infoOutputParameters)

Deprecated. As of JRules 7.0 this filter has been removed.

Sets the boolean filter on the output parameter values.

getInfoOutputString

public String getInfoOutputString()

Deprecated. As of JRules 7.0 this filter has been removed.

Gets the boolean filter on the output String.

Returns:

The boolean filter on the output String.

setInfoOutputString

public void setInfoOutputString(boolean infoOutputString)

Deprecated. Since JRules 7.0, this filter is deleted.

Sets the boolean filter on the output String.

getInfoRulesFired

public String getInfoRulesFired()

Deprecated. Since JRules 7.0, this filter is deleted.

Gets the boolean filter on rules fired.

Returns:

The boolean filter on rules fired.

setInfoRulesFired

public void setInfoRulesFired(boolean infoRulesFired)

Deprecated. As of JRules 7.0 this filter has been removed.

Sets the boolean filter on rules fired.

getInfoRulesNotFired

public String getInfoRulesNotFired()

Tests if the boolean filter on rules not fired is set.

Returns:

If the boolean filter on rules not fired is set, the String value true is returned.

setInfoRulesNotFired

public void setInfoRulesNotFired(boolean infoRulesNotFired)

Sets the boolean filter on rules not fired.

Parameters:

infoRulesNotFired - Set to true to filter on the the rules not fired.

getInfoTasksFired

public String getInfoTasksFired()

Deprecated. As of JRules 7.0 this filter has been removed.

Gets the boolean filter on tasks executed.

Returns:

The boolean filter on tasks executed.

setInfoTasksFired

public void setInfoTasksFired(boolean infoTasksFired)

Deprecated. As of JRules 7.0 this filter has been removed.

Sets the boolean filter on tasks executed.

getInfoTasksNotExecuted

public String getInfoTasksNotExecuted()

Tests if the boolean filter on tasks not executed is set.

Returns:

If boolean filter on tasks not executed is set, the String value true is returned.

setInfoTasksNotExecuted

public void setInfoTasksNotExecuted(boolean infoTasksNotExecuted)

Sets the boolean filter on the tasks not executed.

Parameters:

infoTasksNotExecuted - Set to true to filter on the tasks not executed.

getInfoWorkingMemory

public String getInfoWorkingMemory()

Checks if the boolean filter on working memory is set.

Returns:

If the boolean filter on working memory is set, the String value true is returned.

setInfoWorkingMemory

public void setInfoWorkingMemory(boolean infoWorkingMemory)

Sets the boolean filter on working memory.

Parameters:

infoWorkingMemory - Set to true to filter on the working memeory.

getWorkingMemoryFilter

public String getWorkingMemoryFilter()

Returns a comma separated list containing the classnames to include in the working memory filter. The boolean filter on working memory must be set to true for this filter to be considered.

Returns:

A comma separated list of the classnames to include in the working memory filter.

setWorkingMemoryFilter

public void setWorkingMemoryFilter(String workingMemoryFilter)

Sets the names of the classes to include in the working memory filter. For this filter to work, setInfoWorkingMemory(boolean infoWorkingMemory) must be set to true.

Parameters:

workingMemoryFilter - A comma separated list containing the names of the classes to include in the working memory filter.

isGeneratedTraceFile

public boolean isGeneratedTraceFile()

Tests if the trace file must be generated.

Returns:

If the trace file must be generated, true is returned.

setGeneratedTraceFile

public void setGeneratedTraceFile(boolean generateTraceFile)

Sets if the trace filter properties file must be generated.

Parameters:

generateTraceFile - Set to true to generate the trace filters properties file.

getInfoBoundObjectByRule

public String getInfoBoundObjectByRule()

Tests if the boolean filter on the object bound by the rules fired before execution is set.

Returns:

If the boolean filter on the object bound by the rules fired before execution is set, the String value true is returned.

setInfoBoundObjectByRule

public void setInfoBoundObjectByRule(boolean infoBoundObjectByRule)

Sets the boolean filter on the object bound by the rules fired before execution.

Parameters:

infoBoundObjectByRule - Set to true to activate the filter.

getInfoSystemProperties

public String getInfoSystemProperties()

Tests if the boolean filter on the system properties is set.

Since:

JRules 7.0

Returns:

If the boolean filter on the system properties is set, the String value true is returned.

setInfoSystemProperties

public void setInfoSystemProperties(boolean infoSystemProperties)

Sets the boolean filter on the system properties.

Since:

JRules 7.0

Parameters:

infoSystemProperties - Set to true to activate the filter.