org.hkijena.jipipe.api

Class JIPipeMetadata

java.lang.Object

org.hkijena.jipipe.api.JIPipeMetadata

All Implemented Interfaces:

JIPipeParameterCollection

Direct Known Subclasses:

JIPipeProjectMetadata

public class JIPipeMetadata
extends Object
implements JIPipeParameterCollection

JSON-serializable project metadata

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
JIPipeMetadata() Creates new empty instance
JIPipeMetadata(JIPipeMetadata other) Copies metadata

Method Summary

Modifier and Type	Method and Description
void	addCategories(String... categories)
void	addCategory(String category)
JIPipeAuthorMetadata.List	getAcknowledgements() Gets the list of acknowledged authors
JIPipeAuthorMetadata.List	getAuthors()
PluginCategoriesEnumParameter.List	getCategories()
String	getCitation()
StringList	getDependencyCitations()
HTMLText	getDescription()
EventBus	getEventBus() Gets the event bus that posts events about the parameters
String	getLicense()
String	getName()
Set<String>	getProcessedCategories() Returns the categories of the metadata; processed for ease of use If the categories list is empty, "Uncategorized" is returned
HTMLText	getSummary()
ImageParameter	getThumbnail()
String	getWebsite()
void	setAcknowledgements(JIPipeAuthorMetadata.List acknowledgements) Sets the list of acknowledged authors
void	setAuthors(JIPipeAuthorMetadata.List authors) Sets the authors
void	setCategories(PluginCategoriesEnumParameter.List categories)
void	setCitation(String citation) Sets the citation
void	setDependencyCitations(StringList dependencyCitations)
void	setDescription(HTMLText description) Sets the description
void	setLicense(String license) Sets the license
void	setName(String name) Sets the name
void	setSummary(HTMLText summary)
void	setThumbnail(ImageParameter thumbnail)
void	setWebsite(String website) Sets the website

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.parameters.JIPipeParameterCollection

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

JIPipeMetadata

public JIPipeMetadata()

Creates new empty instance

JIPipeMetadata

public JIPipeMetadata(JIPipeMetadata other)

Copies metadata

Parameters:

other - The original metadata

Method Detail

addCategory

public void addCategory(String category)

addCategories

public void addCategories(String... categories)

getCategories

public PluginCategoriesEnumParameter.List getCategories()

setCategories

public void setCategories(PluginCategoriesEnumParameter.List categories)

getProcessedCategories

public Set<String> getProcessedCategories()

Returns the categories of the metadata; processed for ease of use If the categories list is empty, "Uncategorized" is returned

Returns:

the categories

getName

public String getName()

Returns:

Gets the name

setName

public void setName(String name)

Sets the name

Parameters:

name - the name

getDescription

public HTMLText getDescription()

Returns:

the description

setDescription

public void setDescription(HTMLText description)

Sets the description

Parameters:

description - the description

getSummary

public HTMLText getSummary()

setSummary

public void setSummary(HTMLText summary)

getAuthors

public JIPipeAuthorMetadata.List getAuthors()

Returns:

The authors

setAuthors

public void setAuthors(JIPipeAuthorMetadata.List authors)

Sets the authors

Parameters:

authors - the authors

getAcknowledgements

public JIPipeAuthorMetadata.List getAcknowledgements()

Gets the list of acknowledged authors

Returns:

list of acknowledged authors

setAcknowledgements

public void setAcknowledgements(JIPipeAuthorMetadata.List acknowledgements)

Sets the list of acknowledged authors

Parameters:

acknowledgements - list of acknowledged authors

getWebsite

public String getWebsite()

Returns:

the website

setWebsite

public void setWebsite(String website)

Sets the website

Parameters:

website - the website

getLicense

public String getLicense()

Returns:

the license

setLicense

public void setLicense(String license)

Sets the license

Parameters:

license - the license

getCitation

public String getCitation()

Returns:

the citation

setCitation

public void setCitation(String citation)

Sets the citation

Parameters:

citation - the citation

getEventBus

public EventBus getEventBus()

Description copied from interface: JIPipeParameterCollection

Gets the event bus that posts events about the parameters

Specified by:

getEventBus in interface JIPipeParameterCollection

Returns:

The event bus triggering JIPipeParameterCollection.ParameterChangedEvent and JIPipeParameterCollection.ParameterStructureChangedEvent

getDependencyCitations

public StringList getDependencyCitations()

setDependencyCitations

public void setDependencyCitations(StringList dependencyCitations)

getThumbnail

public ImageParameter getThumbnail()

setThumbnail

public void setThumbnail(ImageParameter thumbnail)