org.hkijena.jipipe.plugins.r

Class REnvironment

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.environments.JIPipeEnvironment

org.hkijena.jipipe.api.environments.JIPipeArtifactEnvironment

org.hkijena.jipipe.plugins.r.REnvironment

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable

public class REnvironment
extends JIPipeArtifactEnvironment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	REnvironment.List A list of REnvironment
static class	REnvironment.RArgumentsVariablesInfo

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENVIRONMENT_ID

Constructor Summary

Constructors

Constructor and Description
REnvironment()
REnvironment(REnvironment other)

Method Summary

Modifier and Type	Method and Description
void	applyConfigurationFromArtifact(JIPipeLocalArtifact artifact, JIPipeProgressInfo progressInfo) Applies the artifact configuration to the current environment if isLoadFromArtifact() is true
JIPipeExpressionParameter	getArguments()
StringQueryExpressionAndStringPairParameter.List	getEnvironmentVariables()
Icon	getIcon() Returns the icon displayed in the UI for the current status
String	getInfo() Returns more detailed information (e.g., the executed script environment path).
Path	getRExecutablePath()
Path	getRScriptExecutablePath()
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setArguments(JIPipeExpressionParameter arguments)
void	setEnvironmentVariables(StringQueryExpressionAndStringPairParameter.List environmentVariables)
void	setRExecutablePath(Path RExecutablePath)
void	setRScriptExecutablePath(Path RScriptExecutablePath)

Methods inherited from class org.hkijena.jipipe.api.environments.JIPipeArtifactEnvironment

applyConfigurationFromArtifactAndSetLastArtifact, getArtifactQuery, getLastConfiguredArtifact, isLoadFromArtifact, setArtifactQuery, setLastConfiguredArtifact, setLoadFromArtifact

Methods inherited from class org.hkijena.jipipe.api.environments.JIPipeEnvironment

getName, getSource, getVersion, setName, setSource, setVersion

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Field Detail

ENVIRONMENT_ID

public static final String ENVIRONMENT_ID

See Also:

Constant Field Values

Constructor Detail

REnvironment

public REnvironment()

REnvironment

public REnvironment(REnvironment other)

Method Detail

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Parameters:

reportContext - the report context

report - the report to be added to

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterAccess access)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of parameters inside the UI

Specified by:

isParameterUIVisible in interface JIPipeParameterCollection

Overrides:

isParameterUIVisible in class JIPipeArtifactEnvironment

Parameters:

tree - the parameter tree that is used to access this parameter

access - the parameter

Returns:

if the parameter is visible inside the UI

applyConfigurationFromArtifact

public void applyConfigurationFromArtifact(JIPipeLocalArtifact artifact,
                                           JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeArtifactEnvironment

Applies the artifact configuration to the current environment if isLoadFromArtifact() is true

Specified by:

applyConfigurationFromArtifact in class JIPipeArtifactEnvironment

getRExecutablePath

public Path getRExecutablePath()

setRExecutablePath

public void setRExecutablePath(Path RExecutablePath)

getRScriptExecutablePath

public Path getRScriptExecutablePath()

setRScriptExecutablePath

public void setRScriptExecutablePath(Path RScriptExecutablePath)

getArguments

public JIPipeExpressionParameter getArguments()

setArguments

public void setArguments(JIPipeExpressionParameter arguments)

getEnvironmentVariables

public StringQueryExpressionAndStringPairParameter.List getEnvironmentVariables()

setEnvironmentVariables

public void setEnvironmentVariables(StringQueryExpressionAndStringPairParameter.List environmentVariables)

getIcon

public Icon getIcon()

Description copied from class: JIPipeEnvironment

Returns the icon displayed in the UI for the current status

Specified by:

getIcon in class JIPipeEnvironment

Returns:

the icon

getInfo

public String getInfo()

Description copied from class: JIPipeEnvironment

Returns more detailed information (e.g., the executed script environment path). Displayed inside a text field.

Specified by:

getInfo in class JIPipeEnvironment

Returns:

the info string