Package org.apache.hop.workflow.actions.dummy

Class ActionDummy

java.lang.Object

org.apache.hop.workflow.action.ActionBase

org.apache.hop.workflow.actions.dummy.ActionDummy

All Implemented Interfaces:

Cloneable, IAttributes, ICheckResultSource, IExtensionData, IHasLogChannel, ILoggingObject, IVariables, IResourceHolder, IAction

@Action(id="DUMMY",
        image="ui/images/dummy.svg",
        name="i18n::ActionDummy.Name",
        description="i18n::ActionDummy.Description",
        categoryDescription="i18n:org.apache.hop.workflow:ActionCategory.Category.General",
        keywords="i18n::ActionDummy.keyword",
        documentationUrl="/workflow/actions/dummy.html")
public class ActionDummy
extends ActionBase
implements IAction

Field Summary

Fields inherited from class org.apache.hop.workflow.action.ActionBase

attributesMap, containerObjectId, entryTransformSetVariablesMap, extensionDataMap, log, parentWorkflow, parentWorkflowMeta

Constructor Summary

Constructors

Constructor	Description
ActionDummy()
ActionDummy(String name)

Method Summary

Modifier and Type	Method	Description
void	check(List<ICheckResult> remarks, WorkflowMeta workflowMeta, IVariables variables, IHopMetadataProvider metadataProvider)	Allows Action objects to check themselves for consistency
Result	execute(Result prevResult, int nr)	Execute the action.
String	getXml()	This method is called by Hop whenever a action needs to serialize its settings to XML.
void	loadXml(Node actionNode, IHopMetadataProvider metadataProvider, IVariables variables)	This method is called by Apache Hop whenever a action needs to read its settings from XML.

Methods inherited from class org.apache.hop.workflow.action.ActionBase

clear, clone, copyFrom, equals, exportResources, getAttribute, getAttributes, getAttributesMap, getContainerId, getDescription, getDialogClassName, getEntryTransformSetVariable, getEntryTransformSetVariablesMap, getExtensionDataMap, getFilename, getLogChannel, getLogChannelId, getLogLevel, getMetadataProvider, getName, getObjectCopy, getObjectName, getObjectType, getParent, getParentVariables, getParentWorkflow, getParentWorkflowMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getResourceDependencies, getSqlStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariableBoolean, getVariableNames, getVariables, hasChanged, hashCode, initializeFrom, isBasic, isDebug, isDetailed, isEvaluation, isForcingSeparateLogging, isGatheringMetrics, isPipeline, isReferencedObjectEnabled, isRowlevel, isStart, isUnconditional, isWorkflow, loadReferencedObject, loadXml, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, resetErrorsBeforeExecution, resolve, resolve, resolve, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setEntryTransformSetVariable, setForcingSeparateLogging, setGatheringMetrics, setLogLevel, setMetadataProvider, setName, setParentVariables, setParentWorkflow, setParentWorkflowMeta, setPluginId, setVariable, setVariables, shareWith, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hop.workflow.action.IAction

clear, clone, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getParentWorkflow, getParentWorkflowMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getResourceDependencies, getSqlStatements, hasChanged, isEvaluation, isPipeline, isReferencedObjectEnabled, isStart, isUnconditional, isWorkflow, loadReferencedObject, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setMetadataProvider, setName, setParentWorkflow, setParentWorkflowMeta, setPluginId

Methods inherited from interface org.apache.hop.core.IExtensionData

getExtensionDataMap

Methods inherited from interface org.apache.hop.core.variables.IVariables

copyFrom, getParentVariables, getVariable, getVariable, getVariableBoolean, getVariableNames, initializeFrom, resolve, resolve, resolve, setParentVariables, setVariable, setVariables, shareWith

Constructor Detail

ActionDummy

public ActionDummy()

ActionDummy

public ActionDummy(String name)

Method Detail

execute

public Result execute(Result prevResult,
                      int nr)
               throws HopException

Description copied from interface: IAction

Execute the action. The previous result and number of rows are provided to the method for the purpose of chaining actions, pipelines, etc.

Specified by:

execute in interface IAction

Parameters:

prevResult - the previous result

nr - the number of rows

Returns:

the Result object from execution of this action

Throws:

HopException - if any Hop exceptions occur

getXml

public String getXml()

Description copied from class: ActionBase

This method is called by Hop whenever a action needs to serialize its settings to XML. It is called when saving a workflow in HopGui. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.apache.hop.core.xml.XmlHandler is typically used to construct the XML string.

Specified by:

getXml in interface IAction

Overrides:

getXml in class ActionBase

Returns:

the xml representation of the action

loadXml

public void loadXml(Node actionNode,
                    IHopMetadataProvider metadataProvider,
                    IVariables variables)
             throws HopXmlException

Description copied from interface: IAction

This method is called by Apache Hop whenever a action needs to read its settings from XML. The XML node containing the action's settings is passed in as an argument. Again, the helper class org.apache.hop.core.xml.XmlHandler is typically used to conveniently read the settings from the XML node.

Specified by:

loadXml in interface IAction

Overrides:

loadXml in class ActionBase

Parameters:

actionNode - the top-level XML node

metadataProvider - The metadataProvider to optionally load from.

Throws:

HopXmlException - if any errors occur during the loading of the XML

check

public void check(List<ICheckResult> remarks,
                  WorkflowMeta workflowMeta,
                  IVariables variables,
                  IHopMetadataProvider metadataProvider)

Description copied from class: ActionBase

Allows Action objects to check themselves for consistency

Specified by:

check in interface IAction

Overrides:

check in class ActionBase

Parameters:

remarks - List of CheckResult objects indicating consistency status

workflowMeta - the metadata object for the action

variables - the variable variables to resolve string expressions with variables with

metadataProvider - the MetaStore to load common elements from