Skip navigation links

ilog.rules.studio.dvs.execution
Class IlrDVSLaunchConfigurationDelegate

java.lang.Object
  org.eclipse.debug.core.model.LaunchConfigurationDelegate
      org.eclipse.jdt.launching.AbstractJavaLaunchConfigurationDelegate
          ilog.rules.studio.dvs.execution.IlrDVSLaunchConfigurationDelegate

All Implemented Interfaces:

org.eclipse.debug.core.IDebugEventSetListener, org.eclipse.debug.core.model.ILaunchConfigurationDelegate, org.eclipse.debug.core.model.ILaunchConfigurationDelegate2

Direct Known Subclasses:

IlrDVSArchiveLaunchConfigurationDelegate, IlrExcelLaunchConfigurationDelegate

public abstract class IlrDVSLaunchConfigurationDelegate
extends org.eclipse.jdt.launching.AbstractJavaLaunchConfigurationDelegate

The abstract implementation of a DVS launch configuration delegate. This class provides convenience methods used to access and verify launch configuration attributes.

Subclass IlrDVSLaunchConfigurationDelegate when you implement a DVS launch configuration.

Since:

JRules 7.0

Field Summary

Fields inherited from class org.eclipse.debug.core.model.LaunchConfigurationDelegate

complileErrorProjectPromptStatus, complileErrorPromptStatus, promptStatus, saveScopedDirtyEditors, switchToDebugPromptStatus

Constructor Summary

IlrDVSLaunchConfigurationDelegate()

Method Summary

protected void	copyImagesForReport(String destFilePath) Copies the images that will be displayed in the HTML report.
protected String	generateRulesetArchive(String workingDir, String ruleprojectName, boolean useExtractor, String extractorName) Generates a ruleset archive from a rule project and an extractor.
protected String	getAbsolutePath(String fullpath) Returns the absolute path from a file path relative to the Eclipse workspace.
protected boolean	getValue(org.eclipse.debug.core.ILaunchConfiguration configuration, String attribute, boolean defaultValue) Reads the value of a configuration attribute.
protected String	getValue(org.eclipse.debug.core.ILaunchConfiguration configuration, String attribute, String defaultValue) Reads the value of a configuration attribute.
org.eclipse.jdt.launching.IVMRunner	getVMRunner(org.eclipse.debug.core.ILaunchConfiguration configuration, String mode) Returns the virtual machine runner used to launch a given configuration in a specific launch mode.
protected void	run(org.eclipse.debug.core.ILaunchConfiguration configuration, String mode, org.eclipse.debug.core.ILaunch launch, org.eclipse.core.runtime.IProgressMonitor monitor, String mainClass, String[] customParams) Runs the given DVS configuration in the specified mode, contributing debug targets and/or processes to the given launch object.

Methods inherited from class org.eclipse.jdt.launching.AbstractJavaLaunchConfigurationDelegate

abort, getBootpath, getBootpathExt, getBreakpoints, getBuildOrder, getClasspath, getDefaultWorkingDirectory, getEnvironment, getJavaLibraryPath, getJavaProject, getJavaProjectName, getLaunchManager, getMainTypeName, getProgramArguments, getProjectsForProblemSearch, getVMArguments, getVMConnectorId, getVMInstall, getVMInstallName, getVMInstallType, getVMInstallTypeId, getVMSpecificAttributesMap, getWorkingDirectory, getWorkingDirectoryPath, handleDebugEvents, isAllowTerminate, isLaunchProblem, isStopInMain, preLaunchCheck, prepareStopInMain, setDefaultSourceLocator, verifyJavaProject, verifyMainTypeName, verifyVMInstall, verifyWorkingDirectory

Methods inherited from class org.eclipse.debug.core.model.LaunchConfigurationDelegate

addReferencedProjects, buildForLaunch, buildProjects, computeBuildOrder, computeReferencedBuildOrder, existsProblems, finalLaunchCheck, getLaunch, saveBeforeLaunch

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.debug.core.model.ILaunchConfigurationDelegate

launch

Constructor Detail

IlrDVSLaunchConfigurationDelegate

public IlrDVSLaunchConfigurationDelegate()

Method Detail

getVMRunner

public org.eclipse.jdt.launching.IVMRunner getVMRunner(org.eclipse.debug.core.ILaunchConfiguration configuration,
                                                       String mode)
                                                throws org.eclipse.core.runtime.CoreException

Returns the virtual machine runner used to launch a given configuration in a specific launch mode. In debug mode, configure the runner to allow debugging in rules.

Overrides:

getVMRunner in class org.eclipse.jdt.launching.AbstractJavaLaunchConfigurationDelegate

Throws:

org.eclipse.core.runtime.CoreException - if the virtual machine runner cannot be found.

Parameters:

configuration - The launch configuration.

mode - The launch node.

Returns:

The virtual machine runner to use when launching configuration in mode.

generateRulesetArchive

protected String generateRulesetArchive(String workingDir,
                                        String ruleprojectName,
                                        boolean useExtractor,
                                        String extractorName)

Generates a ruleset archive from a rule project and an extractor. The ruleset archive is generated in workingDir.

Parameters:

workingDir - The absolute path to the directory in which the temporary ruleset archive will be generated.

ruleprojectName - The name of the rule project this ruleset archive is generated for.

useExtractor - Set to true if an extractor must be used when the ruleset archive is generated.

extractorName - The name of the extractor to use when useExtractor is set to true.

Returns:

The absolute path to the ruleset archive.

getAbsolutePath

protected String getAbsolutePath(String fullpath)
                          throws org.eclipse.core.runtime.CoreException

Returns the absolute path from a file path relative to the Eclipse workspace.

Throws:

org.eclipse.core.runtime.CoreException - if there is a problem generating the absolute file path.

Parameters:

fullpath - The file path relative to the workspace.

Returns:

The absolute path on the hard disk.

run

protected void run(org.eclipse.debug.core.ILaunchConfiguration configuration,
                   String mode,
                   org.eclipse.debug.core.ILaunch launch,
                   org.eclipse.core.runtime.IProgressMonitor monitor,
                   String mainClass,
                   String[] customParams)
            throws org.eclipse.core.runtime.CoreException

Runs the given DVS configuration in the specified mode, contributing debug targets and/or processes to the given launch object.

Throws:

org.eclipse.core.runtime.CoreException - if run fails.

Parameters:

configuration - The configuration to launch.

mode - The mode in which to launch, one of the mode constants defined by ILaunchManager - RUN_MODE or DEBUG_MODE.

launch - The launch object to contribute processes and debug targets to.

monitor - Progress monitor, or null progress monitor, or null. A cancelable progress monitor is provided by the Job framework. It should be noted that the setCanceled(boolean) method should never be called on the provided monitor or the monitor passed to any delegates from this method. Due to a limitation in the progress monitor framework, using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.

mainClass - The fully qualified name of the class to launch. May not be null.

customParams - The list of custom parameters.

getValue

protected String getValue(org.eclipse.debug.core.ILaunchConfiguration configuration,
                          String attribute,
                          String defaultValue)

Reads the value of a configuration attribute.

Parameters:

configuration - The configuration containing the attributes.

attribute - The attribute to read.

defaultValue - The value to return if attribute is not found.

Returns:

The value of attribute or defaultValue if attribute is not found.

getValue

protected boolean getValue(org.eclipse.debug.core.ILaunchConfiguration configuration,
                           String attribute,
                           boolean defaultValue)

Reads the value of a configuration attribute.

Parameters:

configuration - The configuration containing the attributes.

attribute - The attribute to read.

defaultValue - The value to return if attribute is not found.

Returns:

The value of attribute or defaultValue if attribute is not found.

copyImagesForReport

protected void copyImagesForReport(String destFilePath)

Copies the images that will be displayed in the HTML report.

Parameters:

destFilePath - The path where the report will be generated.