org.hkijena.jipipe.api

Class JIPipeProjectCache

java.lang.Object

org.hkijena.jipipe.api.JIPipeProjectCache

public class JIPipeProjectCache
extends Object

A structure that manages cached data

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeProjectCache.ModifiedEvent Event that is triggered when the cache was modified (something stored or removed)

Constructor Summary

Constructors

Constructor and Description
JIPipeProjectCache(JIPipeProject project) Creates a new instance

Method Summary

Modifier and Type	Method and Description
void	autoClean(boolean compareSlots, boolean compareProjectStates, JIPipeProgressInfo progressInfo) Safely removes cache entries that are not accessible anymore (e.g. an algorithm was removed from the graph; or states where the slots do not exist anymore)
void	clear() Removes everything from the cache
void	clear(UUID source) Removes an algorithm from the cache
void	clear(UUID source, JIPipeProjectCacheState stateId) Removes an algorithm from the cache
Map<JIPipeProjectCacheState,Map<String,JIPipeDataSlot>>	extract(UUID source) Tries to extract data from the cache
Map<String,JIPipeDataSlot>	extract(UUID source, JIPipeProjectCacheState stateId) Tries to extract data from the cache.
JIPipeDataSlot	extract(UUID source, JIPipeProjectCacheState stateId, String slotName) Tries to extract data from the cache.
Map<JIPipeDataInfo,Integer>	getCachedDataTypes() Returns statistics on how many rows of given data type have been cached
int	getCachedRowNumber() Returns the number of cached data rows
EventBus	getEventBus()
JIPipeProject	getProject()
boolean	isEmpty()
void	makeNonVirtual(JIPipeProgressInfo progress) Makes the whole cache virtual
void	makeVirtual(JIPipeProgressInfo progress) Makes the whole cache virtual
void	onAlgorithmRemoved(JIPipeGraph.GraphChangedEvent event) Listens to changes in the algorithm graph.
int	size()
void	store(JIPipeGraphNode source, JIPipeProjectCacheState stateId, JIPipeDataSlot slot, JIPipeProgressInfo progressInfo) Stores data into the cache

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeProjectCache

public JIPipeProjectCache(JIPipeProject project)

Creates a new instance

Parameters:

project - the project the cache is associated to

Method Detail

getProject

public JIPipeProject getProject()

store

public void store(JIPipeGraphNode source,
                  JIPipeProjectCacheState stateId,
                  JIPipeDataSlot slot,
                  JIPipeProgressInfo progressInfo)

Stores data into the cache

Parameters:

source - the generating algorithm

stateId - the state id

slot - the slot that contains the data

progressInfo - data storage progress

extract

public Map<JIPipeProjectCacheState,Map<String,JIPipeDataSlot>> extract(UUID source)

Tries to extract data from the cache

Parameters:

source - the node UUID

Returns:

map from state ID to map of slot name to slot. Null if not found

extract

public Map<String,JIPipeDataSlot> extract(UUID source,
                                          JIPipeProjectCacheState stateId)

Tries to extract data from the cache. Returns null if no data is available.

Parameters:

source - the node UUID

stateId - the state id

Returns:

all cached slots. Please do not work directly on those. Use targetSlot.copyFrom() instead. Never null.

extract

public JIPipeDataSlot extract(UUID source,
                              JIPipeProjectCacheState stateId,
                              String slotName)

Tries to extract data from the cache. Returns null if no data is available.

Parameters:

source - the node UUID

stateId - the state id

slotName - the slot that contains the data

Returns:

the cache's slot. Please do not work directly on this slot. Use targetSlot.copyFrom() instead. Null if not found

clear

public void clear(UUID source)

Removes an algorithm from the cache

Parameters:

source - the node UUID

clear

public void clear(UUID source,
                  JIPipeProjectCacheState stateId)

Removes an algorithm from the cache

Parameters:

source - the node UUID

stateId - state id

clear

public void clear()

Removes everything from the cache

autoClean

public void autoClean(boolean compareSlots,
                      boolean compareProjectStates,
                      JIPipeProgressInfo progressInfo)

Safely removes cache entries that are not accessible anymore (e.g. an algorithm was removed from the graph; or states where the slots do not exist anymore)

Parameters:

compareSlots - if true, states are removed if the output slots don't align with the current configuration anymore

compareProjectStates - if true, states that are not within the project anymore are also removed

progressInfo - the progress info

onAlgorithmRemoved

public void onAlgorithmRemoved(JIPipeGraph.GraphChangedEvent event)

Listens to changes in the algorithm graph. Triggers autoClean with only removing invalid algorithms

Parameters:

event - the event

getEventBus

public EventBus getEventBus()

getCachedRowNumber

public int getCachedRowNumber()

Returns the number of cached data rows

Returns:

the number of cached data rows

getCachedDataTypes

public Map<JIPipeDataInfo,Integer> getCachedDataTypes()

Returns statistics on how many rows of given data type have been cached

Returns:

statistics on how many rows of given data type have been cached

isEmpty

public boolean isEmpty()

size

public int size()

makeVirtual

public void makeVirtual(JIPipeProgressInfo progress)

Makes the whole cache virtual

Parameters:

progress - the progress

makeNonVirtual

public void makeNonVirtual(JIPipeProgressInfo progress)

Makes the whole cache virtual

Parameters:

progress - the progress