Package org.openrefine.model

Class Project

java.lang.Object

org.openrefine.model.Project

public class Project
extends Object

A project is a table with overlay models and full edit history. This is the central concept of the OpenRefine data model - most operations are done within a given project.

Constructor Summary

Constructors

Constructor	Description
Project(long id, History history)	Restores a project from a saved state.
Project(long projectId, Grid initialState, ChangeDataStore dataStore, GridCache gridStore)	Creates a new project from an initial grid and a project id.
Project(Grid initialState, ChangeDataStore dataStore, GridCache gridStore)	Creates a new project from an initial grid.

Method Summary

Modifier and Type	Method	Description
void	dispose()
static long	generateID()
ColumnModel	getColumnModel()	Convenience function to return the current column model from the history.
Grid	getCurrentGrid()	Convenience function to return the current grid.
History	getHistory()
long	getId()
Instant	getLastModified()
Instant	getLastSave()
ProjectMetadata	getMetadata()
Map<String,OverlayModel>	getOverlayModels()	Convenience function to return the current overlay models
ProcessManager	getProcessManager()
static void	registerOverlayModel(String name, Class<? extends OverlayModel> klass)	Deprecated. use OverlayModelResolver
void	setLastSave()	Sets the lastSave time to now

Methods inherited from class java.lang.Object

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

Constructor Detail

Project

public Project(Grid initialState,
               ChangeDataStore dataStore,
               GridCache gridStore)

Creates a new project from an initial grid.

Parameters:

initialState - the initial state of the project.

Project

public Project(long projectId,
               Grid initialState,
               ChangeDataStore dataStore,
               GridCache gridStore)

Creates a new project from an initial grid and a project id.

Parameters:

projectId - the project identifier

initialState - the initial state of the project

Project

public Project(long id,
               History history)

Restores a project from a saved state.

Method Detail

getLastSave

public Instant getLastSave()

setLastSave

public void setLastSave()

Sets the lastSave time to now

getLastModified

public Instant getLastModified()

getMetadata

public ProjectMetadata getMetadata()

getProcessManager

public ProcessManager getProcessManager()

getHistory

public History getHistory()

generateID

public static long generateID()

getId

public long getId()

dispose

public void dispose()

getColumnModel

public ColumnModel getColumnModel()

Convenience function to return the current column model from the history.

getCurrentGrid

public Grid getCurrentGrid()

Convenience function to return the current grid.

getOverlayModels

public Map<String,OverlayModel> getOverlayModels()

Convenience function to return the current overlay models

registerOverlayModel

@Deprecated
public static void registerOverlayModel(String name,
                                        Class<? extends OverlayModel> klass)

Deprecated.

use OverlayModelResolver