RecScriptManager

java.lang.Object
- ipsk.apps.speechrecorder.script.RecScriptManager

```
public class RecScriptManager
extends java.lang.Object
```
RecScriptManager loads the recording script and manages the progress through the recording. It keeps track of the items recorded within the current sessionid, and it knows which item to record next. RecScriptManager is the model for the ProgressViewer. ProgressViewer displays the recording script in a table. The column names are defined in the resource file of the GUI. Each table row represents a recording item.

Version:

2.0 Feb. 2004

Author:

Christoph Draxler

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`AUTOMATIC`
`static int`	`ERROR_MSG_MAX_ITEMS`
`static int`	`MANUAL`
`static int`	`RANDOM`
`static java.lang.String`	`RECORDED_COL_ID`
`static int`	`SEQUENTIAL`

Constructor Summary

Constructors
Constructor Description

RecScriptManager()
RecScriptManager loads the recording script and organizes the sequence of recordings.

Constructors
Constructor	Description
`RecScriptManager()`	RecScriptManager loads the recording script and organizes the sequence of recordings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addRecscriptManagerListener(RecscriptManagerListener acl)`	Add listener.
`void`	`analyzeScriptResources()`
`void`	`createDTDFileIfRequired()`
`void`	`doClose()`	resets the manager to the initial state
`protected void`	`fireRecscriptManagerUpdate(RecscriptManagerEvent event)`
`java.net.URL`	`getContext()`	Get the workspace project context.
`Section.Mode`	`getDefaultMode()`
`int`	`getDefaultPostDelay()`
`int`	`getDefaultPreDelay()`
`java.util.Set<java.lang.String>`	`getExistingCodes()`
`java.util.logging.Logger`	`getLogger()`
`int`	`getMaxIndex()`	returns the number of items in the recording script.
`Section`	`getRecSectionForItem(int itemIndex)`	returns the recording section corresponding to a given recording item index
`Script`	`getScript()`	Get currently used script.
`java.lang.String`	`getScriptID()`
`java.net.URL`	`getScriptURL()`
`IntegerSequenceGenerator`	`getSequenceGenerator()`
`java.lang.String`	`getSystemId()`
`java.lang.String`	`getSystemIdBase()`
`boolean`	`isDefaultAutomaticPromptPlay()`
`boolean`	`isDefaultSpeakerDisplay()`
`boolean`	`isNewVersionOfDTDFileRequired()`
`boolean`	`isProgresToNextUnrecorded()`
`boolean`	`isScriptSaved()`
`boolean`	`isSetIndexActionsEnabled()`
`void`	`load(java.net.URL promptURL)`	Loads a recording script from a URL.
`void`	`load(java.net.URL promptURL, boolean force)`	Loads a recording script from a URL.
`void`	`loadWithoutDTD(java.net.URL promptURL)`	loads a recording script from a URL.
`Script`	`readRecScriptXMLFile(java.net.URL recScriptURL)`	reads recording and prompting instructions from an XML-Document.
`Script`	`readRecScriptXMLFile(java.net.URL recScriptURL, boolean force)`	reads recording and prompting instructions from an XML-Document.
`Script`	`readRecScriptXMLFileWithoutDTD(java.net.URL recScriptURL)`	reads recording and prompting instructions from an XML-Document.
`void`	`removeRecscriptManagerListener(RecscriptManagerListener acl)`	Remove listener.
`void`	`setContext(java.net.URL context)`	Set the URL context (usually the project directory in the workspace).
`void`	`setDefaultAutomaticPromptPlay(boolean automaticPromptPlayDefault)`
`void`	`setDefaultMode(Section.Mode defaultMode)`
`void`	`setDefaultPostDelay(int defaultPostDelay)`
`void`	`setDefaultPreDelay(int defaultPreDelay)`
`void`	`setDefaultSpeakerDisplay(boolean defaultSpeakerDisplay)`
`void`	`setProgresToNextUnrecorded(boolean progresToNextUnrecorded)`
`void`	`setScript(Script script)`	Set the script to use.
`void`	`setScriptSaved(boolean scriptSaved)`
`void`	`setSequenceGenerator(IntegerSequenceGenerator sequenceGenerator)`
`void`	`setSetIndexActionsEnabled(boolean setIndexActionsEnabled)`
`void`	`setSystemId(java.lang.String scriptDTD)`
`void`	`setSystemIdBase(java.lang.String string)`
`PromptItem`	`shuffledPromptItem(int promptIndex)`	returns the (possibly shuffled) prompt item corresponding to the given recording index
`void`	`shuffleItems()`
`void`	`storeToFile(java.io.File scriptFile)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AUTOMATIC
```
public static final int AUTOMATIC
```
    See Also:
    
    Constant Field Values
  - MANUAL
```
public static final int MANUAL
```
    See Also:
    
    Constant Field Values
  - SEQUENTIAL
```
public static final int SEQUENTIAL
```
    See Also:
    
    Constant Field Values
  - RANDOM
```
public static final int RANDOM
```
    See Also:
    
    Constant Field Values
  - RECORDED_COL_ID
```
public static final java.lang.String RECORDED_COL_ID
```
    See Also:
    
    Constant Field Values
  - ERROR_MSG_MAX_ITEMS
```
public static final int ERROR_MSG_MAX_ITEMS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RecScriptManager
```
public RecScriptManager()
```
    RecScriptManager loads the recording script and organizes the sequence of recordings. A recording script can be either a text file (the use of text files is deprecated) or an XML file defined in a DTD or XML-Schema. Furthermore, RecScriptManager pre-fetches all resources referred to via URLs so that they can be displayed in the prompt window without delay. The sequence of recordings can be either automatic mode in sequence or in random order, or it can be manual. For selecting prompts in manual mode the RecTransporter or the ProgressViewer are used. RecScriptManager is implemented as a singleton because there can be only a single such manager for a given recording sessionid.
- Method Detail
  - getScriptURL
```
public java.net.URL getScriptURL()
```
  - setSequenceGenerator
```
public void setSequenceGenerator(IntegerSequenceGenerator sequenceGenerator)
```
  - getSequenceGenerator
```
public IntegerSequenceGenerator getSequenceGenerator()
```
  - getExistingCodes
```
public java.util.Set<java.lang.String> getExistingCodes()
```
  - isNewVersionOfDTDFileRequired
```
public boolean isNewVersionOfDTDFileRequired()
                                      throws java.net.MalformedURLException
```
    Throws:
    
    java.net.MalformedURLException
  - createDTDFileIfRequired
```
public void createDTDFileIfRequired()
                             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getScript
```
public Script getScript()
```
    Get currently used script.
    
    Returns:
    
    script
  - setScript
```
public void setScript(Script script)
```
    Set the script to use.
    
    Parameters:
    
    script -
    
    Throws:
    
    StorageManagerException
  - shuffleItems
```
public void shuffleItems()
```
  - load
```
public void load(java.net.URL promptURL)
          throws RecscriptManagerException
```
    Loads a recording script from a URL. The format of the recording script file is expected to be XML, if the the filename extension is not txt or TXT.
    Note that the use of text files is deprecated.
    
    Parameters:
    
    promptURL - The location of the recording script
    
    Throws:
    
    java.io.IOException
    
    DOMConverterException
    
    java.net.URISyntaxException
    
    StorageManagerException
    
    org.xml.sax.SAXException
    
    javax.xml.parsers.ParserConfigurationException
    
    RecscriptManagerException
  - load
```
public void load(java.net.URL promptURL,
                 boolean force)
          throws RecscriptManagerException
```
    Loads a recording script from a URL. The format of the recording script file is expected to be XML, if the the filename extension is not txt or TXT.
    Note that the use of text files is deprecated.
    
    Parameters:
    
    promptURL - The location of the recording script
    
    force - if true forces loading script even if its has a newer DTD schema version
    
    Throws:
    
    java.io.IOException
    
    DOMConverterException
    
    java.net.URISyntaxException
    
    StorageManagerException
    
    org.xml.sax.SAXException
    
    javax.xml.parsers.ParserConfigurationException
    
    RecscriptManagerException
  - loadWithoutDTD
```
public void loadWithoutDTD(java.net.URL promptURL)
                    throws RecscriptManagerException
```
    loads a recording script from a URL. The format of the recording script file is expected to be XML, if the the filename extension is not txt or TXT.
    Note that the use of text files is deprecated.
    
    Parameters:
    
    scriptURL - The location of the recording script
    
    Throws:
    
    java.io.IOException
    
    DOMConverterException
    
    java.net.URISyntaxException
    
    StorageManagerException
    
    org.xml.sax.SAXException
    
    javax.xml.parsers.ParserConfigurationException
    
    RecscriptManagerException
  - storeToFile
```
public void storeToFile(java.io.File scriptFile)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readRecScriptXMLFile
```
public Script readRecScriptXMLFile(java.net.URL recScriptURL)
                            throws RecscriptManagerException
```
    reads recording and prompting instructions from an XML-Document. After that, a vector with the prompt file contents can be obtained via getRecSections().
    
    Parameters:
    
    recScriptURL - URL
    
    Returns:
    
    the script
    
    Throws:
    
    RecScriptManagerException
    
    RecscriptManagerException
  - readRecScriptXMLFile
```
public Script readRecScriptXMLFile(java.net.URL recScriptURL,
                                   boolean force)
                            throws RecscriptManagerException
```
    reads recording and prompting instructions from an XML-Document. After that, a vector with the prompt file contents can be obtained via getRecSections().
    
    Parameters:
    
    recScriptURL - URL
    
    force - if true forces loading script even if its has a newer DTD schema version
    
    Returns:
    
    the script
    
    Throws:
    
    RecScriptManagerException
    
    RecscriptManagerException
  - readRecScriptXMLFileWithoutDTD
```
public Script readRecScriptXMLFileWithoutDTD(java.net.URL recScriptURL)
                                      throws RecscriptManagerException
```
    reads recording and prompting instructions from an XML-Document. After that, a vector with the prompt file contents can be obtained via getRecSections().
    
    Parameters:
    
    recScriptURL - URL
    
    Returns:
    
    the script
    
    Throws:
    
    RecScriptManagerException
    
    RecscriptManagerException
  - getRecSectionForItem
```
public Section getRecSectionForItem(int itemIndex)
```
    returns the recording section corresponding to a given recording item index
    
    Parameters:
    
    itemIndex - recording index in the range of 0 and (number of items - 1)
    
    Returns:
    
    RecSection
  - shuffledPromptItem
```
public PromptItem shuffledPromptItem(int promptIndex)
```
    returns the (possibly shuffled) prompt item corresponding to the given recording index
    
    Parameters:
    
    promptIndex -
    
    Returns:
    
    PromptItem
  - analyzeScriptResources
```
public void analyzeScriptResources()
```
  - getMaxIndex
```
public int getMaxIndex()
```
    returns the number of items in the recording script. If the index has been computed once it is not recomputed for this script.
    
    Returns:
    
    int prompt item count
  - getSystemIdBase
```
public java.lang.String getSystemIdBase()
```
  - setSystemIdBase
```
public void setSystemIdBase(java.lang.String string)
```
  - getScriptID
```
public java.lang.String getScriptID()
```
    Returns:
    
    Returns the script id attribute.
  - setContext
```
public void setContext(java.net.URL context)
```
    Set the URL context (usually the project directory in the workspace).
    
    Parameters:
    
    context -
  - getContext
```
public java.net.URL getContext()
```
    Get the workspace project context.
    
    Returns:
    
    the URL workspace context
  - getLogger
```
public java.util.logging.Logger getLogger()
```
    Returns:
    
    logger
  - doClose
```
public void doClose()
```
    resets the manager to the initial state
  - isDefaultSpeakerDisplay
```
public boolean isDefaultSpeakerDisplay()
```
  - setDefaultSpeakerDisplay
```
public void setDefaultSpeakerDisplay(boolean defaultSpeakerDisplay)
```
  - getDefaultMode
```
public Section.Mode getDefaultMode()
```
  - setDefaultMode
```
public void setDefaultMode(Section.Mode defaultMode)
```
  - getDefaultPreDelay
```
public int getDefaultPreDelay()
```
  - setDefaultPreDelay
```
public void setDefaultPreDelay(int defaultPreDelay)
```
  - getDefaultPostDelay
```
public int getDefaultPostDelay()
```
  - setDefaultPostDelay
```
public void setDefaultPostDelay(int defaultPostDelay)
```
  - addRecscriptManagerListener
```
public void addRecscriptManagerListener(RecscriptManagerListener acl)
```
    Add listener.
    
    Parameters:
    
    acl - new listener
  - removeRecscriptManagerListener
```
public void removeRecscriptManagerListener(RecscriptManagerListener acl)
```
    Remove listener.
    
    Parameters:
    
    acl - listener to remove
  - fireRecscriptManagerUpdate
```
protected void fireRecscriptManagerUpdate(RecscriptManagerEvent event)
```
  - isScriptSaved
```
public boolean isScriptSaved()
```
  - setScriptSaved
```
public void setScriptSaved(boolean scriptSaved)
```
  - isSetIndexActionsEnabled
```
public boolean isSetIndexActionsEnabled()
```
  - setSetIndexActionsEnabled
```
public void setSetIndexActionsEnabled(boolean setIndexActionsEnabled)
```
  - isDefaultAutomaticPromptPlay
```
public boolean isDefaultAutomaticPromptPlay()
```
  - setDefaultAutomaticPromptPlay
```
public void setDefaultAutomaticPromptPlay(boolean automaticPromptPlayDefault)
```
  - getSystemId
```
public java.lang.String getSystemId()
```
  - setSystemId
```
public void setSystemId(java.lang.String scriptDTD)
```
  - isProgresToNextUnrecorded
```
public boolean isProgresToNextUnrecorded()
```
  - setProgresToNextUnrecorded
```
public void setProgresToNextUnrecorded(boolean progresToNextUnrecorded)
```

Class RecScriptManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTOMATIC

MANUAL

SEQUENTIAL

RANDOM

RECORDED_COL_ID

ERROR_MSG_MAX_ITEMS

Constructor Detail

RecScriptManager

Method Detail

getScriptURL

setSequenceGenerator

getSequenceGenerator

getExistingCodes

isNewVersionOfDTDFileRequired

createDTDFileIfRequired

getScript

setScript

shuffleItems

load

load

loadWithoutDTD

storeToFile

readRecScriptXMLFile

readRecScriptXMLFile

readRecScriptXMLFileWithoutDTD

getRecSectionForItem

shuffledPromptItem

analyzeScriptResources

getMaxIndex

getSystemIdBase

setSystemIdBase

getScriptID

setContext

getContext

getLogger

doClose

isDefaultSpeakerDisplay

setDefaultSpeakerDisplay

getDefaultMode

setDefaultMode

getDefaultPreDelay

setDefaultPreDelay

getDefaultPostDelay

setDefaultPostDelay

addRecscriptManagerListener

removeRecscriptManagerListener

fireRecscriptManagerUpdate

isScriptSaved

setScriptSaved

isSetIndexActionsEnabled

setSetIndexActionsEnabled

isDefaultAutomaticPromptPlay

setDefaultAutomaticPromptPlay

getSystemId

setSystemId

isProgresToNextUnrecorded

setProgresToNextUnrecorded