org.hkijena.jipipe.api.data

Class JIPipeDataInfo

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeDataInfo

All Implemented Interfaces:

Comparable<JIPipeDataInfo>

public class JIPipeDataInfo
extends Object
implements Comparable<JIPipeDataInfo>

Compound type that contains all metadata of an JIPipeData type

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDataInfo.Deserializer Deserializes a info from a data type ID.
static class	JIPipeDataInfo.KeyDeserializer Deserializer for a Map key
static class	JIPipeDataInfo.Serializer Serializes a info as data type ID

Method Summary

Modifier and Type	Method and Description
int	compareTo(JIPipeDataInfo o)
boolean	equals(Object o)
List<String>	getAdditionalCitations() A list of additional citations
Class<? extends JIPipeData>	getDataClass()
String	getDescription()
String	getId()
static JIPipeDataInfo	getInstance(Class<? extends JIPipeData> klass) Returns a JIPipeDataInfo instance for the data class.
static JIPipeDataInfo	getInstance(String id) Returns a JIPipeDataInfo instance for the data type ID.
String	getMenuPath()
String	getName()
HTMLText	getStorageDocumentation()
String	getStorageSchema()
int	hashCode()
boolean	isHeavy()
boolean	isHidden()
JIPipeData	newInstance(Object... args) Creates a new instance
void	setAdditionalCitations(List<String> additionalCitations)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static JIPipeDataInfo getInstance(Class<? extends JIPipeData> klass)

Returns a JIPipeDataInfo instance for the data class. Does not require the data type to be registered. Instances are cached.

Parameters:

klass - The data class

Returns:

The info instance

getInstance

public static JIPipeDataInfo getInstance(String id)

Returns a JIPipeDataInfo instance for the data type ID. Requires that the data type ID is registered. Instances are cached.

Parameters:

id - Data type ID

Returns:

The info instance

getDataClass

public Class<? extends JIPipeData> getDataClass()

Returns:

The data class

getName

public String getName()

Returns:

Name of the data type

getDescription

public String getDescription()

Returns:

Description of the data type

getMenuPath

public String getMenuPath()

Returns:

Menu path of the data type

isHidden

public boolean isHidden()

Returns:

if the data type should be hidden

isHeavy

public boolean isHeavy()

Returns:

if the data type is considered heavy

getStorageDocumentation

public HTMLText getStorageDocumentation()

getAdditionalCitations

public List<String> getAdditionalCitations()

A list of additional citations

Returns:

additional citations

setAdditionalCitations

public void setAdditionalCitations(List<String> additionalCitations)

compareTo

public int compareTo(JIPipeDataInfo o)

Specified by:

compareTo in interface Comparable<JIPipeDataInfo>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Returns:

The data type ID

newInstance

public JIPipeData newInstance(Object... args)

Creates a new instance

Parameters:

args - arguments passed to the data type constructor

Returns:

the instance

getStorageSchema

public String getStorageSchema()