org.hkijena.jipipe.api.environments

Class JIPipeArtifactEnvironment

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.environments.JIPipeEnvironment

org.hkijena.jipipe.api.environments.JIPipeArtifactEnvironment

All Implemented Interfaces:

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

Direct Known Subclasses:

JIPipeDataDirectoryEnvironment, JIPipeProcessArtifactEnvironment, PythonEnvironment, PythonPackageLibraryEnvironment, REnvironment

public abstract class JIPipeArtifactEnvironment
extends JIPipeEnvironment

An environment that can be filled with an artifact

Nested Class Summary

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

Constructor Summary

Constructors

Constructor and Description
JIPipeArtifactEnvironment()
JIPipeArtifactEnvironment(JIPipeArtifactEnvironment other)

Method Summary

Modifier and Type	Method and Description
abstract void	applyConfigurationFromArtifact(JIPipeLocalArtifact artifact, JIPipeProgressInfo progressInfo) Applies the artifact configuration to the current environment if isLoadFromArtifact() is true
void	applyConfigurationFromArtifactAndSetLastArtifact(JIPipeLocalArtifact artifact, JIPipeProgressInfo progressInfo) Applies the artifact configuration to the current environment if isLoadFromArtifact() is true Also sets the last loaded artifact
JIPipeArtifactQueryParameter	getArtifactQuery()
JIPipeLocalArtifact	getLastConfiguredArtifact()
boolean	isLoadFromArtifact()
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
void	setArtifactQuery(JIPipeArtifactQueryParameter artifactQuery)
void	setLastConfiguredArtifact(JIPipeLocalArtifact lastConfiguredArtifact)
void	setLoadFromArtifact(boolean loadFromArtifact)

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

getIcon, getInfo, 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, reportValidity

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

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

Constructor Detail

JIPipeArtifactEnvironment

public JIPipeArtifactEnvironment()

JIPipeArtifactEnvironment

public JIPipeArtifactEnvironment(JIPipeArtifactEnvironment other)

Method Detail

isLoadFromArtifact

public boolean isLoadFromArtifact()

setLoadFromArtifact

public void setLoadFromArtifact(boolean loadFromArtifact)

getArtifactQuery

public JIPipeArtifactQueryParameter getArtifactQuery()

setArtifactQuery

public void setArtifactQuery(JIPipeArtifactQueryParameter artifactQuery)

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterAccess access)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of parameters inside the UI

Parameters:

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

access - the parameter

Returns:

if the parameter is visible inside the UI

applyConfigurationFromArtifactAndSetLastArtifact

public void applyConfigurationFromArtifactAndSetLastArtifact(JIPipeLocalArtifact artifact,
                                                             JIPipeProgressInfo progressInfo)

Applies the artifact configuration to the current environment if isLoadFromArtifact() is true Also sets the last loaded artifact

Parameters:

artifact - the artifact

progressInfo - the progress info

applyConfigurationFromArtifact

public abstract void applyConfigurationFromArtifact(JIPipeLocalArtifact artifact,
                                                    JIPipeProgressInfo progressInfo)

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

getLastConfiguredArtifact

public JIPipeLocalArtifact getLastConfiguredArtifact()

setLastConfiguredArtifact

public void setLastConfiguredArtifact(JIPipeLocalArtifact lastConfiguredArtifact)