org.hkijena.jipipe.plugins.dataenvironment

Class JIPipeDataDirectoryEnvironment

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.dataenvironment.JIPipeDataDirectoryEnvironment

All Implemented Interfaces:

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

public class JIPipeDataDirectoryEnvironment
extends JIPipeArtifactEnvironment

An artifact environment that does no have any function workload, but only contains data Points towards a directory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDataDirectoryEnvironment.List

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
JIPipeDataDirectoryEnvironment()
JIPipeDataDirectoryEnvironment(JIPipeDataDirectoryEnvironment 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
Path	getDirectory()
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).
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setDirectory(Path directory)
String	toString()

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

applyConfigurationFromArtifactAndSetLastArtifact, getArtifactQuery, getLastConfiguredArtifact, isLoadFromArtifact, isParameterUIVisible, 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, 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

Constructor Detail

JIPipeDataDirectoryEnvironment

public JIPipeDataDirectoryEnvironment()

JIPipeDataDirectoryEnvironment

public JIPipeDataDirectoryEnvironment(JIPipeDataDirectoryEnvironment other)

Method Detail

getDirectory

public Path getDirectory()

setDirectory

public void setDirectory(Path directory)

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

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

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

toString

public String toString()

Overrides:

toString in class Object