Class ShadowProject

java.lang.Object

ca.phon.project.AbstractProject

ca.phon.project.LocalProject

ca.phon.app.project.ShadowProject

All Implemented Interfaces:

IExtendable, MutableProject, Project, ProjectDeprecated, ProjectEvents, ProjectMediaFolders, ProjectPaths, ProjectRefresh, ProjectResources, SessionDetails, SessionTemplate

public final class ShadowProject
extends LocalProject

Shadow projects are used as temporary projects with the same data and properties as a delegate project. This is useful when running queries where some temporary files are stored inside the project folder.

Field Summary

Fields inherited from class ca.phon.project.LocalProject

CORPUS_DESC_FILE, PREV_PROJECT_PROPERTIES_FILE, PROJECT_FILE_EXT, PROJECT_PROPERTIES_FILE, PROJECT_RES_FOLDER, sessionTemplateFile

Fields inherited from class ca.phon.project.AbstractProject

PROJECT_XML_FILE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ShadowProject(File shadowFolder, Project project)

Method Summary

Modifier and Type	Method	Description
String	getCorpusPath(String corpus)	Return the path to the given corpus.
String	getName()	The name of the project.
static ShadowProject	of(Project project)	Create a new shadow project.
void	setCorpusPath(String corpus, String path)	Set path of corpus.

Methods inherited from class ca.phon.project.LocalProject

addCorpus, addCorpus, addProjectMediaFolder, addProjectMediaFolder, checkSessionWriteLock, createSessionFromTemplate, getCorpora, getCorpusDescription, getCorpusFolder, getCorpusIterator, getCorpusMediaFolder, getCorpusSessions, getLocation, getParticipants, getProjectMediaFolder, getProjectMediaFolders, getResourceInputStream, getResourceLocation, getResourceOutputStream, getSessionByteSize, getSessionByteSize, getSessionFile, getSessionIterator, getSessionModificationTime, getSessionModificationTime, getSessionPath, getSessionPath, getSessionTemplate, getSessionWriteLock, getSessionWriteLock, getUUID, getVersion, hasCorpus, hasCustomCorpusMediaFolder, hasCustomProjectMediaFolder, hasSession, isSessionLocked, isSessionLocked, numberOfRecordsInSession, openSession, openSession, refresh, releaseSessionWriteLock, releaseSessionWriteLock, removeCorpus, removeProjectMediaFolder, removeSession, removeSession, renameCorpus, saveProjectData, saveSession, saveSession, saveSession, saveSessionTemplate, setCorpusDescription, setCorpusMediaFolder, setName, setProjectMediaFolder, setResourceLocation, setUUID, toString

Methods inherited from class ca.phon.project.AbstractProject

addProjectListener, fireProjectDataChanged, fireProjectStructureChanged, fireProjectWriteLocksChanged, getExtension, getExtensions, getProjectListeners, putExtension, removeExtension, removeProjectListener

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowProject

protected ShadowProject(File shadowFolder,
 Project project)
                 throws ProjectConfigurationException

Throws:

ProjectConfigurationException

Method Details

of

public static ShadowProject of(Project project)
                        throws ProjectConfigurationException

Create a new shadow project.

Parameters:

project -

Returns:

shadow project

Throws:

ProjectConfigurationException

getCorpusPath

public String getCorpusPath(String corpus)

Description copied from interface: ProjectPaths

Return the path to the given corpus.

Specified by:

getCorpusPath in interface ProjectPaths

Overrides:

getCorpusPath in class LocalProject

Parameters:

corpus - the corpus name

Returns:

the path to the corpus, usually relative to the project

setCorpusPath

public void setCorpusPath(String corpus,
 String path)

Description copied from interface: ProjectPaths

Set path of corpus.

Specified by:

setCorpusPath in interface ProjectPaths

Overrides:

setCorpusPath in class LocalProject

Parameters:

corpus - the corpus name

path - the new path for the corpus

getName

public String getName()

Description copied from interface: Project

The name of the project.

Specified by:

getName in interface Project

Overrides:

getName in class LocalProject

Returns:

project name