Package org.openrefine.history

Class HistoryEntryManager

java.lang.Object

org.openrefine.history.HistoryEntryManager

public class HistoryEntryManager
extends Object

A utility class to load and save project histories.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	HistoryEntryManager.Metadata	Utility class to help with Jackson deserialization

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CHANGE_SUBDIR
protected static String	GRID_CACHE_SUBDIR
protected static String	INCOMPLETE_CHANGE_SUBDIR
protected static String	INITIAL_GRID_SUBDIR
protected static String	METADATA_FILENAME

Constructor Summary

Constructors

Constructor	Description
HistoryEntryManager()

Method Summary

Modifier and Type	Method	Description
ChangeDataStore	getChangeDataStore(Runner runner, File projectDir)	The change data store associated with a project
GridCache	getGridCache(Runner runner, File projectDir)	The place where to store cached intermediate grids.
History	load(Runner runner, File dir, long projectId)
void	save(History history, File dir, ProgressReporter progressReporter)	Saves the history and the initial grid to a directory.

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_GRID_SUBDIR

protected static final String INITIAL_GRID_SUBDIR

See Also:

Constant Field Values

METADATA_FILENAME

protected static final String METADATA_FILENAME

See Also:

Constant Field Values

CHANGE_SUBDIR

protected static final String CHANGE_SUBDIR

See Also:

Constant Field Values

INCOMPLETE_CHANGE_SUBDIR

protected static final String INCOMPLETE_CHANGE_SUBDIR

See Also:

Constant Field Values

GRID_CACHE_SUBDIR

protected static final String GRID_CACHE_SUBDIR

See Also:

Constant Field Values

Constructor Detail

HistoryEntryManager

public HistoryEntryManager()

Method Detail

save

public void save(History history,
                 File dir,
                 ProgressReporter progressReporter)
          throws IOException

Saves the history and the initial grid to a directory.

Parameters:

dir - the directory where the history should be saved.

progressReporter -

Throws:

IOException

load

public History load(Runner runner,
                    File dir,
                    long projectId)
             throws IOException,
                    OperationException

Throws:

IOException

OperationException

getChangeDataStore

public ChangeDataStore getChangeDataStore(Runner runner,
                                          File projectDir)

The change data store associated with a project

Parameters:

projectDir - the root project directory

getGridCache

public GridCache getGridCache(Runner runner,
                              File projectDir)

The place where to store cached intermediate grids.