Class LocalProject

java.lang.Object

ca.phon.project.AbstractProject

ca.phon.project.LocalProject

All Implemented Interfaces:

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

Direct Known Subclasses:

DesktopProject, ShadowProject

public class LocalProject
extends AbstractProject
implements ProjectRefresh, SessionTemplate, SessionDetails, ProjectPaths, ProjectResources, ProjectMediaFolders, MutableProject, ProjectDeprecated

A local on-disk project. Corpora are stored in subfolders of the project folder. The project folder is the root of the project.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CORPUS_DESC_FILE	Corpus description file
static final String	PREV_PROJECT_PROPERTIES_FILE	Deprecated.
static final String	PROJECT_FILE_EXT	Phon project extension, in Phon 4.x and later this is used in place of the properties file.
static final String	PROJECT_PROPERTIES_FILE	Deprecated.
static final String	PROJECT_RES_FOLDER	Project resources folder
static final String	sessionTemplateFile	Session template filename

Fields inherited from class ca.phon.project.AbstractProject

PROJECT_XML_FILE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LocalProject(File projectFolder)

Method Summary

Modifier and Type	Method	Description
void	addCorpus(String name)	Add corpus folder with given name
void	addCorpus(String name, String description)	Add a new corpus with the specified name.
void	addProjectMediaFolder(int index, String mediaFolder)	Add a media folder to the project at the specified index
void	addProjectMediaFolder(String mediaFolder)	Add a media folder to the project
protected void	checkSessionWriteLock(String corpus, String session, SessionWriteLock writeLock)	Checks given session write lock
Session	createSessionFromTemplate(String corpus, String session)	Create a new session from the corpus template (if it exists) This method will also add the session to the specified corpus.
List<String>	getCorpora()	Deprecated.
String	getCorpusDescription(String corpus)	Get the description of the specified corpus.
File	getCorpusFolder(String corpus)
Iterator<String>	getCorpusIterator()	Get an iterator over the corpora in this project.
String	getCorpusMediaFolder(String corpus)	Deprecated.
String	getCorpusPath(String corpus)	Return the path to the given corpus.
List<String>	getCorpusSessions(String corpus)	Deprecated.
String	getLocation()	The location of the project.
String	getName()	The name of the project.
Set<Participant>	getParticipants(Collection<SessionPath> sessions)	Return a set of participants which are found in the given collection of Sessions.
String	getProjectMediaFolder()	Deprecated.
List<String>	getProjectMediaFolders()	Get all media folders for the project
InputStream	getResourceInputStream(String resourceName)	Get an input stream for the specified project resource.
String	getResourceLocation()	Get location of project resources folder.
OutputStream	getResourceOutputStream(String resourceName)	Get an output stream for the specified resource.
long	getSessionByteSize(Session session)	Returns the size on disk for the given session.
long	getSessionByteSize(String corpus, String session)	Returns the size on disk for the given session.
File	getSessionFile(String corpus, String session)
Iterator<String>	getSessionIterator(String corpus)	Get an iterator over the sessions in the specified corpus.
ZonedDateTime	getSessionModificationTime(Session session)	Returns the modification date for the given session
ZonedDateTime	getSessionModificationTime(String corpus, String session)	Returns the modification date for the specified session.
String	getSessionPath(Session session)	Get path to the given session.
String	getSessionPath(String corpus, String session)	Get path to the given session.
Session	getSessionTemplate(String corpus)	Get the Session template for the given corpus.
SessionWriteLock	getSessionWriteLock(Session session)	Get a write lock for a session.
SessionWriteLock	getSessionWriteLock(String corpus, String session)	Get a write lock for a session.
UUID	getUUID()	Project UUID UUID for the project
String	getVersion()	Project version
boolean	hasCorpus(String corpus)	Tests to see if a given corpus exists in the project.
boolean	hasCustomCorpusMediaFolder(String corpus)	Deprecated.
boolean	hasCustomProjectMediaFolder()	Has a custom project media folder been assigned
boolean	hasSession(String corpus, String session)	Test if a given session exists in the specified corpus.
boolean	isSessionLocked(Session session)	Tells whether the given session is locked
boolean	isSessionLocked(String corpus, String session)	Tells wheater the given session is locked
int	numberOfRecordsInSession(String corpus, String session)	Returns the number of records in a session w/o opening the session.
Session	openSession(String corpus, String session)	Open the specified session.
Session	openSession(String corpus, String session, SessionReader reader)	Open specified session using the provided reader.
void	refresh()	Refresh the corpus/session information for a project.
void	releaseSessionWriteLock(Session session, SessionWriteLock writeLock)	Release the write lock for a session.
void	releaseSessionWriteLock(String corpus, String session, SessionWriteLock writeLock)	Release the write lock for a session.
void	removeCorpus(String corpus)	Delete the specified corpus and all sessions it contains.
void	removeProjectMediaFolder(String mediaFolder)	Remove a media folder from the project
void	removeSession(Session session, SessionWriteLock writeLock)	Remove a session from the project.
void	removeSession(String corpus, String session, SessionWriteLock writeLock)	Remove a session from the project.
void	renameCorpus(String corpus, String newName)	Rename a corpus
protected void	saveProjectData()	Save project data
void	saveSession(Session session, SessionWriteLock writeLock)	Save a session with the provided writeLock.
void	saveSession(String corpus, String sessionName, Session session, SessionWriteLock writeLock)	Save a session to the specified corpus and new sessionName.
void	saveSession(String corpus, String sessionName, Session session, SessionWriter writer, SessionWriteLock writeLock)	Save a session writing the file using the given writer.
void	saveSessionTemplate(String corpus, Session template)	Save the Session template for the given corpus.
void	setCorpusDescription(String corpus, String description)	Set the description for the specified corpus.
void	setCorpusMediaFolder(String corpus, String mediaFolder)	Deprecated.
void	setCorpusPath(String corpus, String path)	Set path of corpus.
void	setName(String name)	Set project name
void	setProjectMediaFolder(String mediaFolder)	Deprecated.
void	setResourceLocation(String location)
void	setUUID(UUID uuid)	Set project UUID
String	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

Field Details

PREV_PROJECT_PROPERTIES_FILE

@Deprecated
public static final String PREV_PROJECT_PROPERTIES_FILE

Deprecated.

Project XML file (Phon 2.x and earlier)

See Also:

• Constant Field Values

PROJECT_PROPERTIES_FILE

@Deprecated
public static final String PROJECT_PROPERTIES_FILE

Deprecated.

Project properties file (Phon 3.x)

See Also:

• Constant Field Values

PROJECT_FILE_EXT

public static final String PROJECT_FILE_EXT

Phon project extension, in Phon 4.x and later this is used in place of the properties file. The format of this file is JSON.

The filename will be the project name with a .phonproj extension. This file will only be created when opening an existing Phon 3.x project with a project.properties file; or when a value is written to the file. Double-clicking on a .phonproj file should open the project in Phon.

See Also:

• Constant Field Values

sessionTemplateFile

public static final String sessionTemplateFile

Session template filename

See Also:

• Constant Field Values

PROJECT_RES_FOLDER

public static final String PROJECT_RES_FOLDER

Project resources folder

See Also:

• Constant Field Values

CORPUS_DESC_FILE

public static final String CORPUS_DESC_FILE

Corpus description file

See Also:

• Constant Field Values

Constructor Details

LocalProject

protected LocalProject(File projectFolder)
                throws ProjectConfigurationException

Parameters:

projectFolder -

Throws:

ProjectConfigurationException

Method Details

saveProjectData

protected void saveProjectData()
                        throws IOException

Save project data

Throws:

IOException

getVersion

public String getVersion()

Project version

Specified by:

getVersion in interface Project

Returns:

the project version or 'unk' if not known

getLocation

public String getLocation()

Description copied from interface: ProjectPaths

The location of the project. Meaning is dependent on implementation. For LocalProjects this is the path to the project on disk.

Specified by:

getLocation in interface ProjectPaths

Returns:

the project location

getName

public String getName()

Description copied from interface: Project

The name of the project.

Specified by:

getName in interface Project

Returns:

project name

setName

public void setName(String name)

Description copied from interface: MutableProject

Set project name

Specified by:

setName in interface MutableProject

Parameters:

name - must match pattern '[ \w\d-]+'

getUUID

public UUID getUUID()

Description copied from interface: Project

Project UUID UUID for the project

Specified by:

getUUID in interface Project

Returns:

uuid

setUUID

public void setUUID(UUID uuid)

Description copied from interface: MutableProject

Set project UUID

Specified by:

setUUID in interface MutableProject

Parameters:

uuid - UUID for the project

addCorpus

public void addCorpus(String name)
               throws IOException

Description copied from interface: MutableProject

Add corpus folder with given name

Specified by:

addCorpus in interface MutableProject

Parameters:

name - the name of the corpus

Throws:

IOException

addCorpus

public void addCorpus(String name,
 String description)
               throws IOException

Description copied from interface: MutableProject

Add a new corpus with the specified name.

Specified by:

addCorpus in interface MutableProject

Parameters:

name - the name of the corpus

description - the description of the corpus

Throws:

IOException - if the corpus could not be created

renameCorpus

public void renameCorpus(String corpus,
 String newName)
                  throws IOException

Description copied from interface: MutableProject

Rename a corpus

Specified by:

renameCorpus in interface MutableProject

Parameters:

corpus - the corpus to rename

newName - the new name for the corpus

Throws:

IOException - if the corpus could not be renamed

removeCorpus

public void removeCorpus(String corpus)
                  throws IOException

Description copied from interface: MutableProject

Delete the specified corpus and all sessions it contains.

Specified by:

removeCorpus in interface MutableProject

Parameters:

corpus - the corpus to delete

Throws:

IOException - if the corpus could not be deleted

setCorpusDescription

public void setCorpusDescription(String corpus,
 String description)

Description copied from interface: MutableProject

Set the description for the specified corpus.

Specified by:

setCorpusDescription in interface MutableProject

Parameters:

corpus - the corpus name

description - the description of the corpus

getSessionWriteLock

public SessionWriteLock getSessionWriteLock(Session session)
                                     throws IOException

Description copied from interface: MutableProject

Get a write lock for a session. Before writing a write lock must be obtained from the project. Example:

     try(SessionWriteLock writeLock = project.getSessionWriteLock(session)) {
      // do some work with the session
     } catch (IOException e) {
      // handle exception
     }
 

Specified by:

getSessionWriteLock in interface MutableProject

Parameters:

session - the session to lock

Returns:

the session write lock or invalid input: '<' 0 if a write lock was not obtained

Throws:

IOException

getSessionWriteLock

public SessionWriteLock getSessionWriteLock(String corpus,
 String session)
                                     throws IOException

Description copied from interface: MutableProject

Get a write lock for a session. Before writing a write lock must be obtained from the project. See MutableProject.getSessionWriteLock(Session) for more information on how to use the write lock.

Specified by:

getSessionWriteLock in interface MutableProject

Parameters:

corpus - the corpus name

session - the session to lock

Returns:

the session write lock or null

Throws:

IOException

releaseSessionWriteLock

public void releaseSessionWriteLock(Session session,
 SessionWriteLock writeLock)
                             throws IOException

Description copied from interface: MutableProject

Release the write lock for a session. See MutableProject.getSessionWriteLock(Session) for more information on how to use the write lock.

Specified by:

releaseSessionWriteLock in interface MutableProject

Parameters:

session - the session to unlock

writeLock - the write lock to release

Throws:

IOException

releaseSessionWriteLock

public void releaseSessionWriteLock(String corpus,
 String session,
 SessionWriteLock writeLock)
                             throws IOException

Description copied from interface: MutableProject

Release the write lock for a session. See MutableProject.releaseSessionWriteLock(Session, SessionWriteLock) for more information on how to use the write lock.

Specified by:

releaseSessionWriteLock in interface MutableProject

Parameters:

session - the session to unlock

writeLock - the write lock to release

Throws:

IOException

isSessionLocked

public boolean isSessionLocked(Session session)

Description copied from interface: MutableProject

Tells whether the given session is locked

Specified by:

isSessionLocked in interface MutableProject

Parameters:

session - the session to check

Returns:

true if session is locked, false otherwise

isSessionLocked

public boolean isSessionLocked(String corpus,
 String session)

Description copied from interface: MutableProject

Tells wheater the given session is locked

Specified by:

isSessionLocked in interface MutableProject

Parameters:

corpus - the corpus name

session - the session name

Returns:

true if the session is locked, false otherwise

saveSession

public void saveSession(Session session,
 SessionWriteLock writeLock)
                 throws IOException

Description copied from interface: MutableProject

Save a session with the provided writeLock. Example:

     try(SessionWriteLock writeLock = project.getSessionWriteLock(session)) {
      project.saveSession(session, writeLock);
     } catch (IOException e) {
      // handle exception
     }
     

The write lock is auto-closeable and will be released when the try block is exited. To manually release the write lock, call the MutableProject.releaseSessionWriteLock(Session, SessionWriteLock) method or use the close() method on the write lock.

Specified by:

saveSession in interface MutableProject

Parameters:

session - the session to save

writeLock - the write lock for the session

Throws:

IOException

saveSession

public void saveSession(String corpus,
 String sessionName,
 Session session,
 SessionWriteLock writeLock)
                 throws IOException

Description copied from interface: MutableProject

Save a session to the specified corpus and new sessionName. See MutableProject.saveSession(Session, SessionWriteLock) for more information on how to use the write lock.

Specified by:

saveSession in interface MutableProject

Parameters:

corpus - the corpus name

sessionName - the name of the session

session - the session to save

writeLock - the write lock for the session

Throws:

IOException

saveSession

public void saveSession(String corpus,
 String sessionName,
 Session session,
 SessionWriter writer,
 SessionWriteLock writeLock)
                 throws IOException

Description copied from interface: MutableProject

Save a session writing the file using the given writer. See MutableProject.saveSession(Session, SessionWriteLock) for more information on how to use the write lock.

Specified by:

saveSession in interface MutableProject

Parameters:

corpus - the corpus name

sessionName - the name of the session

session - the session to save

writer - the session writer to use

writeLock - the write lock for the session

Throws:

IOException

removeSession

public void removeSession(Session session,
 SessionWriteLock writeLock)
                   throws IOException

Description copied from interface: MutableProject

Remove a session from the project. The writeLock for the session is also released. See MutableProject.removeSession(Session, SessionWriteLock) for more information on how to use the write lock.

Specified by:

removeSession in interface MutableProject

Parameters:

session - the session to remove

writeLock - the write lock for the session

Throws:

IOException

checkSessionWriteLock

protected void checkSessionWriteLock(String corpus,
 String session,
 SessionWriteLock writeLock)
                              throws IOException

Checks given session write lock

Throws:

IOException - if the write lock is not valid

removeSession

public void removeSession(String corpus,
 String session,
 SessionWriteLock writeLock)
                   throws IOException

Description copied from interface: MutableProject

Remove a session from the project. The writeLock for the session is also released. See MutableProject.removeSession(Session, SessionWriteLock) for more information on how to use the write lock.

Specified by:

removeSession in interface MutableProject

Parameters:

session - the session to remove

writeLock - the write lock for the session

Throws:

IOException

getCorpusIterator

public Iterator<String> getCorpusIterator()

Description copied from interface: Project

Get an iterator over the corpora in this project.

Specified by:

getCorpusIterator in interface Project

Returns:

iterator over corpora

hasCorpus

public boolean hasCorpus(String corpus)

Description copied from interface: Project

Tests to see if a given corpus exists in the project. This may be faster than calling Project.getCorpusIterator() and checking iteratively.

Specified by:

hasCorpus in interface Project

Parameters:

corpus -

Returns:

true if the corpus exists, false

getCorpusDescription

public String getCorpusDescription(String corpus)

Description copied from interface: Project

Get the description of the specified corpus.

Specified by:

getCorpusDescription in interface Project

Parameters:

corpus - the corpus name

getSessionIterator

public Iterator<String> getSessionIterator(String corpus)

Description copied from interface: Project

Get an iterator over the sessions in the specified corpus.

Specified by:

getSessionIterator in interface Project

Parameters:

corpus -

Returns:

iterator over sessions in the corpus

hasSession

public boolean hasSession(String corpus,
 String session)

Description copied from interface: Project

Test if a given session exists in the specified corpus. This method is usually faster than calling Project.getSessionIterator(String) and checking iteratively.

Specified by:

hasSession in interface Project

Parameters:

corpus - the corpus name

session - the session name

Returns:

true if the session exists, false otherwise

getCorpusPath

public String getCorpusPath(String corpus)

Description copied from interface: ProjectPaths

Return the path to the given corpus.

Specified by:

getCorpusPath in interface ProjectPaths

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

Parameters:

corpus - the corpus name

path - the new path for the corpus

getParticipants

public Set<Participant> getParticipants(Collection<SessionPath> sessions)

Description copied from interface: Project

Return a set of participants which are found in the given collection of Sessions. The participant objects returned by this method will include the ParticipantHistory extension. Participants from two sessions are considered to be the same if their ids, names and roles match. If the speaker for some records is unidenified, a clone of Participant.UNKOWN will be added in the returned set.

Specified by:

getParticipants in interface Project

Parameters:

sessions -

Returns:

a set of participants

openSession

public Session openSession(String corpus,
 String session)
                    throws IOException

Description copied from interface: Project

Open the specified session. This will create a new session object with the data currently on the storage device.

Specified by:

openSession in interface Project

Parameters:

corpus -

session -

Returns:

the session

Throws:

IOException

openSession

public Session openSession(String corpus,
 String session,
 SessionReader reader)
                    throws IOException

Description copied from interface: Project

Open specified session using the provided reader.

Specified by:

openSession in interface Project

Parameters:

corpus -

session -

reader -

Returns:

the session

Throws:

IOException

getSessionPath

public String getSessionPath(Session session)

Description copied from interface: ProjectPaths

Get path to the given session.

Specified by:

getSessionPath in interface ProjectPaths

Parameters:

session -

Returns:

path to given session

getSessionPath

public String getSessionPath(String corpus,
 String session)

Description copied from interface: ProjectPaths

Get path to the given session.

Specified by:

getSessionPath in interface ProjectPaths

Parameters:

corpus -

session -

Returns:

path to given session

getSessionFile

public File getSessionFile(String corpus,
 String session)

getCorpusFolder

public File getCorpusFolder(String corpus)

hasCustomProjectMediaFolder

public boolean hasCustomProjectMediaFolder()

Description copied from interface: ProjectMediaFolders

Has a custom project media folder been assigned

Specified by:

hasCustomProjectMediaFolder in interface ProjectMediaFolders

Returns:

true if project folder has been customized

getProjectMediaFolders

public List<String> getProjectMediaFolders()

Description copied from interface: ProjectMediaFolders

Get all media folders for the project

Specified by:

getProjectMediaFolders in interface ProjectMediaFolders

Returns:

list of media folders

addProjectMediaFolder

public void addProjectMediaFolder(String mediaFolder)

Description copied from interface: ProjectMediaFolders

Add a media folder to the project

Specified by:

addProjectMediaFolder in interface ProjectMediaFolders

Parameters:

mediaFolder -

addProjectMediaFolder

public void addProjectMediaFolder(int index,
 String mediaFolder)

Description copied from interface: ProjectMediaFolders

Add a media folder to the project at the specified index

Specified by:

addProjectMediaFolder in interface ProjectMediaFolders

Parameters:

index -

mediaFolder -

removeProjectMediaFolder

public void removeProjectMediaFolder(String mediaFolder)

Description copied from interface: ProjectMediaFolders

Remove a media folder from the project

Specified by:

removeProjectMediaFolder in interface ProjectMediaFolders

Parameters:

mediaFolder -

getResourceLocation

public String getResourceLocation()

Description copied from interface: ProjectResources

Get location of project resources folder.

Specified by:

getResourceLocation in interface ProjectResources

Returns:

location of project resources folder

setResourceLocation

public void setResourceLocation(String location)

getResourceInputStream

public InputStream getResourceInputStream(String resourceName)
                                   throws IOException

Description copied from interface: ProjectResources

Get an input stream for the specified project resource. The resource name should be a relative path including filename. E.g., 'ca.phon.myplugin/module/corpus/session.dat'

Specified by:

getResourceInputStream in interface ProjectResources

Parameters:

resourceName -

Returns:

an input stream for the specified resource

Throws:

IOException

getResourceOutputStream

public OutputStream getResourceOutputStream(String resourceName)
                                     throws IOException

Description copied from interface: ProjectResources

Get an output stream for the specified resource. If the resource does not exist, it is created. If the resource already exists, it is overwritten.

Specified by:

getResourceOutputStream in interface ProjectResources

Parameters:

resourceName -

Returns:

output stream for the specified resource

Throws:

IOException

getSessionTemplate

public Session getSessionTemplate(String corpus)
                           throws IOException

Description copied from interface: SessionTemplate

Get the Session template for the given corpus.

Specified by:

getSessionTemplate in interface SessionTemplate

Parameters:

corpus -

Returns:

session template or null if not found

Throws:

IOException

saveSessionTemplate

public void saveSessionTemplate(String corpus,
 Session template)
                         throws IOException

Description copied from interface: SessionTemplate

Save the Session template for the given corpus.

Specified by:

saveSessionTemplate in interface SessionTemplate

Parameters:

corpus -

template -

Throws:

IOException

createSessionFromTemplate

public Session createSessionFromTemplate(String corpus,
 String session)
                                  throws IOException

Description copied from interface: SessionTemplate

Create a new session from the corpus template (if it exists) This method will also add the session to the specified corpus.

Specified by:

createSessionFromTemplate in interface SessionTemplate

Parameters:

corpus -

session -

Returns:

new Session object

Throws:

IOException

getSessionModificationTime

public ZonedDateTime getSessionModificationTime(Session session)

Description copied from interface: SessionDetails

Returns the modification date for the given session

Specified by:

getSessionModificationTime in interface SessionDetails

Parameters:

session -

Returns:

session modification date in system time zone

getSessionModificationTime

public ZonedDateTime getSessionModificationTime(String corpus,
 String session)

Description copied from interface: SessionDetails

Returns the modification date for the specified session.

Specified by:

getSessionModificationTime in interface SessionDetails

Parameters:

corpus -

session -

Returns:

session modification date in system time zone

getSessionByteSize

public long getSessionByteSize(Session session)

Description copied from interface: SessionDetails

Returns the size on disk for the given session.

Specified by:

getSessionByteSize in interface SessionDetails

Parameters:

session -

Returns:

session size in bytes

getSessionByteSize

public long getSessionByteSize(String corpus,
 String session)

Description copied from interface: SessionDetails

Returns the size on disk for the given session.

Specified by:

getSessionByteSize in interface SessionDetails

Parameters:

corpus -

session -

Returns:

session size in bytes

numberOfRecordsInSession

public int numberOfRecordsInSession(String corpus,
 String session)
                             throws IOException

Description copied from interface: SessionDetails

Returns the number of records in a session w/o opening the session. This method is faster than using openSession(corpus, session).numberOfRecords()

Specified by:

numberOfRecordsInSession in interface SessionDetails

Parameters:

session -

Returns:

number of records in the session

Throws:

IOException

getCorpora

@Deprecated
public List<String> getCorpora()

Deprecated.

Description copied from interface: ProjectDeprecated

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

Specified by:

getCorpora in interface ProjectDeprecated

Returns:

list of corpora

getProjectMediaFolder

@Deprecated
public String getProjectMediaFolder()

Deprecated.

Description copied from interface: ProjectDeprecated

Get the media folders for the project, if any are set. If multiple media folders are set, the first one is returned.

Specified by:

getProjectMediaFolder in interface ProjectDeprecated

setProjectMediaFolder

@Deprecated
public void setProjectMediaFolder(String mediaFolder)

Deprecated.

Description copied from interface: ProjectDeprecated

Set media folder for project, if any are set. If multiple media folders are set, then all are removed and the new folder is added.

Specified by:

setProjectMediaFolder in interface ProjectDeprecated

Parameters:

mediaFolder - If null sets the media folder back to default.

hasCustomCorpusMediaFolder

@Deprecated
public boolean hasCustomCorpusMediaFolder(String corpus)

Deprecated.

Description copied from interface: ProjectDeprecated

Has a custom corpus media folder been assigned

Specified by:

hasCustomCorpusMediaFolder in interface ProjectDeprecated

Parameters:

corpus -

Returns:

true if a custom media folder is assigned for the given corpus

getCorpusMediaFolder

@Deprecated
public String getCorpusMediaFolder(String corpus)

Deprecated.

Description copied from interface: ProjectDeprecated

Get the media folder for the specified corpus.

Specified by:

getCorpusMediaFolder in interface ProjectDeprecated

Returns:

mediaFolder or the project media folder if not specified

setCorpusMediaFolder

@Deprecated
public void setCorpusMediaFolder(String corpus,
 String mediaFolder)

Deprecated.

Description copied from interface: ProjectDeprecated

Set the media folder for the specified corpus.

Specified by:

setCorpusMediaFolder in interface ProjectDeprecated

Parameters:

mediaFolder - the media folder to set

getCorpusSessions

@Deprecated
public List<String> getCorpusSessions(String corpus)

Deprecated.

Description copied from interface: ProjectDeprecated

Get the session names contained in a corpus in alphabetical order.

Specified by:

getCorpusSessions in interface ProjectDeprecated

Parameters:

corpus - the corpus to get sessions for

Returns:

the list of sessions in the specified corpus

refresh

public void refresh()

Description copied from interface: ProjectRefresh

Refresh the corpus/session information for a project.

Specified by:

refresh in interface ProjectRefresh

toString

public String toString()

Overrides:

toString in class Object