Package ca.phon.project

Class AbstractProject

java.lang.Object

ca.phon.project.AbstractProject

All Implemented Interfaces:

IExtendable, Project

Direct Known Subclasses:

LocalProject, RemoteProject

public abstract class AbstractProject
extends Object
implements Project

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	PROJECT_XML_FILE	Local projects no longer create this file but will read from it Remote projects require this file exists

Constructor Summary

Constructors

Constructor	Description
AbstractProject()

Method Summary

Modifier and Type	Method	Description
void	addProjectListener(ProjectListener listener)
void	fireProjectDataChanged(ProjectEvent pe)
void	fireProjectStructureChanged(ProjectEvent pe)
void	fireProjectWriteLocksChanged(ProjectEvent pe)
<T> T	getExtension(Class<T> cap)	Get the requested extension if available.
Set<Class<?>>	getExtensions()	Return all extension types supported
List<ProjectListener>	getProjectListeners()
protected ProjectType	loadProjectData(InputStream inputStream)	Load project data from the project.xml file.
<T> T	putExtension(Class<T> cap, T impl)	Add a new extension.
<T> T	removeExtension(Class<T> cap)	Remove a capability.
void	removeProjectListener(ProjectListener listener)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.phon.project.Project

addCorpus, createSessionFromTemplate, getCorpora, getCorpusDescription, getCorpusMediaFolder, getCorpusPath, getCorpusSessions, getLocation, getName, getParticipants, getProjectMediaFolder, getResourceInputStream, getResourceLocation, getResourceOutputStream, getSessionByteSize, getSessionByteSize, getSessionModificationTime, getSessionModificationTime, getSessionPath, getSessionPath, getSessionTemplate, getSessionWriteLock, getSessionWriteLock, getUUID, getVersion, hasCustomCorpusMediaFolder, hasCustomProjectMediaFolder, isSessionLocked, isSessionLocked, numberOfRecordsInSession, openSession, openSession, releaseSessionWriteLock, releaseSessionWriteLock, removeCorpus, removeSession, removeSession, renameCorpus, saveSession, saveSession, saveSession, saveSessionTemplate, setCorpusDescription, setCorpusMediaFolder, setCorpusPath, setName, setProjectMediaFolder, setResourceLocation, setUUID

Field Details

PROJECT_XML_FILE

protected static final String PROJECT_XML_FILE

Local projects no longer create this file but will read from it Remote projects require this file exists

See Also:

• Constant Field Values

Constructor Details

AbstractProject

public AbstractProject()

Method Details

loadProjectData

protected ProjectType loadProjectData(InputStream inputStream)
                               throws ProjectConfigurationException

Load project data from the project.xml file. If not found, empty project data is created.

Returns:

projectData

Throws:

ProjectConfigurationException

getExtensions

public Set<Class<?>> getExtensions()

Description copied from interface: IExtendable

Return all extension types supported

Specified by:

getExtensions in interface IExtendable

getExtension

public <T> T getExtension(Class<T> cap)

Description copied from interface: IExtendable

Get the requested extension if available.

Specified by:

getExtension in interface IExtendable

Returns:

the capability object or null if the cability is not available

putExtension

public <T> T putExtension(Class<T> cap,
 T impl)

Description copied from interface: IExtendable

Add a new extension.

Specified by:

putExtension in interface IExtendable

Parameters:

cap - the extension to add

Returns:

the added extension implementation

removeExtension

public <T> T removeExtension(Class<T> cap)

Description copied from interface: IExtendable

Remove a capability.

Specified by:

removeExtension in interface IExtendable

Parameters:

cap - the capability to remove

getProjectListeners

public List<ProjectListener> getProjectListeners()

Specified by:

getProjectListeners in interface Project

addProjectListener

public void addProjectListener(ProjectListener listener)

Specified by:

addProjectListener in interface Project

removeProjectListener

public void removeProjectListener(ProjectListener listener)

Specified by:

removeProjectListener in interface Project

fireProjectStructureChanged

public void fireProjectStructureChanged(ProjectEvent pe)

Specified by:

fireProjectStructureChanged in interface Project

fireProjectDataChanged

public void fireProjectDataChanged(ProjectEvent pe)

Specified by:

fireProjectDataChanged in interface Project

fireProjectWriteLocksChanged

public void fireProjectWriteLocksChanged(ProjectEvent pe)

Specified by:

fireProjectWriteLocksChanged in interface Project