com.microfocus.awm.internal.functionpackage.awm.tools

Class CreateStaticElementListToolExecutor

java.lang.Object

com.microfocus.awm.core.internal.util.AbstractConvertedToolExecutor

com.microfocus.awm.internal.functionpackage.awm.tools.CreateStaticElementListToolExecutor

All Implemented Interfaces:

IToolExecutor2

public class CreateStaticElementListToolExecutor
extends AbstractConvertedToolExecutor

A AWM tool which is used to create element lists by using the input of complex attributes. It parses all the input from the complex attributes defined in the model and returns them as a structured file descriptor.

Copyright Micro Focus GmbH.

Author:

NicolasP

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT Attribute extension ID of the panel fields complex attribute
static java.lang.String	MATCHNAME Attribute extension ID of the matchname attribute
static java.lang.String	PROPERTY Attribute extension ID of the property complex attribute
static java.lang.String	PROPERTY_VALUE Attribute extension ID of the property value attribute
static java.lang.String	TOOLTYPE_EXTENSION ToolType Extension ID of the CreateStaticElementListToolExecutor

Constructor Summary

Constructors

Constructor and Description
CreateStaticElementListToolExecutor()

Method Summary

Modifier and Type	Method and Description
IToolResult	executeMassProcessing(IMassProcessingToolContext pMassProcessingContext, org.eclipse.core.runtime.IProgressMonitor pMon) Executes the tool for multiple resource.
IToolResult	executeSingleProcessing(IToolContext pToolContext, org.eclipse.core.runtime.IProgressMonitor pMon) Executes the tool for a single resource.
boolean	supportsMassProcessing() Whether the tool executor supports mass processing execution.

Methods inherited from class com.microfocus.awm.core.internal.util.AbstractConvertedToolExecutor

createToolContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microfocus.awm.model.toolexecution.IToolExecutor2

init

Field Detail

TOOLTYPE_EXTENSION

public static final java.lang.String TOOLTYPE_EXTENSION

ToolType Extension ID of the CreateStaticElementListToolExecutor

See Also:

Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT

Attribute extension ID of the panel fields complex attribute

See Also:

Constant Field Values

MATCHNAME

public static final java.lang.String MATCHNAME

Attribute extension ID of the matchname attribute

See Also:

Constant Field Values

PROPERTY

public static final java.lang.String PROPERTY

Attribute extension ID of the property complex attribute

See Also:

Constant Field Values

PROPERTY_VALUE

public static final java.lang.String PROPERTY_VALUE

Attribute extension ID of the property value attribute

See Also:

Constant Field Values

Constructor Detail

CreateStaticElementListToolExecutor

public CreateStaticElementListToolExecutor()

Method Detail

executeSingleProcessing

public IToolResult executeSingleProcessing(IToolContext pToolContext,
                                           org.eclipse.core.runtime.IProgressMonitor pMon)
                                    throws TaurusToolException

Description copied from interface: IToolExecutor2

Executes the tool for a single resource.

A tool typically obtains values of modeled attributes and input parameters through the IToolContext (or ToolUtility helper methods), runs its specific function and returns all results (including possible output parameters) in the IToolResult.

This method gets called if the tool is being executed from an ActionDescriptor with the Mass Processing attribute set to false or if IToolExecutor2.supportsMassProcessing() returned false.

The tool context contains all parameters, since their Mass Processing flags are ignored during single processing execution.

Parameters:

pToolContext - the tool context

pMon - a progress monitor. Setting the monitor to canceled will cancel the action after the tool has been executed

Returns:

an IToolResult

Throws:

TaurusToolException - if the tool cannot be executed for any reason

See Also:

ToolUtility

executeMassProcessing

public IToolResult executeMassProcessing(IMassProcessingToolContext pMassProcessingContext,
                                         org.eclipse.core.runtime.IProgressMonitor pMon)
                                  throws TaurusToolException

Description copied from interface: IToolExecutor2

Executes the tool for multiple resource. In contrast to IToolExecutor2.executeSingleProcessing(IToolContext, IProgressMonitor) the tool executor can process multiple resources with a single call.

If the tool executor does not support mass processing execution (by returning false with IToolExecutor2.supportsMassProcessing()), this method will never by called by AWM and can simply return null.

The list of resources to be processed by the mass processing action can be obtained from the mass processing tool context via IMassProcessingToolContext.getSubContexts().

The IMassProcessingToolContext only contains parameters with the Mass Processing flag set to false. Mass processing parameters are contained by its sub-contexts.

Parameters:

pMassProcessingContext - the mass processing context

pMon - a progress monitor. Setting the monitor to canceled will cancel the action after the tool has been executed

Returns:

an IToolResult. Can be null if IToolExecutor2.supportsMassProcessing() returned false

Throws:

TaurusToolException - if the tool cannot be executed for any reason

See Also:

ToolUtility

supportsMassProcessing

public boolean supportsMassProcessing()

Description copied from interface: IToolExecutor2

Whether the tool executor supports mass processing execution. Returns true by default.

If false is returned, the tool executor cannot effectively process multiple resources (e.g. selected elements). This can be intended for tools not directly processing selected elements. In this case AWM will always call IToolExecutor2.executeSingleProcessing(IToolContext, IProgressMonitor) and never IToolExecutor2.executeMassProcessing(IMassProcessingToolContext, IProgressMonitor).

If applicable, tool executors should always aim for implementing mass processing support, since it can increase their usability in AWM models.

Returns:

true if the tool supports mass processing, otherwise false