Package ipsk.apps.speechrecorder.storage

Class SessionStorageManager

java.lang.Object

ipsk.apps.speechrecorder.storage.SessionStorageManager

Direct Known Subclasses:

ActiveSessionStorageManager

public class SessionStorageManager
extends java.lang.Object

Author:

klausj

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	createScriptDir
protected boolean	createSpeakerDir
static java.lang.String	DEF_RECVERSION_FORMAT
static java.lang.String	DEF_SESSION_ID_FORMAT
protected static int	DEF_SESSION_ID_FORMAT_DIGIT_COUNT
static java.lang.String	DEF_SPEAKER_ID_FORMAT
protected MetaData	metadata
protected int	numLines
protected boolean	overwrite
protected java.text.DecimalFormat	recVersionFormat
protected java.lang.String	scriptID
protected java.text.DecimalFormat	scriptIDFormat
protected java.text.NumberFormat	sessionIDFormat
protected java.text.DecimalFormat	speakerIDFormat
protected java.net.URL	storageURL
protected javax.sound.sampled.AudioFileFormat.Type	uploadType

Constructor Summary

Constructors

Constructor	Description
SessionStorageManager()

Method Summary

Modifier and Type	Method	Description
protected java.net.URL	addDirToURL(java.net.URL baseURL, java.lang.String dir)	appends a path fragment on a URL.
protected java.net.URL	addQueryToURL(java.net.URL baseURL, java.lang.String name, java.lang.String value)	adds (or extends) a query string to a 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.
MetaData	getMetadata()
int	getRecordedVersions(int sessionId, java.lang.String sessionCode, java.lang.String itemcode)
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.text.NumberFormat	getSessionIDFormat()
protected java.lang.String	getSessionNamePart(int sessionID, java.lang.String speakerCode)	Computes a file name fragment for this session.
java.net.URL	getSessionURL(int sessionID)	Creates a base URL for this session, which is used to build several individual URLs for the upload.
java.text.DecimalFormat	getSpeakerIDFormat()
java.net.URL	getStorageURL()
javax.sound.sampled.AudioFileFormat.Type	getUploadType()
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	isUseScriptID()
boolean	isUseSpeakerID()
java.io.File	sessionDirForSessionID(int sessionID)
boolean	sessionHasRecordingFiles(Session sess)
java.lang.String	sessionIDString(int sessionID)
java.util.Set<Session>	sessionsLazy(Project prj, Script script)
void	setMetadata(MetaData metadata)
void	setNumLines(int i)
void	setOverwrite(boolean overwrite)
void	setSessionIDFormat(java.text.NumberFormat format)
void	setStorageURL(java.net.URL storageURL)	defines the target URL for uploads.
void	setUseScriptID(boolean b)
void	setUseSpeakerID(boolean b)
void	updateRecFiles(Session sess, boolean recentVersionsOnly)

Methods inherited from class java.lang.Object

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

Field Detail

DEF_SESSION_ID_FORMAT_DIGIT_COUNT

protected static final int DEF_SESSION_ID_FORMAT_DIGIT_COUNT

See Also:

Constant Field Values

DEF_SESSION_ID_FORMAT

public static java.lang.String DEF_SESSION_ID_FORMAT

DEF_SPEAKER_ID_FORMAT

public static java.lang.String DEF_SPEAKER_ID_FORMAT

DEF_RECVERSION_FORMAT

public static java.lang.String DEF_RECVERSION_FORMAT

storageURL

protected java.net.URL storageURL

speakerIDFormat

protected java.text.DecimalFormat speakerIDFormat

sessionIDFormat

protected java.text.NumberFormat sessionIDFormat

scriptIDFormat

protected java.text.DecimalFormat scriptIDFormat

numLines

protected int numLines

uploadType

protected javax.sound.sampled.AudioFileFormat.Type uploadType

recVersionFormat

protected java.text.DecimalFormat recVersionFormat

createSpeakerDir

protected boolean createSpeakerDir

createScriptDir

protected boolean createScriptDir

metadata

protected MetaData metadata

scriptID

protected java.lang.String scriptID

overwrite

protected boolean overwrite

Constructor Detail

SessionStorageManager

public SessionStorageManager()

Method Detail

getStorageURL

public java.net.URL getStorageURL()

Returns:

the target URL for uploads.

setStorageURL

public void setStorageURL(java.net.URL storageURL)

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.

Parameters:

target - any valid URL

setNumLines

public void setNumLines(int i)

Parameters:

i - number of lines

setOverwrite

public void setOverwrite(boolean overwrite)

Parameters:

overwrite - the overwrite to set

getUploadType

public javax.sound.sampled.AudioFileFormat.Type getUploadType()

Returns:

upload audio type

getSpeakerIDFormat

public java.text.DecimalFormat getSpeakerIDFormat()

Returns:

speaker ID format

addQueryToURL

protected java.net.URL addQueryToURL(java.net.URL baseURL,
                                     java.lang.String name,
                                     java.lang.String value)
                              throws java.net.MalformedURLException,
                                     java.io.UnsupportedEncodingException

adds (or extends) a query string to a URL. If the givem URL already has a query string attached, the new part is added. The method adds one name/value pair to the URL. It does not verify if the parameter name already exists in the query.

Parameters:

the - URL to be extended

the - variable name for the query string without initial delimiter

the - variable value for the query string without initial delimiter

Returns:

the new URL

Throws:

java.net.MalformedURLException

java.io.UnsupportedEncodingException

addDirToURL

protected java.net.URL addDirToURL(java.net.URL baseURL,
                                   java.lang.String dir)
                            throws StorageManagerException

appends a path fragment on a URL.

Parameters:

baseURL -

dir -

Returns:

the new URL

Throws:

java.net.MalformedURLException

StorageManagerException

getSessionURL

public java.net.URL getSessionURL(int sessionID)
                           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

sessionIDString

public java.lang.String sessionIDString(int sessionID)

sessionDirForSessionID

public java.io.File sessionDirForSessionID(int sessionID)
                                    throws StorageManagerException

Throws:

StorageManagerException

getSessionNamePart

protected java.lang.String getSessionNamePart(int sessionID,
                                              java.lang.String speakerCode)

Computes a file name fragment for this session. The name starts always with the given speaker code. If useSpeakerID is set, it is followed by the speaker ID. If useSessionID is set, the the session ID is added.

Parameters:

sessionID - session ID

speakerCode - speaker code

Returns:

a file name fragment for this session

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 prompt code.

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.

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

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.

Parameters:

promptCode - code of the item

recVersion - number

Returns:

true if a recording exists

Throws:

StorageManagerException

java.net.URISyntaxException

sessionHasRecordingFiles

public boolean sessionHasRecordingFiles(Session sess)
                                 throws StorageManagerException

Throws:

StorageManagerException

getRecordedVersions

public int getRecordedVersions(int sessionId,
                               java.lang.String sessionCode,
                               java.lang.String itemcode)
                        throws StorageManagerException

Throws:

StorageManagerException

updateRecFiles

public void updateRecFiles(Session sess,
                           boolean recentVersionsOnly)
                    throws StorageManagerException

Throws:

StorageManagerException

sessionsLazy

public java.util.Set<Session> sessionsLazy(Project prj,
                                           Script script)
                                    throws StorageManagerException

Throws:

StorageManagerException

getSessionIDFormat

public java.text.NumberFormat getSessionIDFormat()

Returns:

session ID format

setSessionIDFormat

public void setSessionIDFormat(java.text.NumberFormat format)

Parameters:

format - session ID format

getMetadata

public MetaData getMetadata()

Returns:

Returns the metadata.

setMetadata

public void setMetadata(MetaData metadata)

Parameters:

metadata - The metadata to set.

isUseScriptID

public boolean isUseScriptID()

isUseSpeakerID

public boolean isUseSpeakerID()

setUseScriptID

public void setUseScriptID(boolean b)

setUseSpeakerID

public void setUseSpeakerID(boolean b)