Package ipsk.apps.speechrecorder.project

Class ActiveProjectManager

java.lang.Object

ipsk.apps.speechrecorder.project.ProjectManager

ipsk.apps.speechrecorder.project.ActiveProjectManager

All Implemented Interfaces:

RecscriptManagerListener, SessionManagerListener, java.util.EventListener

public class ActiveProjectManager
extends ProjectManager
implements RecscriptManagerListener, SessionManagerListener

Field Summary

Fields

Modifier and Type	Field	Description
static javax.swing.Action[]	ACTIONS
static Logger[]	AVAIL_LOGGERS
static boolean	DEBUG
static Handler[]	DEF_LOG_HANDLERS
protected java.util.List<ips.annot.autoannotator.AutoAnnotator>	enabledAutoAnnotators
static Formatter[]	LOG_FORMATTERS
java.lang.String	LOG_HANDLER_NAME
java.lang.String	PREFERRED_START_STOP_SIGNAL_PLUGIN
protected ActiveSessionStorageManager	storageManager
protected static Formatter	TIME_LOG_FORMATTER_CFG
java.lang.String	TIMELOG_HANDLER_NAME

Fields inherited from class ipsk.apps.speechrecorder.project.ProjectManager

numLines, project, PROJECT_FILE_EXTENSION, PROJECT_VERSION, projectContext, projectDb, projectStorageManager, promptFile, recBaseURL, recScriptManager, speakerFileName, speakerManager, speakerURL

Constructor Summary

Constructors

Constructor	Description
ActiveProjectManager(PromptPresenterPluginManager ppPm, AutoAnnotationPluginManager aaPm, java.lang.String projectFileURL, java.lang.String user, java.lang.String password)	Create Speechrecorder application Must be called from AWT event thread !

Method Summary

Modifier and Type	Method	Description
boolean	close()
boolean	configure(ProjectConfiguration cfgProject)
boolean	configureProject(java.net.URL projectUrl)	Open a project.
java.lang.String	defaultScriptUrlString()
javax.swing.Action	getActionByActionCommand(java.lang.String actionCmd)
AudioController4	getAudioController()	Returns the audio controller.
javax.sound.sampled.AudioFileFormat	getAudioFileFormat()
AutoAnnotationPluginManager	getAutoAnnotatorPluginManager()
java.util.List<ips.annot.autoannotator.AutoAnnotationServiceDescriptor>	getAutoAnnotatorServiceDescriptors()
java.util.List<ips.annot.BundleAnnotationPersistor>	getBundleAnnotationPersistorList()
java.util.List<ips.annot.BundleAnnotationPersistorServiceDescriptor>	getBundleAnnotationPersistorServiceDescriptors()
ProjectConfiguration	getConfiguration()	Returns the project configuration (bean).
ProjectConfiguration	getConfigurationCopy()	Returns a copy (new instance) of the project configuration (bean).
EditScriptAction	getEditScriptAction()
java.util.List<ips.annot.autoannotator.AutoAnnotator>	getEnabledAutoAnnotators()
ExportScriptAction	getExportScriptAction()
ImportScriptAction	getImportScriptAction()
ItemcodeGenerator	getItemcodeGenerator()
java.util.Set<java.lang.String>	getItemCodesInUse()
ProjectManagerListener	getListener()
java.io.File	getProjectDir()
java.net.URL	getProjectURL()	Returns the project configuration URL.
java.lang.String	getRecDirName()	getRecDirName() returns the name of the recording directory
RecScriptManager	getRecScriptManager()	returns the current RecScriptManager to allow access to the script.
java.lang.String	getRecScriptName()	returns the file name of the current recording script
AtomicIntegerSequenceGenerator	getSequenceGenerator()
java.util.List<AudioClip>	getSessionClipList()
SessionManager	getSessionManager()
Speaker	getSpeaker()	returns the speaker selected from the database
SpeakerManager	getSpeakerManager()	Gets the speaker manager.
SpeechRecorderUI	getSpeechRecorderUI()	Returns the UI object.
UploadCache	getUploadCache()	Returns the upload cache.
java.io.File	getWorkspaceDir()
void	importResource(java.io.File f, java.lang.String relpath)
void	init()
boolean	isProjectConfigurationSaved()	Returns whether the project configuration is saved.
boolean	isProjectEditable()
boolean	isScriptSaved()
boolean	isUsingUploadCache()	Indicates the use of a the upload cache in web mode.
boolean	isWaitForCompleteUpload()
void	newProject(NewProjectConfiguration newProjectConfig)	Create a new project.
void	requestProjectConfigDisableOverwriteWarning()
void	resetItemcodeGenerator()
void	saveAll()	Save project configuration, speaker database and script file.
boolean	saveAllProjectDataInteractive()
void	saveProject()	Save current project configuration.
void	saveProject(java.io.File file)	Save project file.
void	saveScript()	Save current project configuration.
void	saveSpeakerDatabase()	Save speaker database file.
void	setAudioFileFormat(javax.sound.sampled.AudioFileFormat audioFileFormat)
void	setEditingEnabled(boolean b)
void	setListener(ProjectManagerListener listener)
void	setProjectConfigurationSaved(boolean saved)	Set true if the project configuration is saved.
void	setProjectContext(java.net.URL context)
void	setProjectURL(java.net.URL url)	Sets new project configuration URL.
void	setScriptSaved(boolean scriptSaved)
void	setSpeechRecorderUI(SpeechRecorderUI speechRecorderUI)
void	setWaitForCompleteUpload(boolean waitForCompleteUpload)
void	setWorkspaceDir(java.io.File workspaceDir)
void	shutdown()	Shutdown the application.
void	start()	Start a recording session.
void	update(RecscriptManagerEvent e)
void	updateItemCodesInUseSet()	Updates the set of already existing item codes.

Methods inherited from class java.lang.Object

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

Methods inherited from class ipsk.apps.speechrecorder.project.ProjectManager

commonConfig, config, getProjectContext, getProjectDb, getProjectStorageManager, rebuildDb

Field Detail

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

PREFERRED_START_STOP_SIGNAL_PLUGIN

public final java.lang.String PREFERRED_START_STOP_SIGNAL_PLUGIN

See Also:

Constant Field Values

LOG_HANDLER_NAME

public java.lang.String LOG_HANDLER_NAME

TIMELOG_HANDLER_NAME

public java.lang.String TIMELOG_HANDLER_NAME

DEF_LOG_HANDLERS

public static Handler[] DEF_LOG_HANDLERS

TIME_LOG_FORMATTER_CFG

protected static final Formatter TIME_LOG_FORMATTER_CFG

LOG_FORMATTERS

public static final Formatter[] LOG_FORMATTERS

AVAIL_LOGGERS

public static Logger[] AVAIL_LOGGERS

ACTIONS

public static javax.swing.Action[] ACTIONS

storageManager

protected ActiveSessionStorageManager storageManager

enabledAutoAnnotators

protected java.util.List<ips.annot.autoannotator.AutoAnnotator> enabledAutoAnnotators

Constructor Detail

ActiveProjectManager

public ActiveProjectManager(PromptPresenterPluginManager ppPm,
                            AutoAnnotationPluginManager aaPm,
                            java.lang.String projectFileURL,
                            java.lang.String user,
                            java.lang.String password)
                     throws java.lang.ClassNotFoundException,
                            DOMCodecException,
                            DOMConverterException,
                            java.io.IOException,
                            PluginLoadingException,
                            AudioControllerException,
                            javax.xml.parsers.ParserConfigurationException,
                            org.xml.sax.SAXException,
                            StorageManagerException,
                            java.lang.InstantiationException,
                            java.lang.IllegalAccessException,
                            WorkspaceException

Create Speechrecorder application Must be called from AWT event thread !

Parameters:

projectFileURL - URL of the project configuration file

user - user for web authentication

password - password for web authentication

Throws:

java.lang.ClassNotFoundException

DOMCodecException

DOMConverterException

java.io.IOException

PluginLoadingException

AudioControllerException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

StorageManagerException

java.lang.InstantiationException

java.lang.IllegalAccessException

WorkspaceException

Method Detail

getSessionManager

public SessionManager getSessionManager()

setSpeechRecorderUI

public void setSpeechRecorderUI(SpeechRecorderUI speechRecorderUI)

getEditScriptAction

public EditScriptAction getEditScriptAction()

getImportScriptAction

public ImportScriptAction getImportScriptAction()

getAutoAnnotatorPluginManager

public AutoAnnotationPluginManager getAutoAnnotatorPluginManager()

getExportScriptAction

public ExportScriptAction getExportScriptAction()

getSequenceGenerator

public AtomicIntegerSequenceGenerator getSequenceGenerator()

getEnabledAutoAnnotators

public java.util.List<ips.annot.autoannotator.AutoAnnotator> getEnabledAutoAnnotators()

getListener

public ProjectManagerListener getListener()

setListener

public void setListener(ProjectManagerListener listener)

init

public void init()

Overrides:

init in class ProjectManager

getActionByActionCommand

public javax.swing.Action getActionByActionCommand(java.lang.String actionCmd)

configure

public boolean configure(ProjectConfiguration cfgProject)
                  throws PluginLoadingException,
                         AudioControllerException,
                         DOMConverterException,
                         java.io.IOException,
                         java.lang.InstantiationException,
                         java.lang.IllegalAccessException,
                         java.lang.ClassNotFoundException,
                         DOMCodecException,
                         WorkspaceException,
                         java.net.URISyntaxException,
                         RecscriptManagerException,
                         StorageManagerException,
                         SpeechRecorderException

Throws:

PluginLoadingException

AudioControllerException

DOMConverterException

java.io.IOException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.ClassNotFoundException

DOMCodecException

WorkspaceException

java.net.URISyntaxException

RecscriptManagerException

StorageManagerException

SpeechRecorderException

getConfiguration

public ProjectConfiguration getConfiguration()

Returns the project configuration (bean).

Returns:

the project configuration

getConfigurationCopy

public ProjectConfiguration getConfigurationCopy()
                                          throws DOMCodecException

Returns a copy (new instance) of the project configuration (bean).

Returns:

copy of project configuration

Throws:

DOMCodecException

getProjectURL

public java.net.URL getProjectURL()

Returns the project configuration URL.

Returns:

the URL where the configuration is stored

setProjectURL

public void setProjectURL(java.net.URL url)

Sets new project configuration URL.

Parameters:

url - the URL where the configuration is stored

getProjectDir

public java.io.File getProjectDir()
                           throws java.net.MalformedURLException,
                                  java.net.URISyntaxException

Throws:

java.net.MalformedURLException

java.net.URISyntaxException

defaultScriptUrlString

public java.lang.String defaultScriptUrlString()

newProject

public void newProject(NewProjectConfiguration newProjectConfig)
                throws java.lang.Exception

Create a new project.

Parameters:

newProjectConfig - the configuration for the new project

Throws:

java.lang.Exception

getWorkspaceDir

public java.io.File getWorkspaceDir()

setWorkspaceDir

public void setWorkspaceDir(java.io.File workspaceDir)

saveProject

public void saveProject()
                 throws DOMCodecException,
                        DOMConverterException,
                        java.io.IOException,
                        java.net.URISyntaxException

Save current project configuration.

Throws:

DOMCodecException

DOMConverterException

java.io.IOException

java.net.URISyntaxException

saveProject

public void saveProject(java.io.File file)
                 throws DOMCodecException,
                        DOMConverterException,
                        java.io.IOException,
                        java.net.URISyntaxException

Save project file.

Parameters:

file - save to this file

Throws:

DOMCodecException

DOMConverterException

java.io.IOException

java.net.URISyntaxException

saveScript

public void saveScript()
                throws DOMCodecException,
                       DOMConverterException,
                       java.io.IOException,
                       javax.xml.parsers.ParserConfigurationException,
                       java.net.URISyntaxException

Save current project configuration.

Throws:

DOMCodecException

DOMConverterException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

java.net.URISyntaxException

saveSpeakerDatabase

public void saveSpeakerDatabase()
                         throws java.io.IOException,
                                java.net.URISyntaxException

Save speaker database file.

Throws:

java.io.IOException

java.net.URISyntaxException

saveAll

public void saveAll()
             throws DOMCodecException,
                    DOMConverterException,
                    java.io.IOException,
                    javax.xml.parsers.ParserConfigurationException,
                    java.net.URISyntaxException

Save project configuration, speaker database and script file.

Throws:

DOMCodecException

DOMConverterException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

java.net.URISyntaxException

configureProject

public boolean configureProject(java.net.URL projectUrl)
                         throws java.lang.ClassNotFoundException,
                                DOMCodecException,
                                DOMConverterException,
                                StorageManagerException,
                                PluginLoadingException,
                                AudioControllerException,
                                javax.xml.parsers.ParserConfigurationException,
                                org.xml.sax.SAXException,
                                java.io.IOException,
                                java.lang.InstantiationException,
                                java.lang.IllegalAccessException,
                                WorkspaceException,
                                java.net.URISyntaxException,
                                RecscriptManagerException,
                                SpeechRecorderException

Open a project.

Parameters:

projectUrl - must contain the project configuration

Throws:

java.lang.ClassNotFoundException

DOMCodecException

DOMConverterException

PluginLoadingException

AudioControllerException

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

java.lang.IllegalAccessException

java.lang.InstantiationException

WorkspaceException

java.net.URISyntaxException

RecscriptManagerException

SpeechRecorderException

StorageManagerException

isProjectEditable

public boolean isProjectEditable()

setEditingEnabled

public void setEditingEnabled(boolean b)

Specified by:

setEditingEnabled in interface SessionManagerListener

saveAllProjectDataInteractive

public boolean saveAllProjectDataInteractive()

shutdown

public void shutdown()

Shutdown the application. If an uploading cache is used this method waits for complete upload.

start

public void start()
           throws AudioControllerException,
                  ProjectManagerException

Start a recording session. The application must be configured, initialized and a speaker must be chosen to start a session.

Throws:

AudioControllerException

ProjectManagerException

getRecScriptManager

public RecScriptManager getRecScriptManager()

returns the current RecScriptManager to allow access to the script.

Returns:

RecScriptManager

getRecScriptName

public java.lang.String getRecScriptName()

returns the file name of the current recording script

Returns:

String recording script file name

getRecDirName

public java.lang.String getRecDirName()

getRecDirName() returns the name of the recording directory

Returns:

String recording directory name

getSpeaker

public Speaker getSpeaker()

returns the speaker selected from the database

Returns:

Speaker current speaker

isUsingUploadCache

public boolean isUsingUploadCache()

Indicates the use of a the upload cache in web mode.

Returns:

true if an upload cache is used.

getUploadCache

public UploadCache getUploadCache()

Returns the upload cache.

Returns:

the upload cache or null if not used

getSpeechRecorderUI

public SpeechRecorderUI getSpeechRecorderUI()

Returns the UI object.

Returns:

UI object

getAudioController

public AudioController4 getAudioController()

Returns the audio controller.

Returns:

the audio controller

isProjectConfigurationSaved

public boolean isProjectConfigurationSaved()

Returns whether the project configuration is saved.

Returns:

true if the project configuration is saved

setProjectConfigurationSaved

public void setProjectConfigurationSaved(boolean saved)

Set true if the project configuration is saved.

Parameters:

saved - true if the configuration is saved

getSpeakerManager

public SpeakerManager getSpeakerManager()

Gets the speaker manager.

Returns:

the speaker manager

isWaitForCompleteUpload

public boolean isWaitForCompleteUpload()

Returns:

Returns the waitForCompleteUpload.

setWaitForCompleteUpload

public void setWaitForCompleteUpload(boolean waitForCompleteUpload)

Parameters:

waitForCompleteUpload - The waitForCompleteUpload to set.

setProjectContext

public void setProjectContext(java.net.URL context)

Overrides:

setProjectContext in class ProjectManager

Parameters:

context - the project context (directory) URL

getAudioFileFormat

public javax.sound.sampled.AudioFileFormat getAudioFileFormat()

Returns:

Returns the audioFileFormat.

setAudioFileFormat

public void setAudioFileFormat(javax.sound.sampled.AudioFileFormat audioFileFormat)

Parameters:

audioFileFormat - The audioFileFormat to set.

importResource

public void importResource(java.io.File f,
                           java.lang.String relpath)
                    throws java.io.IOException,
                           java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException

resetItemcodeGenerator

public void resetItemcodeGenerator()

isScriptSaved

public boolean isScriptSaved()

setScriptSaved

public void setScriptSaved(boolean scriptSaved)

update

public void update(RecscriptManagerEvent e)

Specified by:

update in interface RecscriptManagerListener

getItemcodeGenerator

public ItemcodeGenerator getItemcodeGenerator()

getAutoAnnotatorServiceDescriptors

public java.util.List<ips.annot.autoannotator.AutoAnnotationServiceDescriptor> getAutoAnnotatorServiceDescriptors()
                                                                                                           throws java.io.IOException

Returns:

Throws:

java.io.IOException

getSessionClipList

public java.util.List<AudioClip> getSessionClipList()

getBundleAnnotationPersistorServiceDescriptors

public java.util.List<ips.annot.BundleAnnotationPersistorServiceDescriptor> getBundleAnnotationPersistorServiceDescriptors()

Returns:

updateItemCodesInUseSet

public void updateItemCodesInUseSet()
                             throws StorageManagerException

Updates the set of already existing item codes.

Throws:

StorageManagerException

getItemCodesInUse

public java.util.Set<java.lang.String> getItemCodesInUse()

Returns:

requestProjectConfigDisableOverwriteWarning

public void requestProjectConfigDisableOverwriteWarning()

Specified by:

requestProjectConfigDisableOverwriteWarning in interface SessionManagerListener

close

public boolean close()
              throws AudioControllerException,
                     StorageManagerException,
                     WorkspaceException,
                     SpeechRecorderException

Throws:

AudioControllerException

StorageManagerException

WorkspaceException

SpeechRecorderException

getBundleAnnotationPersistorList

public java.util.List<ips.annot.BundleAnnotationPersistor> getBundleAnnotationPersistorList()