org.hkijena.jipipe.plugins.strings

Class StringData

java.lang.Object

org.hkijena.jipipe.plugins.strings.StringData

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData

Direct Known Subclasses:

JsonData, URIData, 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
JIPipeThumbnailData	createThumbnail(int width, int height, JIPipeProgressInfo progressInfo) This function generates a thumbnail for this data Can return null
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

createThumbnail

public JIPipeThumbnailData createThumbnail(int width,
                                           int height,
                                           JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

This function generates a thumbnail for this data Can return null

Specified by:

createThumbnail in interface JIPipeData

Parameters:

width - the width

height - the height

progressInfo - the progress info

Returns:

the thumbnail or null

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