Package ipsk.apps.speechrecorder.storage

Class ActiveSessionStorageManager

java.lang.Object

ipsk.apps.speechrecorder.storage.SessionStorageManager

ipsk.apps.speechrecorder.storage.ActiveSessionStorageManager

All Implemented Interfaces:

UploadCacheListener, java.util.EventListener

public class ActiveSessionStorageManager
extends SessionStorageManager
implements UploadCacheListener

The storage manager takes care about filenames for audio, log and label files. In standalone mode it generates ordinary filenames. In web recording mode temporary files are used and pushed as Upload to an UploadCache.

Author:

K.Jaensch, klausj@phonetik.uni-muenchen.de

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActiveSessionStorageManager.Status

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEF_ANNOTATION_FILE_SUFFIX
static java.lang.String	DEF_SCRIPT_ID_FORMAT
static java.lang.String	XML_FILENAME_EXTENSION

Fields inherited from class ipsk.apps.speechrecorder.storage.SessionStorageManager

createScriptDir, createSpeakerDir, DEF_RECVERSION_FORMAT, DEF_SESSION_ID_FORMAT, DEF_SESSION_ID_FORMAT_DIGIT_COUNT, DEF_SPEAKER_ID_FORMAT, metadata, numLines, overwrite, recVersionFormat, scriptID, scriptIDFormat, sessionIDFormat, speakerIDFormat, storageURL, uploadType

Constructor Summary

Constructors

Constructor	Description
ActiveSessionStorageManager()	Create new storage manager.

Method Summary

Modifier and Type	Method	Description
void	close()
void	close(boolean forceDelete)
void	connected()
boolean	createSessionDirectory()
protected void	deleteAllTmpDirFiles()
void	disconnected()
static java.io.File	fileURLToFile(java.net.URL url)
java.net.URL	generateAnnotationFileURL()	Generates a dynamic annotation filename for the actual item based on the storage URL.
java.net.URL[]	generateAudioFileURLs()	generates a dynamic filename for the actual item based on the storage URL.
java.net.URL[]	generateAudioFileURLs(int sessionID, java.lang.String speakerCode, java.lang.String promptCode, int recVersion)	Generates dynamic audio filename for the actual item based on the storage URL.
java.net.URL[]	generateAudioFileURLs(java.lang.String promptCode, int recVersion)	Generates dynamic audio filename for the actual item based on the storage URL.
java.io.File	getAnnoationFile()
java.lang.String	getAnnotationFileName()
java.lang.String	getAudioFileExtension()
java.lang.String[]	getAudioFileNames()
java.lang.String[]	getAudioFileNames(java.lang.String itemCode)
java.lang.String[]	getAudioFileNames(java.lang.String promptCode, java.lang.String speakerCode, java.lang.String extension)
java.io.File[]	getCachedInputFiles()	Get cached storage files
java.io.InputStream[]	getCachedInputStreams()	get a stream for
java.net.URL[]	getCachedInputURLs()	Get cached storage URLs
java.net.URL[]	getConvertedAudioFiles()
java.io.File[]	getCurrentItemRecordingFiles()
java.net.URL	getItemFileURL(java.lang.String suffix)
java.lang.String	getLabelFileExtension()
java.lang.String	getLabelFileName()
java.net.URL	getLogFile()
java.lang.String	getLogFileName()
java.io.File[]	getNewRecordingFiles()
java.lang.String	getNewRootFileName()	Get root file name of current recording in progress.
int	getNumLines()
java.lang.String	getPromptCode()
int	getRecordedVersions()	Returns count of already recorded version beginning from zero.
int	getRecordedVersions(java.lang.String promptCode)	Returns count of already recorded version beginning from zero.
java.io.File[]	getRecordingFiles()	get a list of all available audio data.
java.net.URL	getRecordingSessionInfoFile()
java.lang.String	getRecordingSessionInfoFileName()
int	getRecVersion()
java.lang.String	getRootFileName()	Get root file name of last recorded.
java.lang.String	getRootFileName(int sessionID, java.lang.String promptCode, java.lang.String speakerCode, int recVersion)	Computes a root file name, subject to several options.
java.lang.String[]	getRootFileNames()
java.lang.String	getScriptID()
int	getSessionID()
java.net.URL	getSessionURL()	Creates a base URL for this session, which is used to build several individual URLs for the upload.
java.lang.String	getSpeakerCode()
java.net.URL	getTimeLogFile()
java.lang.Integer	highestSessionID()	Get highest session number in stand alone file based mode.
boolean	isCreateSessionDir()
boolean	isCreateSpeakerDir()
boolean	isRecorded()
boolean	isRecorded(int sessionID, java.lang.String speakerCode, java.lang.String promptCode)	Checks an item is already recorded.
boolean	isRecorded(int sessionID, java.lang.String speakerCode, java.lang.String promptCode, int recVersion)	Checks if a particular version of an item is already recorded.
boolean	isRecorded(java.lang.String promptCode)	Checks if the item is already recorded.
boolean	isRecorded(java.lang.String promptCode, int recVersion)	Checks if a particular version of an item is already recorded.
boolean	isUseAsCache()
java.util.List<java.lang.String>	listLocalSessionIds_slow(boolean listEmptySessions)	Returns list of session IDs of current project.
java.util.Set<java.lang.String>	localSessionIds(boolean listEmptySessions)
void	open()
void	open(boolean force)	Open the storage manager.
java.io.File	recentRecordingFile(java.lang.String itemCode)
boolean	sessionExists()
java.util.Set<RecordingFile>	sessionRecordingFilesLazy(Session sess)
java.io.File	sessionScriptFile()
java.net.URL	sessionScriptURL()
void	setAudioFileExtension(java.lang.String string)
void	setCreateSessionDir(boolean b)
void	setCreateSpeakerDir(boolean b)
void	setLabelFileExtension(java.lang.String string)
void	setOverwrite(boolean overwrite)
void	setPromptCode(java.lang.String string)
void	setRecVersion(int recVersion)
void	setScriptID(java.lang.String scriptID)
void	setSessionID(int i)
void	setSpeakerCode(java.lang.String string)
void	setSpeakerIDFormat(java.text.DecimalFormat format)
void	setStorageURL(java.net.URL target)	defines the target URL for uploads.
void	setUploadCache(UploadCache uploadCache)	set the upload cache thread for the StorageManager.
void	setUploadType(javax.sound.sampled.AudioFileFormat.Type type)
void	setUseAsCache(boolean b)
void	stateChanged(Upload uvb)
void	storeSessionScriptFile(java.io.InputStream scriptStream)
void	tryConnect()
void	update(UploadEvent event)
void	upload()	starts uploading of the collected data.
void	uploadAnnotation()

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.storage.SessionStorageManager

addDirToURL, addQueryToURL, getMetadata, getRecordedVersions, getSessionIDFormat, getSessionNamePart, getSessionURL, getSpeakerIDFormat, getStorageURL, getUploadType, isUseScriptID, isUseSpeakerID, sessionDirForSessionID, sessionHasRecordingFiles, sessionIDString, sessionsLazy, setMetadata, setNumLines, setSessionIDFormat, setUseScriptID, setUseSpeakerID, updateRecFiles

Field Detail

DEF_SCRIPT_ID_FORMAT

public static java.lang.String DEF_SCRIPT_ID_FORMAT

XML_FILENAME_EXTENSION

public static java.lang.String XML_FILENAME_EXTENSION

DEF_ANNOTATION_FILE_SUFFIX

public static java.lang.String DEF_ANNOTATION_FILE_SUFFIX

Constructor Detail

ActiveSessionStorageManager

public ActiveSessionStorageManager()

Create new storage manager.

Method Detail

deleteAllTmpDirFiles

protected void deleteAllTmpDirFiles()

open

public void open(boolean force)
          throws StorageManagerException

Open the storage manager. Reads local cache map and puts cached files to the upload engine (again). The force flag controls the behavior on broken cache map files or on missing files to upload. If the flag is set force removes unreadable cache map files, ignores missing upload files and removes all files not found in the map. This holds the temporary directory clean. If not set an exception is thrown if an invalid condition in the cache is found.

Parameters:

force - force repairing inconsistent cache states

Throws:

StorageManagerException - if an inconsistent cache is found

close

public void close()
           throws StorageManagerException

Throws:

StorageManagerException

close

public void close(boolean forceDelete)
           throws StorageManagerException

Throws:

StorageManagerException

open

public void open()
          throws StorageManagerException

Throws:

StorageManagerException

getRootFileName

public java.lang.String getRootFileName(int sessionID,
                                        java.lang.String promptCode,
                                        java.lang.String speakerCode,
                                        int recVersion)

Computes a root file name, subject to several options. The root file name consists at least of the speaker code, plus the promt code.

Overrides:

getRootFileName in class SessionStorageManager

Parameters:

promptCode -

speakerCode -

Returns:

a root file name

See Also:

getSessionNamePart(String speakerCode)

generateAudioFileURLs

public java.net.URL[] generateAudioFileURLs(int sessionID,
                                            java.lang.String speakerCode,
                                            java.lang.String promptCode,
                                            int recVersion)
                                     throws StorageManagerException

Generates dynamic audio filename for the actual item based on the storage URL. In online mode, when isUseAsCache() is true, the following parameters are appended on the storageURL as query string:
promptCode, speakerCode, extension, session, line
In offline mode, prompt, speaker code etc. are appended on the storage URL as directory fragments to build a valid and individual filename.

Overrides:

generateAudioFileURLs in class SessionStorageManager

Parameters:

sessionID - session ID

speakerCode - speaker code

promptCode - the item code

recVersion - of the recording

Returns:

array of URLs, one entry for each audio line

Throws:

StorageManagerException

setUploadCache

public void setUploadCache(UploadCache uploadCache)

set the upload cache thread for the StorageManager.

Parameters:

uploadCache -

upload

public void upload()
            throws StorageManagerException

starts uploading of the collected data.

Throws:

StorageManagerException

uploadAnnotation

public void uploadAnnotation()
                      throws StorageManagerException

Throws:

StorageManagerException

getCachedInputStreams

public java.io.InputStream[] getCachedInputStreams()
                                            throws StorageManagerException

get a stream for

Returns:

array of input streams, one for each audio line

Throws:

StorageManagerException

getCachedInputURLs

public java.net.URL[] getCachedInputURLs()
                                  throws StorageManagerException

Get cached storage URLs

Returns:

array of URLs, one for each audio line

Throws:

StorageManagerException

getCachedInputFiles

public java.io.File[] getCachedInputFiles()
                                   throws StorageManagerException

Get cached storage files

Returns:

array of files, one for each audio line

Throws:

StorageManagerException

getNewRecordingFiles

public java.io.File[] getNewRecordingFiles()
                                    throws StorageManagerException

Returns:

a File for each audio line

Throws:

StorageManagerException

getCurrentItemRecordingFiles

public java.io.File[] getCurrentItemRecordingFiles()

fileURLToFile

public static java.io.File fileURLToFile(java.net.URL url)
                                  throws StorageManagerException

Throws:

StorageManagerException

getRecordingFiles

public java.io.File[] getRecordingFiles()
                                 throws StorageManagerException

get a list of all available audio data.

Returns:

array of Files, one for each recorded item

Throws:

StorageManagerException

getRecordingSessionInfoFile

public java.net.URL getRecordingSessionInfoFile()
                                         throws StorageManagerException

Returns:

URL of recording session info file

Throws:

java.net.MalformedURLException

StorageManagerException

generateAudioFileURLs

public java.net.URL[] generateAudioFileURLs()
                                     throws StorageManagerException

generates a dynamic filename for the actual item based on the storage URL. In online mode, when isUseAsCache() is true, the following parameters are appended on the storageURL as query string:
promptCode, speakerCode, extension, session, line
In offline mode, promt, speaker code etc. are appended on the storage URL as directory fragments to build a valid and individual filename.

Returns:

array of URLs, one entry for each audio line

Throws:

StorageManagerException

generateAudioFileURLs

public java.net.URL[] generateAudioFileURLs(java.lang.String promptCode,
                                            int recVersion)
                                     throws StorageManagerException

Generates dynamic audio filename for the actual item based on the storage URL. In online mode, when isUseAsCache() is true, the following parameters are appended on the storageURL as query string:
promptCode, speakerCode, extension, session, line
In offline mode, prompt, speaker code etc. are appended on the storage URL as directory fragments to build a valid and individual filename.

Parameters:

promptCode - the item code

recVersion - of the recording

Returns:

array of URLs, one entry for each audio line

Throws:

StorageManagerException

generateAnnotationFileURL

public java.net.URL generateAnnotationFileURL()
                                       throws StorageManagerException

Generates a dynamic annotation filename for the actual item based on the storage URL. In online mode, when isUseAsCache() is true, the following parameters are appended on the storageURL as query string:
promptCode, speakerCode, extension, session, line
In offline mode, prompt, speaker code etc. are appended on the storage URL as directory fragments to build a valid and individual filename.

Returns:

URL

Throws:

StorageManagerException

getConvertedAudioFiles

public java.net.URL[] getConvertedAudioFiles()
                                      throws StorageManagerException

Throws:

StorageManagerException

getLogFileName

public java.lang.String getLogFileName()

getLogFile

public java.net.URL getLogFile()
                        throws StorageManagerException

Throws:

StorageManagerException

listLocalSessionIds_slow

public java.util.List<java.lang.String> listLocalSessionIds_slow(boolean listEmptySessions)
                                                          throws StorageManagerException

Returns list of session IDs of current project.

Parameters:

listEmptySessions - if set to true empty sessions (empty directories) are included in list

Returns:

list of recording sessions IDs of current selected project or null if storage is server based

Throws:

StorageManagerException

localSessionIds

public java.util.Set<java.lang.String> localSessionIds(boolean listEmptySessions)
                                                throws StorageManagerException

Throws:

StorageManagerException

getNewRootFileName

public java.lang.String getNewRootFileName()

Get root file name of current recording in progress. Root file name is the bundle name without extension. Format: [spkcode][session][itemcode]_[recversion]

Returns:

root file name of current recording in progress

getRootFileName

public java.lang.String getRootFileName()

Get root file name of last recorded. Root file name is the bundle name without extension. Format: [spkcode][session][itemcode]_[recversion]

Returns:

root file name of last recorded

getRootFileNames

public java.lang.String[] getRootFileNames()

getItemFileURL

public java.net.URL getItemFileURL(java.lang.String suffix)
                            throws StorageManagerException

Throws:

StorageManagerException

getAudioFileNames

public java.lang.String[] getAudioFileNames()

getAudioFileNames

public java.lang.String[] getAudioFileNames(java.lang.String itemCode)

getAudioFileNames

public java.lang.String[] getAudioFileNames(java.lang.String promptCode,
                                            java.lang.String speakerCode,
                                            java.lang.String extension)

getLabelFileName

public java.lang.String getLabelFileName()

getRecordingSessionInfoFileName

public java.lang.String getRecordingSessionInfoFileName()

getAnnoationFile

public java.io.File getAnnoationFile()
                              throws StorageManagerException

Throws:

StorageManagerException

getAnnotationFileName

public java.lang.String getAnnotationFileName()

getSessionURL

public java.net.URL getSessionURL()
                           throws StorageManagerException

Creates a base URL for this session, which is used to build several individual URLs for the upload.

Returns:

the base URL

Throws:

StorageManagerException

isRecorded

public boolean isRecorded()
                   throws StorageManagerException

Throws:

StorageManagerException

isRecorded

public boolean isRecorded(java.lang.String promptCode)
                   throws StorageManagerException

Checks if the item is already recorded.

Parameters:

promptCode - code of the item

Returns:

true if a recording exists

Throws:

StorageManagerException

isRecorded

public boolean isRecorded(java.lang.String promptCode,
                          int recVersion)
                   throws StorageManagerException

Checks if a particular version of an item is already recorded.

Parameters:

promptCode - code of the item

recVersion - number

Returns:

true if a recording exists

Throws:

StorageManagerException

java.net.URISyntaxException

isRecorded

public boolean isRecorded(int sessionID,
                          java.lang.String speakerCode,
                          java.lang.String promptCode)
                   throws StorageManagerException

Checks an item is already recorded.

Parameters:

promptCode - code of the item

Returns:

true if a recording exists

Throws:

StorageManagerException

java.net.URISyntaxException

isRecorded

public boolean isRecorded(int sessionID,
                          java.lang.String speakerCode,
                          java.lang.String promptCode,
                          int recVersion)
                   throws StorageManagerException

Checks if a particular version of an item is already recorded.

Overrides:

isRecorded in class SessionStorageManager

Parameters:

promptCode - code of the item

recVersion - number

Returns:

true if a recording exists

Throws:

StorageManagerException

java.net.URISyntaxException

getRecordedVersions

public int getRecordedVersions()
                        throws StorageManagerException

Returns count of already recorded version beginning from zero. Note that only subsequent version numbers are recognized.

Returns:

number of recorded versions

Throws:

StorageManagerException

getRecordedVersions

public int getRecordedVersions(java.lang.String promptCode)
                        throws StorageManagerException

Returns count of already recorded version beginning from zero. Note that only subsequent version numbers are recognized.

Parameters:

promptCode -

Returns:

number of recorded versions

Throws:

StorageManagerException

sessionRecordingFilesLazy

public java.util.Set<RecordingFile> sessionRecordingFilesLazy(Session sess)
                                                       throws StorageManagerException

Throws:

StorageManagerException

createSessionDirectory

public boolean createSessionDirectory()
                               throws StorageManagerException

Throws:

StorageManagerException

sessionExists

public boolean sessionExists()
                      throws StorageManagerException

Throws:

StorageManagerException

getAudioFileExtension

public java.lang.String getAudioFileExtension()

Returns:

audio file extension

isCreateSessionDir

public boolean isCreateSessionDir()

isCreateSpeakerDir

public boolean isCreateSpeakerDir()

getLabelFileExtension

public java.lang.String getLabelFileExtension()

Returns:

label file extension

getNumLines

public int getNumLines()

Returns:

number of lines

getPromptCode

public java.lang.String getPromptCode()

Returns:

prompt code

getScriptID

public java.lang.String getScriptID()

Returns:

script ID

getSessionID

public int getSessionID()

Returns:

session ID

setSpeakerIDFormat

public void setSpeakerIDFormat(java.text.DecimalFormat format)

Parameters:

format - speaker ID format

getSpeakerCode

public java.lang.String getSpeakerCode()

Returns:

speaker code

setSpeakerCode

public void setSpeakerCode(java.lang.String string)

Parameters:

string - speaker code

getTimeLogFile

public java.net.URL getTimeLogFile()
                            throws StorageManagerException

Throws:

StorageManagerException

setAudioFileExtension

public void setAudioFileExtension(java.lang.String string)

Parameters:

string - audio file extension

setCreateSessionDir

public void setCreateSessionDir(boolean b)

setCreateSpeakerDir

public void setCreateSpeakerDir(boolean b)

setLabelFileExtension

public void setLabelFileExtension(java.lang.String string)

Parameters:

string - label file extension

setPromptCode

public void setPromptCode(java.lang.String string)

Parameters:

string - prompt code

setScriptID

public void setScriptID(java.lang.String scriptID)

Parameters:

scriptID - script ID

setSessionID

public void setSessionID(int i)

Parameters:

i - session ID

setStorageURL

public void setStorageURL(java.net.URL target)

defines the target URL for uploads. That means the protocol, server name and possibly a application specific path, e.g. http://OurAppServer/DemoApplication/RecordingData/StoreServlet.xml
If the protocol of the given URL is file, the storageManager switches to local mode. Otherwise it switches to remote mode.

Overrides:

setStorageURL in class SessionStorageManager

Parameters:

target - any valid URL

setUploadType

public void setUploadType(javax.sound.sampled.AudioFileFormat.Type type)

Parameters:

type - audio upload type

isUseAsCache

public boolean isUseAsCache()

Returns:

true if upload cache is used

setUseAsCache

public void setUseAsCache(boolean b)

Parameters:

b - true if upload cache is used

tryConnect

public void tryConnect()

connected

public void connected()

stateChanged

public void stateChanged(Upload uvb)

disconnected

public void disconnected()

getRecVersion

public int getRecVersion()

Returns:

the recVersion

setRecVersion

public void setRecVersion(int recVersion)

Parameters:

recVersion - the recVersion to set

setOverwrite

public void setOverwrite(boolean overwrite)

Overrides:

setOverwrite in class SessionStorageManager

Parameters:

overwrite - the overwrite to set

update

public void update(UploadEvent event)

Specified by:

update in interface UploadCacheListener

highestSessionID

public java.lang.Integer highestSessionID()
                                   throws StorageManagerException

Get highest session number in stand alone file based mode. Returns null if no session exists or for other modes (Web mode;WikiSpeech)

Returns:

highest session ID or null

Throws:

StorageManagerException

recentRecordingFile

public java.io.File recentRecordingFile(java.lang.String itemCode)
                                 throws StorageManagerException

Throws:

StorageManagerException

sessionScriptFile

public java.io.File sessionScriptFile()
                               throws StorageManagerException

Throws:

StorageManagerException

sessionScriptURL

public java.net.URL sessionScriptURL()
                              throws StorageManagerException

Throws:

StorageManagerException

storeSessionScriptFile

public void storeSessionScriptFile(java.io.InputStream scriptStream)
                            throws StorageManagerException

Throws:

StorageManagerException