Package ipsk.db.speech

Class Script

java.lang.Object

ipsk.db.speech.BasicPropertyChangeSupport

ipsk.db.speech.Recordingscript

ipsk.db.speech.Script

All Implemented Interfaces:

DOMElementConvertible, ImmutibilityProvider, TableExportProvider, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener

@Entity
public class Script
extends Recordingscript
implements java.lang.Cloneable, DOMElementConvertible, TableExportProvider, ImmutibilityProvider

Represents the script element of the recording script.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Script.Scope
static class	Script.ScriptTableSchemaProvider

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATT_ID
static java.lang.String	ELEMENT_NAME
static Script.ScriptTableSchemaProvider	scriptTableSchemaProvider

Fields inherited from class ipsk.db.speech.BasicPropertyChangeSupport

propertyChangeSupport

Fields inherited from class ipsk.db.speech.Recordingscript

scriptId

Constructor Summary

Constructors

Constructor	Description
Script()	default constructor
Script(int scriptId, java.lang.String name)	minimal constructor
Script(IntegerSequenceGenerator seqGen, org.w3c.dom.Element e)
Script(org.w3c.dom.Element e)

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.net.URI>	absoluteResourceURIs()
void	apply()	Applies defaults and randomizes the script.
java.lang.Object	clone()
void	defaultAutoplay(boolean defaultAutoplay)
void	defaultPostrecdelay(int defaultPostrecdelay)	Apply default post-recording delay.
void	defaultPrerecdelay(int defaultPrerecdelay)	Apply default pre-recording delay.
void	defaultSectionMode(Section.Mode defaultSectionMode)
void	defaultSpeakerDisplay(boolean defaultSpeakerDisplay)
java.lang.String	getDescription()
Metadata	getMetadata()
java.lang.String	getName()
Project	getOwningProject()
java.util.Set<Project>	getProjects()
java.util.List<Section>	getSections()
java.util.Set<Session>	getSessions()
boolean	hasAbsoluteResourceURIs()
void	init()
void	insertElement(IntegerSequenceGenerator seqGen, org.w3c.dom.Element e)
void	insertIntoElement(org.w3c.dom.Document d, org.w3c.dom.Element e)
boolean	isImmutable()
boolean	isRemovable()
int	numberOfPromptItems()	Returns number of prompt items
java.lang.Integer	promptItemIndex(PromptItem pi)
java.util.List<PromptItem>	promptItemsList()	Returns prompt item list in script order.
java.util.Set<java.net.URI>	resourceURIs()
Section	sectionForItemIndex(int itemIndex)	Returns the section which contains the item with the given index.
void	setDescription(java.lang.String description)
void	setMetadata(Metadata metadata)
void	setName(java.lang.String name)
void	setOwningProject(Project owningProject)
void	setProjects(java.util.Set<Project> projects)
void	setSections(java.util.List<Section> sections)
void	setSessions(java.util.Set<Session> sessions)
void	shuffleItems()
java.util.List<java.util.List<java.util.List<java.lang.String>>>	tableData()
java.util.List<java.util.List<java.util.List<java.lang.String>>>	tableData(java.util.List<ColumnDescriptor> columns)
org.w3c.dom.Element	toElement(org.w3c.dom.Document d)
java.lang.String	toString()
void	updateUpwardsRelations()

Methods inherited from class ipsk.db.speech.BasicPropertyChangeSupport

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, hasListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from class ipsk.db.speech.Recordingscript

getScriptId, isPropertyChangeSupportEnabled, itemCodesList, itemCodesSet, needsBeep, needsSilenceDetector, propertyChange, recordingCodesUnique, requiredMIMETypeCombinations, setPropertyChangeSupportEnabled, setScriptId

Field Detail

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME

See Also:

Constant Field Values

ATT_ID

public static final java.lang.String ATT_ID

See Also:

Constant Field Values

scriptTableSchemaProvider

public static Script.ScriptTableSchemaProvider scriptTableSchemaProvider

Constructor Detail

Script

public Script()

default constructor

Script

public Script(int scriptId,
              java.lang.String name)

minimal constructor

Script

public Script(IntegerSequenceGenerator seqGen,
              org.w3c.dom.Element e)

Script

public Script(org.w3c.dom.Element e)

Method Detail

init

public void init()

Overrides:

init in class Recordingscript

insertElement

public void insertElement(IntegerSequenceGenerator seqGen,
                          org.w3c.dom.Element e)

Overrides:

insertElement in class Recordingscript

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getMetadata

public Metadata getMetadata()

setMetadata

public void setMetadata(Metadata metadata)

getSections

public java.util.List<Section> getSections()

Overrides:

getSections in class Recordingscript

setSections

public void setSections(java.util.List<Section> sections)

Overrides:

setSections in class Recordingscript

getSessions

public java.util.Set<Session> getSessions()

setSessions

public void setSessions(java.util.Set<Session> sessions)

getProjects

public java.util.Set<Project> getProjects()

setProjects

public void setProjects(java.util.Set<Project> projects)

getOwningProject

public Project getOwningProject()

setOwningProject

public void setOwningProject(Project owningProject)

insertIntoElement

public void insertIntoElement(org.w3c.dom.Document d,
                              org.w3c.dom.Element e)

toElement

public org.w3c.dom.Element toElement(org.w3c.dom.Document d)

Specified by:

toElement in interface DOMElementConvertible

Overrides:

toElement in class Recordingscript

shuffleItems

public void shuffleItems()

apply

public void apply()

Applies defaults and randomizes the script. All defaults are applied to the script. Nullable properties will not return null values anymore. Random sections and groups are randomized and their order property will be set to randomized.

updateUpwardsRelations

public void updateUpwardsRelations()

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class Recordingscript

Throws:

java.lang.CloneNotSupportedException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

defaultSectionMode

public void defaultSectionMode(Section.Mode defaultSectionMode)

defaultSpeakerDisplay

public void defaultSpeakerDisplay(boolean defaultSpeakerDisplay)

defaultPrerecdelay

public void defaultPrerecdelay(int defaultPrerecdelay)

Apply default pre-recording delay.

Parameters:

defaultPrerecdelay - default pre-recording delay in milliseconds

defaultPostrecdelay

public void defaultPostrecdelay(int defaultPostrecdelay)

Apply default post-recording delay.

Parameters:

defaultPostrecdelay - default post-recording delay in milliseconds

defaultAutoplay

public void defaultAutoplay(boolean defaultAutoplay)

tableData

public java.util.List<java.util.List<java.util.List<java.lang.String>>> tableData(java.util.List<ColumnDescriptor> columns)

Specified by:

tableData in interface TableExportProvider

tableData

public java.util.List<java.util.List<java.util.List<java.lang.String>>> tableData()

Specified by:

tableData in interface TableExportProvider

promptItemsList

public java.util.List<PromptItem> promptItemsList()

Returns prompt item list in script order.

Returns:

list of (not shuffled) prompt items

resourceURIs

public java.util.Set<java.net.URI> resourceURIs()

Overrides:

resourceURIs in class Recordingscript

absoluteResourceURIs

public java.util.Set<java.net.URI> absoluteResourceURIs()

hasAbsoluteResourceURIs

public boolean hasAbsoluteResourceURIs()

numberOfPromptItems

public int numberOfPromptItems()

Returns number of prompt items

Returns:

number of prompt items

sectionForItemIndex

public Section sectionForItemIndex(int itemIndex)

Returns the section which contains the item with the given index.

Parameters:

itemIndex -

Returns:

section

promptItemIndex

public java.lang.Integer promptItemIndex(PromptItem pi)

isImmutable

public boolean isImmutable()

Specified by:

isImmutable in interface ImmutibilityProvider

isRemovable

public boolean isRemovable()

Specified by:

isRemovable in interface ImmutibilityProvider