org.hkijena.jipipe.api.compartments

Class JIPipeExportedCompartment

java.lang.Object

org.hkijena.jipipe.api.compartments.JIPipeExportedCompartment

public class JIPipeExportedCompartment
extends Object

Exported JIPipeProjectCompartment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeExportedCompartment.Deserializer Deserializes the compartment
static class	JIPipeExportedCompartment.Serializer Serializes the compartment

Constructor Summary

Constructors

Constructor and Description
JIPipeExportedCompartment() Creates a new instance
JIPipeExportedCompartment(JIPipeProjectCompartment compartment) Initializes the instance from a compartment

Method Summary

Modifier and Type	Method and Description
JIPipeProjectCompartment	addTo(JIPipeProject project, String compartmentName) Adds the compartment to a project as the specified compartment name
JIPipeMetadata	getMetadata()
String	getSuggestedName()
void	saveToJson(Path fileName) Saves the exported compartment to JSON
void	setMetadata(JIPipeMetadata metadata) Sets the metadata

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeExportedCompartment

public JIPipeExportedCompartment()

Creates a new instance

JIPipeExportedCompartment

public JIPipeExportedCompartment(JIPipeProjectCompartment compartment)

Initializes the instance from a compartment

Parameters:

compartment - The compartment

Method Detail

getSuggestedName

public String getSuggestedName()

Returns:

A name suggested automatically

addTo

public JIPipeProjectCompartment addTo(JIPipeProject project,
                                      String compartmentName)

Adds the compartment to a project as the specified compartment name

Parameters:

project - Target project

compartmentName - Target compartment name

Returns:

the compartment instance

saveToJson

public void saveToJson(Path fileName)
                throws IOException

Saves the exported compartment to JSON

Parameters:

fileName - The JSON filename

Throws:

IOException - Triggered by ObjectMapper

getMetadata

public JIPipeMetadata getMetadata()

Returns:

Metadata

setMetadata

public void setMetadata(JIPipeMetadata metadata)

Sets the metadata

Parameters:

metadata - The metadata