Package org.apache.hop.pipeline.config

Class PipelineRunConfiguration

java.lang.Object

org.apache.hop.metadata.api.HopMetadataBase

org.apache.hop.pipeline.config.PipelineRunConfiguration

All Implemented Interfaces:

Cloneable, IHopMetadata

public class PipelineRunConfiguration
extends HopMetadataBase
implements Cloneable, IHopMetadata

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	defaultSelection
protected String	executionDataProfileName	The name of an ExecutionDataProfile
static String	GUI_PLUGIN_ELEMENT_PARENT_ID

Fields inherited from class org.apache.hop.metadata.api.HopMetadataBase

metadataProviderName, name

Constructor Summary

Constructors

Constructor	Description
PipelineRunConfiguration()
PipelineRunConfiguration(String name, String description, String executionInfoLocationName, List<DescribedVariable> configurationVariables, IPipelineEngineRunConfiguration engineRunConfiguration, String executionDataProfileName, boolean defaultSelection)
PipelineRunConfiguration(PipelineRunConfiguration runConfiguration)

Method Summary

Modifier and Type	Method	Description
void	applyToVariables(IVariables variables)
static PipelineRunConfiguration	findDefault(IHopMetadataProvider metadataProvider)	Find the first default run configuration in the metadata and return it.
List<DescribedVariable>	getConfigurationVariables()	Gets configurationVariables
String	getDescription()	Gets description
IPipelineEngineRunConfiguration	getEngineRunConfiguration()	Gets engineRunConfiguration
String	getExecutionDataProfileName()	Gets executionDataProfileName
String	getExecutionInfoLocationName()	Gets executionInfoLocationName
boolean	isDefaultSelection()	Gets defaultSelection
void	setConfigurationVariables(List<DescribedVariable> configurationVariables)
void	setDefaultSelection(boolean defaultSelection)	Sets defaultSelection
void	setDescription(String description)
void	setEngineRunConfiguration(IPipelineEngineRunConfiguration engineRunConfiguration)
void	setExecutionDataProfileName(String executionDataProfileName)	Sets executionDataProfileName
void	setExecutionInfoLocationName(String executionInfoLocationName)	Sets executionInfoLocationName

Methods inherited from class org.apache.hop.metadata.api.HopMetadataBase

equals, getMetadataProviderName, getName, hashCode, setMetadataProviderName, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hop.metadata.api.IHopMetadata

getMetadataProviderName, getName, setMetadataProviderName, setName

Field Detail

GUI_PLUGIN_ELEMENT_PARENT_ID

public static final String GUI_PLUGIN_ELEMENT_PARENT_ID

See Also:

Constant Field Values

executionDataProfileName

protected String executionDataProfileName

The name of an ExecutionDataProfile

defaultSelection

protected boolean defaultSelection

Constructor Detail

PipelineRunConfiguration

public PipelineRunConfiguration()

PipelineRunConfiguration

public PipelineRunConfiguration(String name,
                                String description,
                                String executionInfoLocationName,
                                List<DescribedVariable> configurationVariables,
                                IPipelineEngineRunConfiguration engineRunConfiguration,
                                String executionDataProfileName,
                                boolean defaultSelection)

PipelineRunConfiguration

public PipelineRunConfiguration(PipelineRunConfiguration runConfiguration)

Method Detail

getDescription

public String getDescription()

Gets description

Returns:

value of description

setDescription

public void setDescription(String description)

Parameters:

description - The description to set

getExecutionInfoLocationName

public String getExecutionInfoLocationName()

Gets executionInfoLocationName

Returns:

value of executionInfoLocationName

setExecutionInfoLocationName

public void setExecutionInfoLocationName(String executionInfoLocationName)

Sets executionInfoLocationName

Parameters:

executionInfoLocationName - value of executionInfoLocationName

getConfigurationVariables

public List<DescribedVariable> getConfigurationVariables()

Gets configurationVariables

Returns:

value of configurationVariables

setConfigurationVariables

public void setConfigurationVariables(List<DescribedVariable> configurationVariables)

Parameters:

configurationVariables - The configurationVariables to set

getEngineRunConfiguration

public IPipelineEngineRunConfiguration getEngineRunConfiguration()

Gets engineRunConfiguration

Returns:

value of engineRunConfiguration

setEngineRunConfiguration

public void setEngineRunConfiguration(IPipelineEngineRunConfiguration engineRunConfiguration)

Parameters:

engineRunConfiguration - The engineRunConfiguration to set

getExecutionDataProfileName

public String getExecutionDataProfileName()

Gets executionDataProfileName

Returns:

value of executionDataProfileName

setExecutionDataProfileName

public void setExecutionDataProfileName(String executionDataProfileName)

Sets executionDataProfileName

Parameters:

executionDataProfileName - value of executionDataProfileName

isDefaultSelection

public boolean isDefaultSelection()

Gets defaultSelection

Returns:

value of defaultSelection

setDefaultSelection

public void setDefaultSelection(boolean defaultSelection)

Sets defaultSelection

Parameters:

defaultSelection - value of defaultSelection

applyToVariables

public void applyToVariables(IVariables variables)

findDefault

public static final PipelineRunConfiguration findDefault(IHopMetadataProvider metadataProvider)
                                                  throws HopException

Find the first default run configuration in the metadata and return it. Return null if there's no default.

Parameters:

metadataProvider -

Returns:

The default run configuration or null if none is specified.

Throws:

HopException