TOC PREV NEXT INDEX

Put your logo here!


Appendix B Class descriptions
Table 1:  Used abbreviations
Abbreviation
Meaning
Impl
Implements
Vis
Visibility
Priv
Private
Prot
Protected
Pub
Public

B.1 Domain class specification

Class

Project

Impl Serializable

Description

Represents a project of Audio Jury application, which consists of a number of tests and other attributes.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

name

String

Priv



Name of the project.

state

int

Priv



State of the project. Only DYNAMIC, ACTIVE and CLOSED states are allowed.

persItems

String [ ]

Priv



List of personal attributes that should be filled out by participants.

tests

Hash table

Priv



All tests of the project are stored in a hash table. The key of the hash table is the name of a test.

instructions

Instructions

Priv



Text or audio instructions of the project.

DYNAMIC

int

Pub

1

Y

Dynamic state constant.

ACTIVE

int

Pub

2

Y

Active state constant.

CLOSED

int

Pub

3

Y

Closed state constant.

Operations

Operation signature

Vis

Operation Description

Project ( )

Pub

Constructor.

getName ( ): String

Pub

Returns the name of the project.

setName (name: String): void

Pub

Sets the name of the project.

getState ( ): int

Pub

Returns the current state of the project.

setState (st: int): void

Pub

Sets the state of the project.

addTest (test: Test): void

Pub

Adds new test to the project.

removeTest (name: String): void

Pub

Removes the test identified by name from the project.

getTests ( ): Hash table

Pub

Returns all tests in the project as a hash table.

getTest (name: String): Test

Pub

Retrieves the test identified by name.

getInstructions ( ): Instructions

Pub

Returns the instructions of the project.

setInstructions (inst: Instructions): void

Pub

Sets instructions to the project.

getPersItems ( ): String [ ]

Pub

Returns an array of personal attributes set for the project.

setPersItems (items: String [ ]): void

Pub

Sets personal attributes to the project.

Class

Test

Impl Serializable

Description

Represents a test of Audio Jury application, which consists of a number of judgements based on sounds, and other attributes.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

name

String

Priv



Name of the test.

random-Mode

int

Priv



Randomization mode of judgements.

0 - no randomization.

1 - randomize judgements.

interMode

int

Priv



Interaction mode used in the test.

0 - automatic mode.

1 - interactive mode.

realJudge-ments

Vector

Priv



Real judgements of the test stored as a Vector object.

practice-Judgements

Vector

Priv



Practice judgements of the test stored as a Vector object.

method

Test-Method

Priv



Method used for the test.

status

int

Priv

NEW


Status of the test. Only VIRGIN, NEW, MODIFIED and DELETED are allowed.

VIRGIN

int

Priv


Y

Indicates that the test is not new and was not deleted or modified.

NEW

int

Priv


Y

Indicates that the test is newly created and has not been saved.

MODIFIED

int

Priv


Y

Indicates that the test has been modified.

DELETED

Int

Priv


Y

Indicates that the test has been deleted.

Operations

Operation signature

Vis

Operation Description

Test ( )

Pub

Constructor.

getName ( ): String

Pub

Returns the name of the test.

setName (tname: String): void

Pub

Sets the name of the test.

getRandomMode ( ): int

Pub

Returns the randomization mode set for the test.

setRandomMode (rmode: int): void

Pub

Sets the randomization mode.

getInterMode ( ): int

Pub

Returns the interaction mode.

setInterMode (imode: int): void

Pub

Sets the interaction mode.

getInstructions ( ): Instructions

Pub

Returns instructions of the test.

setInstructions (inst: Instructions): void

Pub

Sets the instructions of the test.

addReal (judg: Judgement): void

Pub

Adds real judgement to the test.

removeReal (index: int): void

Pub

Removes the judgement from the test using its position index.

getRealJudgements ( ): Vector

Pub

Returns all real judgements as a Vector.

addPractice (judg: Judgement): void

Pub

Adds practice judgement to the test.

removePractice (index: int): void

Pub

Removes the judgement from the test using its position index.

getPracticeJudgements ( ): Vector

Pub

Returns all practice judgements as a Vector.

getStatus ( ): int

Pub

Returns the current status of the test.

setStatus (stat: int): void

Pub

Sets the status of the test.

getMethod ( ): TestMethod

Pub

Returns the test method used.

setMethod (tmethod: TestMethod): void

Pub

Sets the test method to use.

Class

Judgement

Impl Serializable

Description

Represents a judgement which has sounds to be rated or compared and the result.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

sounds

Vector

Priv



Sounds of the judgement.

score

Score

Priv



Score assigned by the test participant.

practice

boolean

Priv



Is true if the judgement belongs to the practice session.

Operations

Operation signature

Vis

Operation Description

Judgement ( )

Pub

Constructor.

getScore ( ): Score

Pub

Returns the score of the judgement.

setScore (jscore: Score): void

Pub

Sets the score of the judgement.

addSound (snd: Sound): void

Pub

Adds a sound to the judgement.

getSounds ( ): Vector

Pub

Returns all sounds as a Vector.

isPractice ( ): boolean

Pub

Returns true if it is a practice judgement.

setPractice (jpractice: boolean): void

Pub

Makes judgement practice.

Class

SingleJudgement

Extends Judgement

Impl Serializable

Description

Represent single sound judgement.

Operations

Operation signature

Vis

Operation Description

SinlgeJudgement ( )

Pub

Constructor.

Class

PairedJudgement

Extends Judgement

Impl Serializable

Description

Represents judgement with two sounds.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

flipped

boolean

Priv

false


Is true if sounds were flipped.

Operations

Operation signature

Vis

Operation Description

PairedJudgement ( )

Pub

Constructor.

flip ( ): void

Pub

Flips sounds.

setScore (jscore: Score): void

Pub

Sets the score of the judgement. Logic may differ depending on which test method used.

isFlipped ( ): boolean

Pub

Returns flipped attribute.

Class

Scale

Impl Serializable

Description

Represents the scale used in the test.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

header

String

Priv



Header of the scale.

scores

Vector

Priv



Scores like `good', 'bad' etc. represented as a Vector.

Operations

Operation signature

Vis

Operation Description

Scale ( )

Pub

Constructor.

getHeader ( ): String

Pub

Returns the header of the scale.

setHeader (sheader: String): void

Pub

Sets the header of the scale.

hasZero ( ): boolean

Pub

Returns true if scale contains zero score.

getScores ( ): Vector

Pub

Returns all scores in the scale as Vector.

addScore (score: Score): void

Pub

Adds new score to the scale.

Class

Score

Impl Serializable

Description

Represents a particular score of a scale.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

label

String

Priv



Score label.

value

int

Priv



Score value.

Operations

Operation signature

Vis

Operation Description

Score ( )

Pub

Constructor.

getLabel ( ): String

Pub

Returns the label of the score.

setLabel (slabel: String): void

Pub

Sets the label of the score.

getValue ( ): int

Pub

Returns the value of the score.

setValue (svalue: int): void

Pub

Sets the value of the score.

Class

Sound

Impl Serializable

Description

Represents a sound file of judgements or instructions.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

name

String

Priv



Sound file name.

path

String

Priv



Sound file path. Only exists when the sound file has not been copied yet to project directory.

copied

boolean

Priv



If true the file has been copied from the original location to the project directory.

Operations

Operation signature

Vis

Operation Description

Sound ( )

Pub

Constructor.

getName ( ): String

Pub

Returns the file name of the sound.

setName (sname: String): void

Pub

Sets the file name.

getPath ( ): String

Pub

Returns the path of the sound.

setPath (spath: String): void

Pub

Sets the path of the sound.

isCopied ( ): boolean

Pub

Returns the `copied' attribute.

setCopied (scp: boolean): void

Pub

Sets the boolean value to the `copied' attribute

Class

TestMethod (abstract)

Description

Represents a test method.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

name

String

Priv



Test method name.

paired

boolean

Priv



If true then the method is used for paired judgements.

Operations

Operation signature

Vis

Operation Description

TestMethod ( )

Pub

Constructor.

getName ( ): String

Pub

Returns the name of the test method.

setName (tname: String): void

Pub

Sets the name of the test method.

isPaired ( ): boolean

Pub

Returns true if the method is used for paired judgements.

setPaired (prd: boolean): void

Pub

Sets boolean value to `paired' attribute.

Class

CCR

Extends TestMethod

Impl Serializable

Description

Represents Comparison Category Rating test method.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

DELAY

float

Priv

0.6

Y

Delay between paired sounds in automatic mode.

Operations

Operation signature

Vis

Operation Description

CCR ( )

Pub

Constructor.

isPaired ( ): boolean

Pub

Always returns true.

Class

DCR

Extends TestMethod

Impl Serializable

Desciption

Represents Degradation Category Rating test method.

Operations

Operation signature

Vis

Operation Description

DCR ( )

Pub

Constructor.

isPaired ( ): boolean

Pub

Always returns true.

Class

ACR

Extends TestMethod

Impl Serializable

Desciption

Represents Absolute Category Rating test method.

Operations

Operation signature

Vis

Operation Description

ACR ( )

Pub

Constructor.

isPaired ( ): boolean

Pub

Always returns false.

Class

FullComparison

Extends TestMethod

Impl Serializable

Description

Represents Complete comparison test method.

Operations

Operation signature

Vis

Operation Description

FullComparison ( )

Pub

Constructor.

isPaired ( ): boolean

Pub

Always returns true.

Class

GeneralPairs

Extends TestMethod

Impl Serializable

Description

Represents General pair test method.

Operations

Operation signature

Vis

Operation Description

GeneralPairs ( )

Pub

Constructor.

isPaired ( ): boolean

Pub

Always returns true.

Class

Instruction

Impl Serializable

Description

Represents instructions of a project or a test.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

text

String

Priv



Instruction text content.

sound

Sound

Priv



Instruction audio content.

Operations

Operation signature

Vis

Operation Description

Instruction (String t, Sound s)

Pub

Constructor.

getText ( ): String

Pub

Returns the text content of instructions.

getAudio (): Sound

Pub

Returns the audio content of instructions.

Class

ProjectResults

Impl Serializable

Description

Stores project results for a particular project run by a test participant.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

project

Project

Pub



Project.

persInfo

String [ ]

Pub



Personal information provided by a test participant.

comple-tionDate

Date

Pub



Date and time when all tests in a project were completed.

Operations

Operation signature

Vis

Operation Description

ProjectResults ( )

Pub

Constructor.

Interface

ProjectProcessing

Description

Interface that describes operations for project processing.

Operations

Operation signature

Vis

Operation Description

newProject (name: String): Project

Pub

Creates the new Project with a given name.

openProject (name: String): Project

Pub

Opens the existing Project with a given name. Open project is stored in ProjectBuilder.

saveProject (project: Project): void

Pub

Saves the project passed as a parameter.

deleteProject (name: String): void

Pub

Deletes the project with a given name.

activateProject (name: String): void

Pub

Activates the project with a given name.

reactivateProject (name: String): void

Pub

Reactivates the project with a given name

closeProject (name: String): void

Pub

Closes the project with a given name.

renameProject (name: String, newname: String): void

Pub

Renames the project.

duplicateProject (name: String, newname: String): void

Pub

Duplicates the project. A new name is assigned to the new copy.

listProjectsAndTests ( ): Hash table

Pub

Returns all Projects and Tests hierarchy as a hash table. Each hash table entry contains the name of the project as a key, and another hash table for its tests.

listProjects ( ): Hash table

Pub

Return all projects as a hash table. A key of the hash table is the project name.

isUniqueProjectName (name: String): boolean

Pub

Checks whether the name of a project is unique or not.

Interface

ResultProcessing

Description

Interface that describes operations for result processing.

Operations

Operation signature

Vis

Operation Description

openResults (projname: String): ProjectResults [ ]

Pub

Opens results of a project of all participants for a given project name and returns the array of ProjectResults.

saveResults (results: ProjectResults): void

Pub

Saves project results represented by ProjectResults.

autoImport ( ): void

Pub

Performs an automatic import of results.

manualImport (folderpath: String): void

Pub

Performs a manual import of results.

createReport (projname: String): void

Pub

Generates report for further result analysis for a given project name.

Interface

ConfigProcessing

Description

Interface that describes operations for configuration processing

Operations

Operation signature

Vis

Operation Description

setValues (type: int, values: String [ ]): void

Pub

Sets values passed as an array for a particular configuration type.

getValues (type: int): String [ ]

Pub

Gets values as an array for a particular configuration type.

setValue (type: int, values: String ): void

Pub

Sets value for a particular configuration type.

getValue (type: int): String

Pub

Gets value for a particular configuration type.

B.2 Action package class specification

Class

ProjectManager

Impl ProjectProcessing

Description

Represents a high level interface for managing projects. ProjectManager forwards all requests to the ProjectStoragePlugin which has an implementation of all functions.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

unique-Instance

Project-Manager

Priv


Y

Stores a unique instance of ProjectManager

project-Plugin

Project-Storage-Plugin

Priv



Points to ProjectStoragePlugin assigned to ProjectManager.

Operations

Operation signature

Vis

Operation Description

ProjectManager (plugin: ProjectStoragePlugin)

Pub

Public constructor. ProjectStoragePlugin is passed as a parameter.

ProjectManager ( )

Priv

Private Constructor.

newProject (name: String): Project

Pub

Creates the new Project with a given name.

openProject (name: String): Project

Pub

Opens the existing Project with a given name. Open project is stored in ProjectBuilder.

openProjectPassive (name: String): Project

Pub

Opens the existing Project with a given name, but does not store it in ProjectBuilder.

saveProject (project: Project): void

Pub

Saves the project passed as a parameter.

deleteProject (name: String): void

Pub

Deletes the project with a given name.

activateProject (name: String): void

Pub

Activates the project with a given name.

reactivateProject (name: String): void

Pub

Reactivates the project with a given name.

closeProject (name: String): void

Pub

Closes the project with a given name.

renameProject(name: String, newname: String): void

Pub

Renames the project.

duplicateProject (name: String, newname: String): void

Pub

Duplicates the project. A new name is assigned to the new copy.

listProjectsAndTests ( ): Hashtable

Pub

Returns all Projects and Tests hierarchy as a hash table. Each hash table entry contains the name of the project as a key, and another hash table for its tests.

listProjects ( ): Hashtable

Pub

Returns all projects as a hash table. The key of the hash table is the project name.

setProjectStoragePlugin (plugin: ProjectStoragePlugin): void

Pub

Assigns a ProjectStoragePlugin to the ProjectManager.

isUniqueProjectName (name: String): boolean

Pub

Checks whether the name of a project is unique or not.

getProjectBuilder ( ): ProjectBuilder

Prot

Returns the unique instance of ProjectBuilder.

getUniqueInstance ( ): ProjectManager

Pub

Returns the unique instance of ProjectManager.

Class

TestManager

Description

Represents a high level interface for managing tests in the opened project.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

unique-Instance

Test-Manager

Priv


Y

Stores a unique instance of TestManager.

Operations

Operation signature

Vis

Operation Description

TestManager ( )

Pub

Constructor.

newTest (name: String): Test

Pub

Creates the new test with a given name in the current project.

openTest (name: String): Test

Pub

Opens the test with a given name from the current project.

deleteTest (name: String): void

Pub

Deletes the test with a given name from the current project.

renameTest (name: String, newname: String): void

Pub

Renames the test in the current project.

duplicateTest (name: String, newname: String): void

Pub

Duplicates the test in the current project. A new name is assigned to the new copy.

importTest (test: Test): void

Pub

Imports the test into the project.

getTests ( ): Hashtable

Pub

Returns all tests from the current project.

getProjectBuilder ( ): ProjectBuilder

Prot

Returns the unique instance of the ProjectBuilder where the current project is stored.

getTestBuilder ( ): TestBuilder

Prot

Returns the unique instance of the TestBuilder where the current opened test is stored.

getUniqueInstance ( ): TestManager

Pub

Returns the unique instance of the TestManager.

Class

ProjectBuilder

Description

Represents an object which operates on a single project. It has a task to store one active project at a time.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

current-Project

Project

Priv



Current opened project.

modified

boolean

Priv



True if project was modified.

unique-Instance

boolean

Priv


Y

Stores the unique instance of this class.

Operations

Operation signature

Vis

Operation Description

ProjectBuilder ( )

Pub

Constructor.

getCurrentProject ( ): Project

Pub

Returns the current working project.

setCurrentProject (project: Project)

Pub

Sets a project as current.

isModified ( ): boolean

Pub

Returns true if project was modified.

setModified (pmodified: boolean): void

Pub

Sets `modified' attribute to true or false.

setInstructions (inst: Instruction): void

Pub

Sets instructions of the current project.

setPersonaltems (items: Vector): void

Pub

Sets a personal attribute list to the current project.

getUniqueInstance ( ): ProjectBuilder

Pub

Returns the unique name of the ProjectBuilder.

Class

TestBuilder

Description

Represents an object which operates on a single test. It has the task to store one test opened for modification at a time.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

currentTest

Test

Priv



Currently opened test.

unique-Instance

boolean

Priv


Y

Stores the unique instance of this class.

Operations

Operation signature

Vis

Operation Description

TestBuilder ( )

Pub

Constructor.

getCurrentTest ( ): Test

Pub

Returns the current opened test.

setCurrentTest (test: Test): void

Pub

Sets a test as current.

addReal (judg: Judgement): void

Pub

Adds real judgement to the current test.

removeReal (index: int): void

Pub

Removes real judgement from the current test according to its position.

getRealJudgements ( ): Vector

Pub

Returns all real judgements as a Vector.

addPractice (judg: Judgement): void

Pub

Adds practice judgement to the current test.

removePractice (index: int): void

Pub

Removes real judgement from the current test according to its position.

getPracticeJudgements ( ): Hashtable

Pub

Returns all practice judgements as a Vector.

setInterMode (imode: int): void

Pub

Sets the interaction mode of the current test.

setRandomMode (rmode: int): void

Pub

Sets the randomization mode of the current test.

setInstructions (inst: Instruction): void

Pub

Sets the instructions.

addPracticeFromReal (realindex: int): void

Pub

Copies a real judgement to the practice judgement list.

getUniqueInstance ( ): TestBuilder

Pub

Returns the unique instance of the TestBuilder.

Class

ResultManager

Impl ResultProcessing

Description

Represents a high level interface for managing project results. ResultManager forwards all requests to the ResultPlugin which has an implementation of all functions.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

unique-Instance

Result-Manager

Priv


Y

Stores the unique instance of this class.

resultPlugin

Result-Plugin

Priv



Points to ResultPlugin assigned to ResultManager.

Operations

Operation signature

Vis

Operation Description

ResultManager ( )

Priv

Private constructor.

ResultManager (plugin: ResultPlugin)

Pub

Public constructor. ResultPlugin is passed as a parameter.

setResultPlugin (plugin: ResultPlugin): void

Pub

Assigns ResultPlugin to ResultManager.

openResults (projname: String): ProjectResults [ ]

Pub

Opens results of a project of all participants for a given project name and returns the array of ProjectResults.

saveResults (results: ProjectResults): void

Pub

Saves project results represented by ProjectResults.

autoImport ( ): void

Pub

Performs an automatic import of results.

manualImport (folderpath: String): void

Pub

Performs a manual import of results.

createReport (projname: String): void

Pub

Generates report for further result analysis for a given project name.

getUniqueInstance( ): ResultManager

Pub

Returns the unique instance of the ResultManager.

Class

ConfigManager

Impl ConfigProcessing

Description

Represents a high level interface for managing configuration information. ConfigManager forwards all requests to the ConfigPlugin which has an implementation of all functions.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

unique-Instance

Config-Manager

Priv



Stores the unique instance of this class.

config-Plugin

Config-Plugin

Priv



Points to ConfigPlugin assigned to ConfigManager.

Operations

Operation signature

Vis

Operation Description

ConfigManager ( )

Priv

Private constructor.

ConfigManager (plugin: ConfigPlugin)

Pub

Public constructor. ConfigPlugin is passed as a parameter.

setConfigPlugin (plugin: ConfigPlugin): void

Pub

Assigns ConfigPlugin to ConfigManager.

setValues (type: int, values: String [ ]): void

Pub

Stores values passed as an array for a particular configuration type.

getValues (type: int): String [ ]

Pub

Retrieves values as an array for a particular configuration type.

setValue (type: int, values: String ): void

Pub

Stores value for a particular configuration type.

getValue (type: int): String

Pub

Retrieves value for a particular configuration type.

getUniqueInstance ( ): ConfigManager

Pub

Returns the unique instance of the ConfigManager.

Class

ProjectRunner

Description

Represents an object which has the task to run project chosen by the test participant. ProjectRunner communicates with GUI and guides which screen should be opened according to the run position in the project and the test.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

results

Project-Results

Priv



Stores project results information during the project being run.

runmode

int

Priv



Indicates the running mode type, real test mode or preview mode. Values allowed are MODE_PREVIEW and MODE_REAL.

runningtest

Test

Priv



Contains current test being run from the project.

running-JudgStart

int

Priv



These attributes implement the sliding window of judgements in the test. They indicate which range of judgements should be shown to user. If only one judgement should be shown at a time then these attributes are equal. In other cases they point to the current start and end positions in the list of judgements.

Represents the start of the sliding window.

running-JudgEnd

int

Priv



Represents the end of the sliding window.

soundUtility

Sound-Utility

Priv



SoundUtility object which is used to play sounds.

MODE_PREVIEW

int

Pub

1

Y

Preview mode constant.

MODE_REAL

int

Pub

2

Y

Real test constant.

Operations

Operation signature

Vis

Operation Description

ProjectRunner ( )

Pub

Constructor.

runProject (projname: String, mode: int): void

Pub

Runs the project. Communicates with ProjectManager to open the project.

runTest (test: Test): void

Pub

Runs the test. This operation is launched by runProject operation.

saveResults ( ): void

Pub

Saves results collected during the tests.

getRunMode ( ): int

Pub

Returns the running mode.

getRunningTest ( ): Test

Pub

Returns the test being run.

getRunningProject ( ): Project

Pub

Returns the project being run.

getRunningJudgStart ( ): int

Pub

Returns the beginning of judgement sliding window.

getRunnigJudgEnd ( ): int

Pub

Return the end of judgement sliding window.

playSound ( ): void

Pub

Plays sound. Delegates sound playing to SoundUtility.

getProjectManager ( ): ProjectManager

Prot

Returns the unique ProjectManager instance.

getResultManager ( ): ResultManager

Prot

Returns the unique ResultManager instance.

showPanel ( ): void

Priv

Pops up a screen depending on the position in the test.

B.3 Proxy package class specfication

Class

ProjectStoragePlugin

Impl ProjectProcessing

Description

Class that implements project management functions.

Operations

Operation signature

Vis

Operation Description

ProjectStoragePlugin ( )

Pub

Constructor.

newProject (name: String): Project

Pub

Creates the new Project with a given name.

openProject (name: String): Project

Pub

Opens the existing Project with a given name. Open project is stored in ProjectBuilder.

saveProject (project: Project): void

Pub

Saves the project passed as the parameter.

deleteProject (name: String): void

Pub

Deletes the project with the given name.

activateProject (name: String): void

Pub

Activates the project with the given name.

reactivateProject (name: String): void

Pub

Reactivates the project with the given name.

closeProject (name: String): void

Pub

Closes the project with a given name.

renameProject (name: String, newname: String): void

Pub

Renames the project.

duplicateProject (name: String, newname: String): void

Pub

Duplicates the project. A new name is assigned to the new copy.

listProjectsAndTests ( ): Hashtable

Pub

Returns all Projects and Tests hierarchy as Hashtable. Each hashtable entry contains name of the project as a key, and another hash table for its tests.

listProjects ( ): Hashtable

Pub

Return all projects as a Hashtable. The key of the hashtable is the project name.

isUniqueProjectName (name: String): boolean

Pub

Checks whether the name of a project is unique or not.

getConfigManager ( ): ConfigManager

Prot

Returns the unique instance of the ConfigManager.

Class

ResultPlugin

Impl ResultProcessing

Description

Class that implements result management functions.

Operations

Operation signature

Vis

Operation Description

ResultPlugin ( )

Pub

Constructor.

openResults (projname: String): ProjectResults [ ]

Pub

Opens results of a project of all participants for a given project name and returns the array of ProjectResults.

saveResults (results: ProjectResults): void

Pub

Saves project results represented by ProjectResults.

autoImport ( ): void

Pub

Performs an automatic import of results.

manualImport (folderpath: String): void

Pub

Performs a manual import of results.

createReport (projname: String): void

Pub

Generates report for further result analysis for a given project name.

getConfigManager ( ): ConfigManager

Prot

Returns the unique instance of ConfigManager.

importResults (folderpath: String): void

Priv

Implements result import function. Is invoked by autoImport and manualImport operations.

Class

ConfigPlugin

Impl ConfigProcessing

Description

Class that implements configuration management functions.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

config

Hashtable

Priv



Attribute where configuration information is stored after the load operation.

Operations

Operation signature

Vis

Operation Description

ConfigPlugin ( )

Pub

Constructor

setValues (type: int, values: String [ ]): void

Pub

Stores values passed as an array for a particular configuration type.

getValues (type: int): String [ ]

Pub

Retrieves values as an array for a particular configuration type.

setValue (type: int, values: String ): void

Pub

Stores value for a particular configuration type.

getValue (type: int): String

Pub

Retrieves value for a particular configuration type.

loadConfiguration ( )

Priv

Loads configuration information from the persistent storage to `config' attribute.

saveConfiguration ( )

Priv

Saves configuration information from memory to persistent storage.

Class

SoundUtility

Description

Class for playing sounds.

Operations

Operation signature

Vis

Operation Description

SoundUtility ( )

Pub

Constructor.

playSound (folderpath: String, snd: Sound)

Pub

Plays sound file. The folder path and Sound object should be provided.

B.4 GUI class specification

Class

TestPanel

Description

Parent class for all panels that are shown during the test run.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

project-Runner

Project-Runner

Priv



ProjectRunner object used to get information about the test information.

Operations

Operation signature

Vis

Operation Description

TestPanel (runner: ProjectRunner)

Pub

Constructor. ProjectRunner is passed as a parameter.

isInputFinished ( ): boolean

Prot

Validates the input of a user.

Class

RegistrationPanel

Extends TestPanel

Description

Represents the registration form, which should be filled out before running the tests.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

personItems

String [ ]

Priv



Array of personal attributes to fill out.

persInfo

String [ ]

Priv



Information provided by user.

Operations

Operation signature

Vis

Operation Description

RegistrationPanel (items: String[ ], info: String [ ], runner: ProjectRunner)

Pub

Constructor.

isInputFinished ( ): boolean

Prot

Validates the input from a user.

Class

TextInstructionsPanel

Extends TestPanel

Description

Represents the text instructions panel.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

Instructions

Instruction

Priv



Test instructions.

Operations

Operation signature

Vis

Operation Description

TextInstructionsPanel (inst: Instruction, runner: ProjectRunner)

Pub

Constructor.

Class

AudioInstructionsPanel

Extends TestPanel

Description

Represents the audio instructions panel.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

Instructions

Instruction

Priv



Test instructions.

Operations

Operation signature

Vis

Operation Description

AudioInstructionsPanel (inst: Instruction, runner: ProjectRunner)

Pub

Constructor.

Class

AutomaticModePanel

Extends TestPanel

Description

Panel used in automatic mode, which shows one judgement at a time.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

Bar

Judgement-Bar

Priv



Judgement bar used.

Operations

Operation signature

Vis

Operation Description

AutomaticModePanel (runner: ProjectRunner)

Pub

Constructor.

isInputFinished ( ): boolean

Prot

Validates the input of a user.

Class

InteractiveModePanel

Extends TestPanel

Description

Panel used in interactive mode, which shows several judgements at a time.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

Bars

Vector

Priv



Vector of Judgement bars.

Operations

Operation signature

Vis

Operation Description

InteractiveModePanel (runner: ProjectRunner)

Pub

Constructor.

isInputFinished ( ): boolean

Prot

Validates the input of a user.

Class

PracticeFinishPanel

Extends TestPanel

Description

Informational panel before real test starts.

Operations

Operation signature

Vis

Operation Description

PracticeFinishPanel (runner: ProjectRunner)

Pub

Constructor.

Class

TestFinishPanel

Extends TestPanel

Description

Informational panel when the test is finished

Operations

Operation signature

Vis

Operation Description

TestFinishPanel (runner: ProjectRunner)

Pub

Constructor.

Class

ProjectFinishPanel

Extends TestPanel

Description

Informational panel when the project is finished.

Operations

Operation signature

Vis

Operation Description

ProjectFinishPanel (runner: ProjectRunner)

Pub

Constructor.

Class

JudgementBar

Description

Contains sounds and a scale.

Attributes

Name

Type

Vis

Initial

Static

Attribute Description

Scale

Scale

Priv



Scale used in the bar.

Judgement

Judgement

Priv



Judgement assigned to the bar.

Mode

int

Priv



Mode: ProjectRunner.MODE_PREVIEW or ProjectRunner.MODE_REAL.

Operations

Operation signature

Vis

Operation Description

JudgementBar (jscale: Scale, judg: Judgement, jmode: int)

Pub

Constructor.

paintScale ( ): void

Pub

Paints the scale on the panel.

paintBar ( ): void

Prot

Paints the bar (scale and sounds).

setScrore (jscore: Score)

Prot

Sets the score.

Class

SingleJudgementBar

Extends JudgementBar

Description

Bar with single sound judgement.

Operations

Operation signature

Vis

Operation Description

SingleJudgementBar (jscale: Scale, judg: Judgement, jmode: int)

Pub

Constructor.

paintBar ( )

Prot

Paints the bar (scale and sounds).

Class

PairedJudgementBar

Extends JudgementBar

Description

Bar with paired sound judgement.

Operations

Operation signature

Vis

Operation Description

PairedJudgementBar (jscale: Scale, judg: Judgement, jmode: int)

Pub

Constructor.

paintBar ( )

Prot

Paints the bar (scale and sounds).



Quadralay Corporation
http://www.webworks.com
Voice: (512) 719-3399
Fax: (512) 719-3606
sales@webworks.com
TOC PREV NEXT INDEX