JIPipeProject (jipipe 5.1.0-SNAPSHOT API)

java.lang.Object
- org.hkijena.jipipe.api.project.JIPipeProject

All Implemented Interfaces:

JIPipeValidatable
```
public class JIPipeProject
extends Object
implements JIPipeValidatable
```
A JIPipe project. It contains all information to set up and run an analysis

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JIPipeProject.CompartmentAddedEvent` Triggered when a sample is added to an `JIPipeProject`
`static class`	`JIPipeProject.CompartmentAddedEventEmitter`
`static interface`	`JIPipeProject.CompartmentAddedEventListener`
`static class`	`JIPipeProject.CompartmentRemovedEvent` Triggered when a sample is removed from an `JIPipeProject`
`static class`	`JIPipeProject.CompartmentRemovedEventEmitter`
`static interface`	`JIPipeProject.CompartmentRemovedEventListener`
`static class`	`JIPipeProject.Deserializer` Deserializes a project
`static class`	`JIPipeProject.Serializer` Serializes a project

Field Summary

Fields
Modifier and Type Field and Description

static int CURRENT_PROJECT_FORMAT_VERSION
The current version of the project format.

Fields
Modifier and Type	Field and Description
`static int`	`CURRENT_PROJECT_FORMAT_VERSION` The current version of the project format.

Constructor Summary

Constructors
Constructor and Description

JIPipeProject()
A JIPipe project

Constructors
Constructor and Description
`JIPipeProject()` A JIPipe project

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JIPipeProjectCompartment`	`addCompartment(String name)` Adds a new project compartment
`void`	`connectCompartments(JIPipeProjectCompartment source, JIPipeProjectCompartment target)` Connects two compartments
`JIPipeProjectCompartment`	`findCompartment(String uuidOrAlias)` Finds a compartment by UUID or alias
`void`	`fromJson(com.fasterxml.jackson.databind.JsonNode jsonNode, JIPipeValidationReportContext context, JIPipeValidationReport report, JIPipeNotificationInbox notifications)` Loads the project from JSON
`Map<String,JIPipeMetadataObject>`	`getAdditionalMetadata()`
`JIPipeGraphNode.BaseDirectoryChangedEventEmitter`	`getBaseDirectoryChangedEventEmitter()`
`JIPipeLocalProjectMemoryCache`	`getCache()`
`JIPipeProject.CompartmentAddedEventEmitter`	`getCompartmentAddedEventEmitter()`
`JIPipeGraph`	`getCompartmentGraph()`
`JIPipeProject.CompartmentRemovedEventEmitter`	`getCompartmentRemovedEventEmitter()`
`com.google.common.collect.BiMap<UUID,JIPipeProjectCompartment>`	`getCompartments()`
`Set<JIPipeGraphNode>`	`getDeactivatedAlgorithms()` Returns a list of all nodes that cannot be executed or are deactivated by the user.
`Map<String,Path>`	`getDirectoryMap()` Gets a map of user-defined directories
`JIPipeGraph`	`getGraph()`
`Set<JIPipeDataSlot>`	`getHeavyIntermediateAlgorithmOutputSlots()` Returns a list of all nodes that generate heavy data (`LabelAsJIPipeHeavyData`) and are intermediate (see getIntermediateAlgorithms()).
`JIPipeProjectHistoryJournal`	`getHistoryJournal()`
`Set<JIPipeGraphNode>`	`getIntermediateAlgorithms()` Returns all nodes that have at least one connected algorithm that uses its generated data.
`JIPipeProjectMetadata`	`getMetadata()`
`List<JIPipeNodeExample>`	`getNodeExamples(String nodeTypeId)` Gets all examples for a node type ID.
`JIPipeProjectInfoParameters`	`getPipelineParameters()` Returns the global parameters for this pipeline
`JIPipeProjectRunSetsConfiguration`	`getRunSetsConfiguration()`
`JIPipeRuntimePartitionConfiguration`	`getRuntimePartitions()`
`<T extends JIPipeProjectSettingsSheet> T`	`getSettingsSheet(Class<T> klass)`
`<T extends JIPipeProjectSettingsSheet> T`	`getSettingsSheet(String id, Class<T> klass)`
`Map<String,JIPipeProjectSettingsSheet>`	`getSettingsSheets()`
`Set<JIPipeDependency>`	`getSimplifiedMinimalDependencies()`
`JIPipeRunnableQueue`	`getSnapshotQueue()`
`Path`	`getTemporaryBaseDirectory()`
`void`	`getTextDescription(StringBuilder stringBuilder, int headingLevel)` Gets a description of the project as text
`Path`	`getWorkDirectory()` Gets the folder where the project is currently working in
`static Set<JIPipeDependency>`	`loadDependenciesFromJson(com.fasterxml.jackson.databind.JsonNode node)` Deserializes the set of project dependencies from JSON.
`static JIPipeProjectMetadata`	`loadMetadataFromJson(com.fasterxml.jackson.databind.JsonNode node)` Deserializes the project metadata from JSON
`static JIPipeProject`	`loadProject(Path fileName, JIPipeValidationReportContext context, JIPipeValidationReport report)` Loads a project from a file
`static JIPipeProject`	`loadProject(Path fileName, JIPipeValidationReportContext context, JIPipeValidationReport report, JIPipeNotificationInbox notifications)` Loads a project from a file
`Path`	`newTemporaryDirectory()` Creates a new temporary subdirectory in the project's temporary directory
`Path`	`newTemporaryDirectory(String baseName)` Creates a new temporary subdirectory in the project's temporary directory
`Path`	`newTemporaryFilePath(String baseName, String suffix)` Gets the path to a non-existing file in the project's temporary directory
`void`	`rebuildAliasIds(boolean force)` Re-assigns graph node Ids based on their name
`void`	`rebuildCompartmentsFromGraph()` Rebuilds the compartment list from the current state of the compartment graph
`void`	`removeCompartment(JIPipeProjectCompartment compartment)` Removes a compartment
`void`	`reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report)` Generates a validity report
`void`	`reportValidity(JIPipeValidationReportContext context, JIPipeValidationReport report, JIPipeGraphNode targetNode)` Reports the validity for the target node and its dependencies
`void`	`saveProject(OutputStream outputStream)` Saves the project
`void`	`saveProject(Path fileName)` Saves the project
`void`	`saveProject(Writer writer)` Saves the project
`void`	`setAdditionalMetadata(Map<String,JIPipeMetadataObject> additionalMetadata)`
`void`	`setWorkDirectory(Path workDirectory)` Sets the folder where the project is currently working in.
`void`	`toJson(com.fasterxml.jackson.core.JsonGenerator generator)` Writes the project to JSON
`void`	`updateCompartmentOutputs(JIPipeProjectCompartment compartment)`
`void`	`validateUserDirectories(JIPipeNotificationInbox notifications)` Checks if the project metadata user directories are properly set up.

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

- Field Detail
  - CURRENT_PROJECT_FORMAT_VERSION
```
public static final int CURRENT_PROJECT_FORMAT_VERSION
```
    The current version of the project format. This is here for any future addition.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JIPipeProject
```
public JIPipeProject()
```
    A JIPipe project
- Method Detail
  - loadProject
```
public static JIPipeProject loadProject(Path fileName,
                                        JIPipeValidationReportContext context,
                                        JIPipeValidationReport report)
                                 throws IOException
```
    Loads a project from a file
    
    Parameters:
    
    fileName - JSON file
    
    context - the context
    
    report - issue report
    
    Returns:
    
    Loaded project
    
    Throws:
    
    IOException - Triggered by ObjectMapper
  - loadProject
```
public static JIPipeProject loadProject(Path fileName,
                                        JIPipeValidationReportContext context,
                                        JIPipeValidationReport report,
                                        JIPipeNotificationInbox notifications)
                                 throws IOException
```
    Loads a project from a file
    
    Parameters:
    
    fileName - JSON file
    
    context - the context
    
    report - issue report
    
    notifications - notifications for the user
    
    Returns:
    
    Loaded project
    
    Throws:
    
    IOException - Triggered by ObjectMapper
  - loadDependenciesFromJson
```
public static Set<JIPipeDependency> loadDependenciesFromJson(com.fasterxml.jackson.databind.JsonNode node)
```
    Deserializes the set of project dependencies from JSON. Does not require the dependencies to be actually registered.
    
    Parameters:
    
    node - JSON node
    
    Returns:
    
    The dependencies as JIPipeMutableDependency
  - loadMetadataFromJson
```
public static JIPipeProjectMetadata loadMetadataFromJson(com.fasterxml.jackson.databind.JsonNode node)
```
    Deserializes the project metadata from JSON
    
    Parameters:
    
    node - JSON node
    
    Returns:
    
    the metadata
  - validateUserDirectories
```
public void validateUserDirectories(JIPipeNotificationInbox notifications)
```
    Checks if the project metadata user directories are properly set up. Otherwise, generates a notification
    
    Parameters:
    
    notifications - the notifications
  - newTemporaryFilePath
```
public Path newTemporaryFilePath(String baseName,
                                 String suffix)
```
    Gets the path to a non-existing file in the project's temporary directory
    
    Parameters:
    
    baseName - the base name (prefix)
    
    suffix - the suffix (extension)
    
    Returns:
    
    the path
  - newTemporaryDirectory
```
public Path newTemporaryDirectory(String baseName)
```
    Creates a new temporary subdirectory in the project's temporary directory
    
    Parameters:
    
    baseName - the base name (prefix)
    
    Returns:
    
    the temporary directory
  - newTemporaryDirectory
```
public Path newTemporaryDirectory()
```
    Creates a new temporary subdirectory in the project's temporary directory
    
    Returns:
    
    the temporary directory
  - getTemporaryBaseDirectory
```
public Path getTemporaryBaseDirectory()
```
  - findCompartment
```
public JIPipeProjectCompartment findCompartment(String uuidOrAlias)
```
    Finds a compartment by UUID or alias
    
    Parameters:
    
    uuidOrAlias - UUID or alias
    
    Returns:
    
    the compartment or null if it could not be found
  - getSnapshotQueue
```
public JIPipeRunnableQueue getSnapshotQueue()
```
  - getGraph
```
public JIPipeGraph getGraph()
```
    Returns:
    
    The algorithm graph
  - saveProject
```
public void saveProject(Path fileName)
                 throws IOException
```
    Saves the project
    
    Parameters:
    
    fileName - Target file
    
    Throws:
    
    IOException - Triggered by ObjectMapper
  - saveProject
```
public void saveProject(Writer writer)
                 throws IOException
```
    Saves the project
    
    Parameters:
    
    writer - Target writer
    
    Throws:
    
    IOException - Triggered by ObjectMapper
  - saveProject
```
public void saveProject(OutputStream outputStream)
                 throws IOException
```
    Saves the project
    
    Parameters:
    
    outputStream - Target writer
    
    Throws:
    
    IOException - Triggered by ObjectMapper
  - getCache
```
public JIPipeLocalProjectMemoryCache getCache()
```
  - getCompartments
```
public com.google.common.collect.BiMap<UUID,JIPipeProjectCompartment> getCompartments()
```
    Returns:
    
    The current project compartments
  - getCompartmentAddedEventEmitter
```
public JIPipeProject.CompartmentAddedEventEmitter getCompartmentAddedEventEmitter()
```
  - getCompartmentRemovedEventEmitter
```
public JIPipeProject.CompartmentRemovedEventEmitter getCompartmentRemovedEventEmitter()
```
  - getSettingsSheets
```
public Map<String,JIPipeProjectSettingsSheet> getSettingsSheets()
```
  - getSettingsSheet
```
public <T extends JIPipeProjectSettingsSheet> T getSettingsSheet(String id,
                                                                 Class<T> klass)
```
  - getSettingsSheet
```
public <T extends JIPipeProjectSettingsSheet> T getSettingsSheet(Class<T> klass)
```
  - getBaseDirectoryChangedEventEmitter
```
public JIPipeGraphNode.BaseDirectoryChangedEventEmitter getBaseDirectoryChangedEventEmitter()
```
  - addCompartment
```
public JIPipeProjectCompartment addCompartment(String name)
```
    Adds a new project compartment
    
    Parameters:
    
    name - Compartment name
    
    Returns:
    
    The compartment
  - connectCompartments
```
public void connectCompartments(JIPipeProjectCompartment source,
                                JIPipeProjectCompartment target)
```
    Connects two compartments
    
    Parameters:
    
    source - Source compartment
    
    target - Target compartment
  - updateCompartmentOutputs
```
public void updateCompartmentOutputs(JIPipeProjectCompartment compartment)
```
  - reportValidity
```
public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)
```
    Description copied from interface: JIPipeValidatable
    
    Generates a validity report
    
    Specified by:
    
    reportValidity in interface JIPipeValidatable
    
    Parameters:
    
    reportContext - the report context
    
    report - the report to be added to
  - reportValidity
```
public void reportValidity(JIPipeValidationReportContext context,
                           JIPipeValidationReport report,
                           JIPipeGraphNode targetNode)
```
    Reports the validity for the target node and its dependencies
    
    Parameters:
    
    context - the context
    
    report - the report
    
    targetNode - the target node
  - getCompartmentGraph
```
public JIPipeGraph getCompartmentGraph()
```
    Returns:
    
    The compartment graph. Contains only JIPipeProjectCompartment nodes.
  - removeCompartment
```
public void removeCompartment(JIPipeProjectCompartment compartment)
```
    Removes a compartment
    
    Parameters:
    
    compartment - The compartment
  - getMetadata
```
public JIPipeProjectMetadata getMetadata()
```
    Returns:
    
    Project metadata
  - getWorkDirectory
```
public Path getWorkDirectory()
```
    Gets the folder where the project is currently working in
    
    Returns:
    
    the folder where the project is currently working in
  - setWorkDirectory
```
public void setWorkDirectory(Path workDirectory)
```
    Sets the folder where the project is currently working in. This information is passed to the algorithms to adapt to the work directory if needed (usually ony Filesystem nodes are affected)
    
    Parameters:
    
    workDirectory - Project work directory
  - getSimplifiedMinimalDependencies
```
public Set<JIPipeDependency> getSimplifiedMinimalDependencies()
```
    Returns:
    
    All project dependencies
  - rebuildAliasIds
```
public void rebuildAliasIds(boolean force)
```
    Re-assigns graph node Ids based on their name
    
    Parameters:
    
    force - force updating
  - getRunSetsConfiguration
```
public JIPipeProjectRunSetsConfiguration getRunSetsConfiguration()
```
  - getRuntimePartitions
```
public JIPipeRuntimePartitionConfiguration getRuntimePartitions()
```
  - getAdditionalMetadata
```
public Map<String,JIPipeMetadataObject> getAdditionalMetadata()
```
  - setAdditionalMetadata
```
public void setAdditionalMetadata(Map<String,JIPipeMetadataObject> additionalMetadata)
```
  - toJson
```
public void toJson(com.fasterxml.jackson.core.JsonGenerator generator)
            throws IOException
```
    Writes the project to JSON
    
    Parameters:
    
    generator - the JSON generator
    
    Throws:
    
    IOException - thrown by JsonGenerator
  - fromJson
```
public void fromJson(com.fasterxml.jackson.databind.JsonNode jsonNode,
                     JIPipeValidationReportContext context,
                     JIPipeValidationReport report,
                     JIPipeNotificationInbox notifications)
              throws IOException
```
    Loads the project from JSON
    
    Parameters:
    
    jsonNode - the node
    
    context - the context
    
    notifications - notifications for the user
    
    Throws:
    
    IOException
  - rebuildCompartmentsFromGraph
```
public void rebuildCompartmentsFromGraph()
```
    Rebuilds the compartment list from the current state of the compartment graph
  - getDeactivatedAlgorithms
```
public Set<JIPipeGraphNode> getDeactivatedAlgorithms()
```
    Returns a list of all nodes that cannot be executed or are deactivated by the user. This method works on transitive deactivation (e.g. a dependency is deactivated).
    
    Returns:
    
    set of deactivated nodes
  - getIntermediateAlgorithms
```
public Set<JIPipeGraphNode> getIntermediateAlgorithms()
```
    Returns all nodes that have at least one connected algorithm that uses its generated data.
    
    Returns:
    
    Intermediate nodes
  - getHeavyIntermediateAlgorithmOutputSlots
```
public Set<JIPipeDataSlot> getHeavyIntermediateAlgorithmOutputSlots()
```
    Returns a list of all nodes that generate heavy data (LabelAsJIPipeHeavyData) and are intermediate (see getIntermediateAlgorithms()). Skips all nodes that do not save outputs.
    
    Returns:
    
    intermediate nodes with heavy data
  - getPipelineParameters
```
public JIPipeProjectInfoParameters getPipelineParameters()
```
    Returns the global parameters for this pipeline
    
    Returns:
    
    global parameters
  - getHistoryJournal
```
public JIPipeProjectHistoryJournal getHistoryJournal()
```
  - getNodeExamples
```
public List<JIPipeNodeExample> getNodeExamples(String nodeTypeId)
```
    Gets all examples for a node type ID. Includes project templates
    
    Parameters:
    
    nodeTypeId - the ID
    
    Returns:
    
    the examples
  - getDirectoryMap
```
public Map<String,Path> getDirectoryMap()
```
    Gets a map of user-defined directories
  - getTextDescription
```
public void getTextDescription(StringBuilder stringBuilder,
                               int headingLevel)
```
    Gets a description of the project as text
    
    Parameters:
    
    stringBuilder - the string builder
    
    headingLevel - the heading level

Class JIPipeProject

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_PROJECT_FORMAT_VERSION

Constructor Detail

JIPipeProject

Method Detail

loadProject

loadProject

loadDependenciesFromJson

loadMetadataFromJson

validateUserDirectories

newTemporaryFilePath

newTemporaryDirectory

newTemporaryDirectory

getTemporaryBaseDirectory

findCompartment

getSnapshotQueue

getGraph

saveProject

saveProject

saveProject

getCache

getCompartments

getCompartmentAddedEventEmitter

getCompartmentRemovedEventEmitter

getSettingsSheets

getSettingsSheet

getSettingsSheet

getBaseDirectoryChangedEventEmitter

addCompartment

connectCompartments

updateCompartmentOutputs

reportValidity

reportValidity

getCompartmentGraph

removeCompartment

getMetadata

getWorkDirectory

setWorkDirectory

getSimplifiedMinimalDependencies

rebuildAliasIds

getRunSetsConfiguration

getRuntimePartitions

getAdditionalMetadata

setAdditionalMetadata

toJson

fromJson

rebuildCompartmentsFromGraph

getDeactivatedAlgorithms

getIntermediateAlgorithms

getHeavyIntermediateAlgorithmOutputSlots

getPipelineParameters

getHistoryJournal

getNodeExamples

getDirectoryMap

getTextDescription