Package com.google.refine.io

Class FileProjectManager

java.lang.Object

com.google.refine.ProjectManager

com.google.refine.io.FileProjectManager

public class FileProjectManager
extends ProjectManager

Nested Class Summary

Nested classes/interfaces inherited from class com.google.refine.ProjectManager

ProjectManager.SaveRecord

Field Summary

Fields

Modifier and Type	Field	Description
protected File	_workspaceDir
protected static final String	PROJECT_DIR_SUFFIX
protected static boolean	projectRemoved
static final String	WORKSPACE_JSON
static final String	WORKSPACE_OLD_JSON
static final String	WORKSPACE_TEMP_JSON

Fields inherited from class com.google.refine.ProjectManager

_busy, _lookupCacheManager, _preferenceStore, _projects, _projectsMetadata, EXPRESSION_HISTORY_MAX, PROJECT_FLUSH_DELAY, QUICK_SAVE_MAX_TIME, singleton

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileProjectManager(File dir)

Method Summary

Modifier and Type	Method	Description
protected void	copyFile(File file, OutputStream os)	Deprecated. use Files.copy(Path, OutputStream)
protected static void	deleteDir(File dir)
void	deleteProject(long projectID)	Remove project from data store
void	exportProject(long projectId, org.apache.commons.compress.archivers.tar.TarArchiveOutputStream tos)	Export project to a Refine archive
HistoryEntryManager	getHistoryEntryManager()	The history entry manager deals with changes
protected List<Long>	getModifiedProjectIds()
File	getProjectDir(long projectID)
File	getProjectDir(long projectID, boolean createIfMissing)
static File	getProjectDir(File workspaceDir, long projectID)
static File	getProjectDir(File workspaceDir, long projectID, boolean createIfMissing)
Set<Long>	getProjectIds()
File	getWorkspaceDir()
static void	gzipTarToOutputStream(Project project, OutputStream os)
void	importProject(long projectID, InputStream inputStream, boolean gziped)	Import project from a Refine archive
static void	initialize(File dir)
protected void	load()
protected boolean	loadFromFile(File file)
Project	loadProject(long id)	Loads a project from the data store into memory
boolean	loadProjectMetadata(long projectID)	Import an external project that has been received as a .tar file, expanded, and copied into our workspace directory.
protected void	loadProjects(List<Long> projectIDs)
protected void	recover()
void	saveMetadata(ProjectMetadata metadata, long projectId)	Save project metadata to the data store
protected void	saveProject(Project project)	Save project to the data store
protected void	saveProjectMetadata(List<Long> modified)
protected void	saveToFile(File file)
protected void	saveWorkspace()	Save the workspace's data out to file in a safe way: save to a temporary file first and rename it to the real file.
protected void	setExpressions(TopList newExpressions)
protected void	setPreferences(PreferenceStore preferences)
protected void	tarDir(String relative, File dir, org.apache.commons.compress.archivers.tar.TarArchiveOutputStream tos)
protected void	untar(File destDir, InputStream inputStream)

Methods inherited from class com.google.refine.ProjectManager

addLatestExpression, addProjectTags, deleteProject, dispose, disposeUnmodifiedProjects, ensureProjectSaved, getAllProjectMetadata, getAllProjectsTags, getAllProjectTags, getExpressions, getLookupCacheManager, getPreferenceStore, getProject, getProjectID, getProjectMetadata, getProjectMetadata, mergeEmptyUserMetadata, preparePreferenceStore, registerProject, removeProject, removeProjectTags, save, saveProjects, setBusy

Methods inherited from class java.lang.Object

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

Field Details

PROJECT_DIR_SUFFIX

protected static final String PROJECT_DIR_SUFFIX

See Also:

• Constant Field Values

WORKSPACE_JSON

public static final String WORKSPACE_JSON

See Also:

• Constant Field Values

WORKSPACE_OLD_JSON

public static final String WORKSPACE_OLD_JSON

See Also:

• Constant Field Values

WORKSPACE_TEMP_JSON

public static final String WORKSPACE_TEMP_JSON

See Also:

• Constant Field Values

_workspaceDir

protected File _workspaceDir

projectRemoved

protected static boolean projectRemoved

Constructor Details

FileProjectManager

protected FileProjectManager(File dir)

Method Details

initialize

public static void initialize(File dir)

getWorkspaceDir

public File getWorkspaceDir()

getProjectDir

public static File getProjectDir(File workspaceDir,
 long projectID)

getProjectDir

public static File getProjectDir(File workspaceDir,
 long projectID,
 boolean createIfMissing)

getProjectDir

public File getProjectDir(long projectID)

getProjectDir

public File getProjectDir(long projectID,
 boolean createIfMissing)

loadProjectMetadata

public boolean loadProjectMetadata(long projectID)

Import an external project that has been received as a .tar file, expanded, and copied into our workspace directory.

Specified by:

loadProjectMetadata in class ProjectManager

Parameters:

projectID -

Returns:

importProject

public void importProject(long projectID,
 InputStream inputStream,
 boolean gziped)
                   throws IOException

Description copied from class: ProjectManager

Import project from a Refine archive

Specified by:

importProject in class ProjectManager

Throws:

IOException

untar

protected void untar(File destDir,
 InputStream inputStream)
              throws IOException

Throws:

IOException

exportProject

public void exportProject(long projectId,
 org.apache.commons.compress.archivers.tar.TarArchiveOutputStream tos)
                   throws IOException

Description copied from class: ProjectManager

Export project to a Refine archive

Specified by:

exportProject in class ProjectManager

Throws:

IOException

tarDir

protected void tarDir(String relative,
 File dir,
 org.apache.commons.compress.archivers.tar.TarArchiveOutputStream tos)
               throws IOException

Throws:

IOException

copyFile

@Deprecated(since="3.9")
protected void copyFile(File file,
 OutputStream os)
                 throws IOException

Deprecated.

use Files.copy(Path, OutputStream)

Throws:

IOException

saveMetadata

public void saveMetadata(ProjectMetadata metadata,
 long projectId)
                  throws Exception

Description copied from class: ProjectManager

Save project metadata to the data store

Specified by:

saveMetadata in class ProjectManager

Throws:

Exception

saveProject

protected void saveProject(Project project)
                    throws IOException

Description copied from class: ProjectManager

Save project to the data store

Specified by:

saveProject in class ProjectManager

Throws:

IOException

loadProject

public Project loadProject(long id)

Description copied from class: ProjectManager

Loads a project from the data store into memory

Specified by:

loadProject in class ProjectManager

Returns:

saveWorkspace

protected void saveWorkspace()

Save the workspace's data out to file in a safe way: save to a temporary file first and rename it to the real file.

Specified by:

saveWorkspace in class ProjectManager

getModifiedProjectIds

protected List<Long> getModifiedProjectIds()

saveProjectMetadata

protected void saveProjectMetadata(List<Long> modified)
                            throws IOException

Throws:

IOException

saveToFile

protected void saveToFile(File file)
                   throws IOException

Throws:

IOException

deleteProject

public void deleteProject(long projectID)

Description copied from class: ProjectManager

Remove project from data store

Specified by:

deleteProject in class ProjectManager

deleteDir

protected static void deleteDir(File dir)

load

protected void load()

loadFromFile

protected boolean loadFromFile(File file)

recover

protected void recover()

getHistoryEntryManager

public HistoryEntryManager getHistoryEntryManager()

Description copied from class: ProjectManager

The history entry manager deals with changes

Specified by:

getHistoryEntryManager in class ProjectManager

Returns:

manager for handling history

gzipTarToOutputStream

public static void gzipTarToOutputStream(Project project,
 OutputStream os)
                                  throws IOException

Throws:

IOException

getProjectIds

public Set<Long> getProjectIds()

loadProjects

protected void loadProjects(List<Long> projectIDs)

setPreferences

protected void setPreferences(PreferenceStore preferences)

setExpressions

protected void setExpressions(TopList newExpressions)