org.hkijena.jipipe.api

Class JIPipeProjectTemplate

java.lang.Object

org.hkijena.jipipe.api.JIPipeProjectTemplate

public class JIPipeProjectTemplate
extends Object

A reference to a template project

Constructor Summary

Constructors

Constructor and Description
JIPipeProjectTemplate(String id, com.fasterxml.jackson.databind.JsonNode node, JIPipeProjectMetadata metadata, Path templateFile, Path zipFile)

Method Summary

Modifier and Type	Method and Description
static String	getFallbackTemplateId()
String	getFixedName() Returns the metadata name if the template is resource-based or registered via the Java API.
String	getId()
JIPipeProjectMetadata	getMetadata()
com.fasterxml.jackson.databind.JsonNode	getNode()
Path	getTemplateFile()
Path	getZipFile()
JIPipeProject	loadAsProject(JIPipeIssueReport issueReport, JIPipeNotificationInbox inbox) Loads the project

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeProjectTemplate

public JIPipeProjectTemplate(String id,
                             com.fasterxml.jackson.databind.JsonNode node,
                             JIPipeProjectMetadata metadata,
                             Path templateFile,
                             Path zipFile)

Method Detail

getFallbackTemplateId

public static String getFallbackTemplateId()

loadAsProject

public JIPipeProject loadAsProject(JIPipeIssueReport issueReport,
                                   JIPipeNotificationInbox inbox)
                            throws IOException

Loads the project

Returns:

the project

Throws:

IOException - thrown by project loading

getFixedName

public String getFixedName()

Returns the metadata name if the template is resource-based or registered via the Java API. Returns the metadata name if the metadata name is not used by any other Java-registered template; otherwise returns the file name of the template

Returns:

the metadata name if appropriate, otherwise the filename

getId

public String getId()

getNode

public com.fasterxml.jackson.databind.JsonNode getNode()

getMetadata

public JIPipeProjectMetadata getMetadata()

getZipFile

public Path getZipFile()

getTemplateFile

public Path getTemplateFile()