org.hkijena.jipipe.extensions.strings

Class StringData

java.lang.Object

org.hkijena.jipipe.extensions.strings.StringData

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData

Direct Known Subclasses:

JsonData, XMLData

public class StringData
extends Object
implements JIPipeData

A data type that contains a string

Constructor Summary

Constructors

Constructor and Description
StringData(String data)
StringData(StringData other)

Method Summary

Modifier and Type	Method and Description
void	display(String displayName, JIPipeWorkbench workbench, JIPipeDataSource source) This function should display the data in the GUI.
JIPipeData	duplicate(JIPipeProgressInfo progressInfo) Duplicates the data
void	exportData(JIPipeWriteDataStorage storage, String name, boolean forceName, JIPipeProgressInfo progressInfo) Saves the data to a folder
String	getData()
String	getMimeType() Returns the MIME type of the string
String	getOutputExtension() The extension that is generated by the output function
static StringData	importData(JIPipeReadDataStorage storage, JIPipeProgressInfo progressInfo)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.data.JIPipeData

close, exportThumbnails, getDescriptionOf, getMenuPathOf, getNameOf, getSortedList, getStorageDocumentation, getStorageSchema, groupByMenuPath, isCommon, isHeavy, isHidden, preview, toDetailedString

Constructor Detail

StringData

public StringData(String data)

StringData

public StringData(StringData other)

Method Detail

importData

public static StringData importData(JIPipeReadDataStorage storage,
                                    JIPipeProgressInfo progressInfo)

exportData

public void exportData(JIPipeWriteDataStorage storage,
                       String name,
                       boolean forceName,
                       JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Saves the data to a folder

Specified by:

exportData in interface JIPipeData

Parameters:

storage - The storage where the data should be written

name - A name reference that can be used to generate filename(s)

forceName - If enabled, the data is saved potentially destructively. Generated files must always contain the name parameter. This is used to collect results for humans or other algorithms.

progressInfo - the progress

duplicate

public JIPipeData duplicate(JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Duplicates the data

Specified by:

duplicate in interface JIPipeData

Parameters:

progressInfo - the progress of duplicating the data

Returns:

a deep copy of the data

display

public void display(String displayName,
                    JIPipeWorkbench workbench,
                    JIPipeDataSource source)

Description copied from interface: JIPipeData

This function should display the data in the GUI. The UI can handle multiple of such operations via JIPipeDataDisplayOperation that can be registered separately. This item will always be shown as "Default" in the list of operations.

Specified by:

display in interface JIPipeData

Parameters:

displayName - a name that can be used

workbench - the workbench

source - optional source of the data. Can be null or any kind of data type (e.g. JIPipeDataSlot)

getOutputExtension

public String getOutputExtension()

The extension that is generated by the output function

Returns:

the extension

getMimeType

public String getMimeType()

Returns the MIME type of the string

Returns:

the MIME type

getData

public String getData()

toString

public String toString()

Overrides:

toString in class Object