org.hkijena.jipipe.api.annotation

Class JIPipeDataByMetadataExporter

java.lang.Object

org.hkijena.jipipe.api.annotation.JIPipeDataByMetadataExporter

All Implemented Interfaces:

JIPipeParameterCollection

Direct Known Subclasses:

DataExporterSettings

public class JIPipeDataByMetadataExporter
extends Object
implements JIPipeParameterCollection

Class that exports data based on metadata

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDataByMetadataExporter.VariableSource

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
JIPipeDataByMetadataExporter()
JIPipeDataByMetadataExporter(JIPipeDataByMetadataExporter other)

Method Summary

Modifier and Type	Method and Description
String	generateName(JIPipeDataTable dataTable, int row, Set<String> existingMetadata) Generates a unique string based on metadata for the selected row
String	generateName(JIPipeDataTableMetadata exportedDataTable, int row, Set<String> existingMetadata)
Path	generatePath(JIPipeDataTable dataTable, int row, Set<String> existingMetadata) Generates a unique path based on metadata for the selected row
Path	generatePath(JIPipeDataTableMetadata exportedDataTable, int row, Set<String> existingMetadata)
EventBus	getEventBus() Gets the event bus that posts events about the parameters
DefaultExpressionParameter	getFileNameGenerator()
boolean	isForceName()
boolean	isMakeFilesystemCompatible()
void	setFileNameGenerator(DefaultExpressionParameter fileNameGenerator)
void	setForceName(boolean forceName)
void	setMakeFilesystemCompatible(boolean makeFilesystemCompatible)
void	writeToFolder(JIPipeDataTable dataTable, int row, Path outputPath, JIPipeProgressInfo progressInfo) Writes data to the specified folder
void	writeToFolder(JIPipeDataTable dataTable, int row, Path outputPath, JIPipeProgressInfo progressInfo, Set<String> existingMetadata) Writes data to the specified folder
void	writeToFolder(JIPipeDataTable dataTable, Path outputPath, JIPipeProgressInfo progressInfo) Writes data to the specified folder
void	writeToFolder(JIPipeDataTable dataTable, Path outputPath, JIPipeProgressInfo progressInfo, Set<String> existingMetadata) Writes data to the specified folder
void	writeToFolder(List<? extends JIPipeDataTable> dataTableList, Path outputPath, JIPipeProgressInfo progressInfo) Writes data to the specified folder

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

JIPipeDataByMetadataExporter

public JIPipeDataByMetadataExporter()

JIPipeDataByMetadataExporter

public JIPipeDataByMetadataExporter(JIPipeDataByMetadataExporter other)

Method Detail

getFileNameGenerator

public DefaultExpressionParameter getFileNameGenerator()

setFileNameGenerator

public void setFileNameGenerator(DefaultExpressionParameter fileNameGenerator)

isForceName

public boolean isForceName()

setForceName

public void setForceName(boolean forceName)

isMakeFilesystemCompatible

public boolean isMakeFilesystemCompatible()

setMakeFilesystemCompatible

public void setMakeFilesystemCompatible(boolean makeFilesystemCompatible)

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

writeToFolder

public void writeToFolder(List<? extends JIPipeDataTable> dataTableList,
                          Path outputPath,
                          JIPipeProgressInfo progressInfo)

Writes data to the specified folder

Parameters:

dataTableList - list of data tables the will be exported

outputPath - the path where the files will be put

writeToFolder

public void writeToFolder(JIPipeDataTable dataTable,
                          Path outputPath,
                          JIPipeProgressInfo progressInfo)

Writes data to the specified folder

Parameters:

dataTable - the data slot

outputPath - the path where the files will be put

writeToFolder

public void writeToFolder(JIPipeDataTable dataTable,
                          Path outputPath,
                          JIPipeProgressInfo progressInfo,
                          Set<String> existingMetadata)

Writes data to the specified folder

Parameters:

dataTable - the data slot

outputPath - the path where the files will be put

existingMetadata - list of existing entries. used to avoid duplicates.

writeToFolder

public void writeToFolder(JIPipeDataTable dataTable,
                          int row,
                          Path outputPath,
                          JIPipeProgressInfo progressInfo)

Writes data to the specified folder

Parameters:

dataTable - the data slot

row - the data row

outputPath - the path where the files will be put

writeToFolder

public void writeToFolder(JIPipeDataTable dataTable,
                          int row,
                          Path outputPath,
                          JIPipeProgressInfo progressInfo,
                          Set<String> existingMetadata)

Writes data to the specified folder

Parameters:

dataTable - the data slot

row - the data row

outputPath - the path where the files will be put

existingMetadata - list of existing entries. used to avoid duplicates

generateName

public String generateName(JIPipeDataTable dataTable,
                           int row,
                           Set<String> existingMetadata)

Generates a unique string based on metadata for the selected row

Parameters:

dataTable - the slot

row - the row

existingMetadata - existing strings

Returns:

the string

generateName

public String generateName(JIPipeDataTableMetadata exportedDataTable,
                           int row,
                           Set<String> existingMetadata)

generatePath

public Path generatePath(JIPipeDataTable dataTable,
                         int row,
                         Set<String> existingMetadata)

Generates a unique path based on metadata for the selected row

Parameters:

dataTable - the slot

row - the row

existingMetadata - existing strings. must be writable

Returns:

the string

generatePath

public Path generatePath(JIPipeDataTableMetadata exportedDataTable,
                         int row,
                         Set<String> existingMetadata)