Package ca.phon.app.project

Class ShadowProject

java.lang.Object

ca.phon.project.AbstractProject

ca.phon.project.LocalProject

ca.phon.app.project.ShadowProject

All Implemented Interfaces:

IExtendable, Project, ProjectRefresh

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_MEDIAFOLDER_PROP, PREV_PROJECT_PROPERTIES_FILE, PROJECT_MEDIAFOLDER_PROP, PROJECT_NAME_PROP, PROJECT_PROPERTIES_FILE, PROJECT_UUID_PROP

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
List<String>	getCorpora()	Get the list of corpora in this project.
String	getCorpusMediaFolder(String corpus)	Get the media folder for the specified corpus.
String	getCorpusPath(String corpus)	Return the path to the given corpus.
String	getName()	The name of the project.
String	getProjectMediaFolder()	Get media folder for 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, checkSessionWriteLock, createSessionFromTemplate, getCorpusDescription, getCorpusFolder, getCorpusSessions, getLocation, getParticipants, getResourceInputStream, getResourceLocation, getResourceOutputStream, getSessionByteSize, getSessionByteSize, getSessionFile, getSessionModificationTime, getSessionModificationTime, getSessionPath, getSessionPath, getSessionTemplate, getSessionWriteLock, getSessionWriteLock, getUUID, getVersion, hasCustomCorpusMediaFolder, hasCustomProjectMediaFolder, isSessionLocked, isSessionLocked, numberOfRecordsInSession, openSession, openSession, refresh, releaseSessionWriteLock, releaseSessionWriteLock, removeCorpus, removeSession, removeSession, renameCorpus, saveProjectData, saveProperties, 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, loadProjectData, 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:

preject -

Returns:

shadow project

Throws:

ProjectConfigurationException

getProjectMediaFolder

public String getProjectMediaFolder()

Description copied from interface: Project

Get media folder for the project.

Specified by:

getProjectMediaFolder in interface Project

Overrides:

getProjectMediaFolder in class LocalProject

getCorpusMediaFolder

public String getCorpusMediaFolder(String corpus)

Description copied from interface: Project

Get the media folder for the specified corpus.

Specified by:

getCorpusMediaFolder in interface Project

Overrides:

getCorpusMediaFolder in class LocalProject

Returns:

mediaFolder or the project media folder if not specified

getCorpusPath

public String getCorpusPath(String corpus)

Description copied from interface: Project

Return the path to the given corpus.

Specified by:

getCorpusPath in interface Project

Overrides:

getCorpusPath in class LocalProject

setCorpusPath

public void setCorpusPath(String corpus,
 String path)

Description copied from interface: Project

Set path of corpus.

Specified by:

setCorpusPath in interface Project

Overrides:

setCorpusPath in class LocalProject

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

getCorpora

public List<String> getCorpora()

Description copied from interface: Project

Get the list of corpora in this project. Corpus names are returned in alphabetical order.

Specified by:

getCorpora in interface Project

Overrides:

getCorpora in class LocalProject

Returns:

list of corpora