All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class guinea.logic.Test

java.lang.Object
   |
   +----guinea.logic.Test

public class Test

extends Object

implements PropertyLoader, Runnable

Variable Index

· currentItem

· currentItemIndex

· defaultPlayer

The default sound player to use if specific player is wanted.

· defaultPlayerClassName

· defaultPlayerName

· defaultSubjectUI

The default subject UI block used for testing.

· disableWhenDone

Disable subject UI when subject is done with item or timeout has expired.

· doneCond

Used to wait until all subject are done.

· enableDoneWhenAnswers

Enable DONE-button only after answers to all questions has been given.

· enableQuestionsAfterPlaying

Answering to questions is allowed only after all samples have been listened to.

· FILETYPE_PROPERTIES

Save data using textual property files. Deprecated.

· FILETYPE_SERIALIZED

Save data using java's serialization system.

· items

List of all test items in the 'test items' file.

· itemsFile

The file that contains item properties.

· itemsFilename

The name of the file that contains item properties.

· itemsProps

The properties used to contruct the item objects.

· itemStartTime

· itemTemplates

A table of test items to use as the templates when loading test items.

· itemTimeout

The timeout of item in milliseconds.

· itemWarningTimeout

If the time to answer is limited, a warning is given before the time expires.

· listenedSamples

During an item, set to true when all item samples (or sample sequence) has been played.

· log

· MCLL

MCLL level of test.

· MCLLmax

Maximum MCLL that subject can set.

· MCLLmin

Minimum MCLL that subject can set.

· numSwitches

· playerProps

The properties that contain the parameters of the player.

· playerTable

· playlist

The playlist as a vector.

· playlistFile

The file that contains the playlist.

· playlistFilename

The name of the file that contains the play list.

· progressStatusMonitorID

The monitor object ID of the test progress monitor object.

· requireAllAnswers

Requires that answer gives answers to all questions.

· resultsFile

The results file.

· resultsFilename

The file name of results file.

· resultsFileType

File type of saving files.

· resultsSaved

Shows whether result file has already been written out.

· samples

List of samples for this test.

· sampleSequence

The fixed sample sequence to play to subjects if fixed sequence type selected.

· samplesFile

The file that contains sample information.

· samplesFilename

The name of the file that contains sample information.

· samplesProps

The properties used to contruct the sample objects.

· sampleSwitching

The sample switching type.

· SEQUENCE_FIXED

Sample sequence is fixed.

· SEQUENCE_FORCED

Sample sequence is forced (same as fixed). Deprecated.

· SEQUENCE_FREE

Subject can play samples freely.

· sequenceType

Type of sequence, free or fixed.

· sessionID

ID of the current session.

· sessionItems

Test items presented in this session in playlist order.

· sessionLog

· sessionSubjectItems

· sessionSubjects

Group of subjects participating in this test session.

· showProgressStatus

Whether to show test progress status information to the subjects.

· subjectSetsMCLL

If set to true, the subject sets the MCL level before proceeding to the actual items.

· SWITCHING_NORMAL

· SWITCHING_PARALLEL

· testDirectory

The directory of the test.

· testInProgress

Is the test in progress right now.

· testThread

The thread that runs the test.

· timeoutOccured

Used in the test to indicate that at least one of subject's answering time has expired.

· TIMINGSTART_AFTER_ITEMRUN

Item duration timing start after the item/sequence has been run.

· TIMINGSTART_BEFORE_ITEMRUN

Item duration timing start before the item/sequence is run.

· trainingMode

Is training mode on (true), results are not saved.

· uiFile

The file that contains UI properties.

· uiFilename

The name of the file that contains UI properties.

· uiProps

The properties used to contruct an UI interface object.

· whenTimingStarts

Tells when to start the timing of the duration of item.

Constructor Index

· Test()

Method Index

· addItem(String, Item)

· addSubject()

Create a new test session subject and add it to the session's subject group.

· addSubject(SessionSubject)

Add a new subject to the test session.

· addSubject(String)

Create a new test session subject with specified subject ID and add it to the session's subject group.

· addSubject(String, SubjectUI)

Create a new test session subject with specified subject ID and UI, and add it to the session's subject group.

· controlPerformed(ControlEvent, SessionSubject)

· doneItem(ControlEvent, SessionSubject)

· endItem()

Finish current item.

· endItemSamples()

Unload and remove sample objects that were needed with this item.

· endItemUI()

· endPlayer()

· endTest()

· getDefaultItemTemplate()

Get or construct a default test item template for use with this test.

· getDefaultPlayerClassName()

· getItem(int)

Get test item.

· getItem(String)

Get test item.

· getItemBinding(int)

· getItemBinding(Item)

· getItemBinding(String)

· getItemClassName()

Get the default class name of the test item used by this test.

· getItemIndex(Item)

Get the index of a test item.

· getItemIndex(String)

Get the index of a test item.

· getItemsFile()

· getItemsFilename()

· getItemTemplates()

Get a table (dictionary) of test item templates that are used in the test.

· getItemTimeout()

Get the current value of item timeout

· getItemWarningTimeout()

Get the current value of warning timeout

· getNewSessionSubject()

Create a new session subject.

· getNumItems()

Get the number of items in the test.

· getNumSessionItems()

Get the number of test items that are to be presented in this session.

· getPlayer(String)

· getPlaylistFile()

· getPlaylistFilename()

Get the name of the playlist file.

· getProgressStatusInfo()

Get the test progress status info to show to the subject.

· getResultsFile()

· getResultsFilename()

· getSampleSequence()

Get the fixed sample sequence.

· getSamplesFile()

· getSamplesFilename()

· getSampleSwitching()

Get the sample switching type.

· getSequenceType()

Get the type of the sample sequence.

· getSessionID()

Get the session ID of this session.

· getSessionItem(int)

· getSessionItem(int, SessionSubject)

· getSessionItems(SessionSubject)

· getSessionSubjects()

· getTestDirectory()

Get the test directory of this test.

· getTestDirectoryName()

Get the test directory of this test.

· getUIFile()

· getUIFilename()

· initItem()

Initialize current item.

· initItemSamples()

Load and create sample objects for playing.

· initItemUI()

· initPlayer()

Initialize the sound player.

· initPlayerNew(String, Properties)

Initialize the sound player.

· initPlayerOld(Properties)

Initialize the sound player.

· initSessionItems()

· initTest()

· loadItems()

Load test items from files to the test.

· loadSamples()

· loadTest(String)

Deprecated.

· loadTest(String, String)

Deprecated.

· loadUI()

· loadUIProperties()

· makeSessionItems()

· makeSessionItems(BindingVector, Vector)

· progressCheck()

· progressCheck(String)

· propertyLoad(Properties, String)

· putPlayer(String, Player)

· removeSubject(SessionSubject)

Remove a subject from session's subject group.

· run()

· runItem()

· runSequence()

· runTest()

Start the test and run it in the current thread.

· saveItemResults()

· saveTestResults()

· serializeResults(String)

· setConfigFile(String)

· setItemsFilename(String)

· setItemTimeout(double)

Set the item timeout.

· setItemWarningTimeout(double)

Set the warning timeout.

· setPlaylistFilename(String)

Set the file name of the playlist file.

· setQuestionsEnabled(boolean)

Enable or disable the question (answer) components for all subjects.

· setResultsFilename(String)

· setSampleSequence(Sequence)

Set the fixed sample sequence.

· setSamplesFilename(String)

· setSampleSwitching(int)

Set the sample switching type.

· setSequenceType(int)

Set the type of the sample sequence.

· setSessionID(String)

Set the session ID for this session.

· setSessionItem(int, SessionSubject, Item)

· setTestDirectory(File)

Set the test directory.

· setTestDirectory(String)

Set the test directory.

· setUIFilename(String)

· setWarningIndicators(double, double)

Used internally to set the timeout and warning indicators for all activesubjects.

· setWarningIndicators(int, int)

Used internally to set up the timeout and warning indicators for all active subjects.

· showProgressStatus(SubjectUI, Object)

Show test progress status to the subject.

· startTest()

Start the test and run it in a new thread.

· startWarningIndicators()

Variables

 public static final int SEQUENCE_FIXED

 public static final int SEQUENCE_FORCED

 public static final int SEQUENCE_FREE

 protected int sequenceType

Type of sequence, free or fixed. The default is SEQUENCE_FREE.

See Also:

SEQUENCE_FREE, SEQUENCE_FIXED

 protected Sequence sampleSequence

The fixed sample sequence to play to subjects if fixed sequence type selected.

See Also:

sequenceType, getSampleSequence, setSampleSequence

 public static final int SWITCHING_NORMAL

 public static final int SWITCHING_PARALLEL

 protected int sampleSwitching

The sample switching type.

See Also:

getSampleSwitching, setSampleSwitching, SWITCHING_NORMAL, SWITCHING_PARALLEL

 protected transient int numSwitches

 protected String sessionID

ID of the current session. If no session ID is given, an automatically generated ID is used instead (is will be a string 'S' and the difference, measured in minutes, between the current time and midnight, January 1, 1970 UTC).

 protected SessionSubjectGroup sessionSubjects

Group of subjects participating in this test session.

 protected BindingVector items

List of all test items in the 'test items' file.

 protected Item sessionItems[]

Test items presented in this session in playlist order.

 protected Hashtable sessionSubjectItems

 protected String itemsFilename

The name of the file that contains item properties.

 protected File itemsFile

The file that contains item properties.

 protected Properties itemsProps

The properties used to contruct the item objects.

 protected Hashtable itemTemplates

A table of test items to use as the templates when loading test items.

 protected String playlistFilename

The name of the file that contains the play list.

 protected File playlistFile

The file that contains the playlist.

 protected Vector playlist

The playlist as a vector. It contains the names (IDs) of items that are to be played in this order.

 protected String samplesFilename

The name of the file that contains sample information.

 protected File samplesFile

The file that contains sample information.

 protected Properties samplesProps

The properties used to contruct the sample objects.

 protected BindingVector samples

List of samples for this test.

 protected boolean disableWhenDone

 protected boolean requireAllAnswers

 protected boolean enableDoneWhenAnswers

 protected boolean enableQuestionsAfterPlaying

 protected boolean trainingMode

 protected String uiFilename

The name of the file that contains UI properties.

 protected File uiFile

The file that contains UI properties.

 protected Properties uiProps

The properties used to contruct an UI interface object.

 protected SubjectUI defaultSubjectUI

The default subject UI block used for testing. It is loaded from the file 'uiFilename'.

 protected AudioPlayer defaultPlayer

The default sound player to use if specific player is wanted.

 protected Properties playerProps

The properties that contain the parameters of the player.

 protected long itemTimeout

 protected long itemWarningTimeout

 protected String resultsFilename

The file name of results file. If null, a name will be created.

 protected File resultsFile

The results file. If null, a name will be created.

 public static final int FILETYPE_SERIALIZED

 public static final int FILETYPE_PROPERTIES

 protected int resultsFileType

 protected boolean resultsSaved

 protected SessionLog sessionLog

 public static final int TIMINGSTART_BEFORE_ITEMRUN

 public static final int TIMINGSTART_AFTER_ITEMRUN

 public int whenTimingStarts

 protected boolean subjectSetsMCLL

 protected Volume MCLLmin

Minimum MCLL that subject can set.

 protected Volume MCLLmax

Maximum MCLL that subject can set.

 protected Volume MCLL

MCLL level of test. Before test starts, this is also set to default inital value.

 protected boolean showProgressStatus

 protected String progressStatusMonitorID

The monitor object ID of the test progress monitor object.

 protected File testDirectory

The directory of the test. All pathnames are relative to this directory.

 protected Logger log

 protected transient int currentItemIndex

 protected transient Item currentItem

 protected transient long itemStartTime

 protected transient boolean testInProgress

 protected transient boolean listenedSamples

 protected transient Thread testThread

The thread that runs the test.

 protected transient boolean timeoutOccured

 protected transient KeyCounter doneCond

 protected String defaultPlayerClassName

 protected String defaultPlayerName

 protected Hashtable playerTable

Constructors

 public Test()

Methods

 public Item getItem(int index)

Get test item.

Parameters:

index - is the index to the item list

 public Item getItem(String itemID)

Get test item.

Parameters:

itemID - is the ID of item

 public int getItemIndex(String itemID)

Get the index of a test item.

Parameters:

itemID - is a item id.

 public int getItemIndex(Item item)

Get the index of a test item.

Parameters:

item - is a test item.

 public int getNumItems()

Get the number of items in the test.

Returns:

number of items or -1 if items haven't been loaded yet.

 public Binding getItemBinding(int index)

 public Binding getItemBinding(String itemID)

 public Binding getItemBinding(Item item)

 public void addItem(String name,
                     Item item)

 public int getNumSessionItems()

Get the number of test items that are to be presented in this session. If a playlist is used, the number is the number of items specified in the playlist. If playlist is not used, the number of items is the number of all test items.

Returns:

The number of test items in this session.

See Also:

sessionItems

 public void initSessionItems()

 protected Item[] getSessionItems(SessionSubject s)

 public Item getSessionItem(int index)

 public Item getSessionItem(int index,
                            SessionSubject s)

 public Item setSessionItem(int index,
                            SessionSubject s,
                            Item item)

 public SessionSubject getNewSessionSubject()

Create a new session subject. This test is set as its test. No other variables of the subject are set and the subject is not added to session subject group.

Returns:

A new session subject.

 public SessionSubject addSubject()

Create a new test session subject and add it to the session's subject group. A new subject ID is generated for the subject.

Returns:

A new session subject.

 public SessionSubject addSubject(String subjID)

Create a new test session subject with specified subject ID and add it to the session's subject group.

Parameters:

subjID - Subject ID for new subject.

Returns:

A new session subject.

 public SessionSubject addSubject(SessionSubject subj)

Add a new subject to the test session. If the subject hasn't yet a subject ID, one is generated.

Parameters:

subj - A subject to add. If null, a new subject is created with getNewSessionSubject().

Returns:

The subject given as parameter subj or a new subject if no was provided.

See Also:

getNewSessionSubject

 public SessionSubject addSubject(String subjID,
                                  SubjectUI ui)

Create a new test session subject with specified subject ID and UI, and add it to the session's subject group.

Parameters:

subjID - Subject ID for new subject. If null, a new ID is generated.

ui - The subject UI panel to use for the new subject.

Returns:

A new SessionSubject object.

 public boolean removeSubject(SessionSubject s)

Remove a subject from session's subject group.

Parameters:

s - The subject to remove from group.

Returns:

False if the subject was not included in the group, otherwise true is returned.

 public SessionSubjectGroup getSessionSubjects()

 public SubjectUI loadUI() throws ClassNotFoundException, InstantiationException, IllegalAccessException, IOException

 public Properties loadUIProperties() throws IOException

 public Thread startTest()

Start the test and run it in a new thread. If the test is already running, the test's thread is returned. This method returns immediately. You can use thread's join() method to wait for the end of test.

Returns:

The thread that runs the test.

 public void runTest()

Start the test and run it in the current thread. This method returns when the test has been run.

 public void run()

 public void initTest() throws Exception

 protected void initItemUI()

 protected Object getProgressStatusInfo()

Get the test progress status info to show to the subject.

Returns:

a progress status info object.

 protected void showProgressStatus(SubjectUI ui,
                                   Object info)

Show test progress status to the subject.

Parameters:

ui - The subject UI that shows the info.

info - An object containing status info about the test. If null, no status info is shown.

 protected void runItem() throws InterruptedException

 protected void runSequence() throws InterruptedException

 protected void saveItemResults()

 protected void endItemUI()

 public void saveTestResults() throws Exception

 public void endTest()

 protected void initItem() throws Exception

Initialize current item. Loads samples, reset answers, init gui.

Throws: Exception

an exception is thrown if item initialization fails for some reason.

 protected void endItem()

Finish current item. Unload samples, setup GUI, record answers.

 protected void initItemSamples() throws Exception

Load and create sample objects for playing. Information about samples are read from the information about the current item.

Throws: Exception

initialization of samples may throw a exception if something went wrong.

 protected void endItemSamples()

Unload and remove sample objects that were needed with this item.

 public String getDefaultPlayerClassName()

 protected void initPlayer() throws Exception

Initialize the sound player.

Throws: Exception

an exception is thrown if player initialization fails for some reason.

 public Player getPlayer(String name)

 public void putPlayer(String name,
                       Player player)

 protected void initPlayerNew(String names,
                              Properties playerProps) throws Exception

Initialize the sound player.

Throws: Exception

an exception is thrown if player initialization fails for some reason.

 protected void initPlayerOld(Properties playerProps) throws Exception

Initialize the sound player.

Throws: Exception

an exception is thrown if player initialization fails for some reason.

 protected void endPlayer()

 protected void serializeResults(String filename) throws IOException

 public Sequence getSampleSequence()

Get the fixed sample sequence.

Returns:

The fixed sample sequence that is to play to subjects. Returns null if sequence has not been set.

See Also:

sampleSequence, setSampleSequence

 public void setSampleSequence(Sequence seq)

Set the fixed sample sequence.

Parameters:

seq - The sequence to be used in the test or null to remove fixed sequence.

See Also:

sampleSequence, getSampleSequence

 public int getSequenceType()

Get the type of the sample sequence.

Returns:

SEQUENCE_FREE for free sequence or SEQUENCE_FIXED for fixed sequence.

See Also:

setSequenceType, sequenceType, SEQUENCE_FREE, SEQUENCE_FIXED

 public void setSequenceType(int type)

Set the type of the sample sequence.

Parameters:

type - SEQUENCE_FREE for free sequence or SEQUENCE_FIXED for fixed sequence.

See Also:

getSequenceType, sequenceType, SEQUENCE_FREE, SEQUENCE_FIXED

 public int getSampleSwitching()

Get the sample switching type.

Returns:

Either SWITCHING_PARALLEL or SWITCHING_NORMAL

See Also:

setSampleSwitching, sampleSwitching, SWITCHING_NORMAL, SWITCHING_PARALLEL

 public void setSampleSwitching(int type)

Set the sample switching type.

Parameters:

type - SWITCHING_PARALLEL or SWITCHING_NORMAL

See Also:

getSampleSwitching, sampleSwitching, SWITCHING_NORMAL, SWITCHING_PARALLEL

 public void setItemTimeout(double seconds)

Set the item timeout. It is the time the subject has available to give his/hers answers.

Parameters:

secondstimeout - in seconds

See Also:

itemTimeout, setItemWarningTimeout, getItemTimeout

 public double getItemTimeout()

Get the current value of item timeout

Returns:

timeout in seconds.

See Also:

itemTimeout, setItemTimeout, getItemWarningTimeout

 public void setItemWarningTimeout(double seconds)

Set the warning timeout. It is the time before actual timeout when the warning indicator is lit.

Parameters:

seconds - seconds before the timeout to show the warning.

See Also:

itemWarningTimeout, setItemTimeout, getItemWarningTimeout

 public double getItemWarningTimeout()

Get the current value of warning timeout

Returns:

warning timeout in seconds.

See Also:

itemWarningTimeout, setItemTimeout, setItemWarningTimeout

 protected void setWarningIndicators(int timeout,
                                     int warning)

Used internally to set up the timeout and warning indicators for all active subjects.

Parameters:

timeout - Timeout in milliseconds.

warning - Warning time in milliseconds.

 protected void setWarningIndicators(double timeout,
                                     double warning)

Used internally to set the timeout and warning indicators for all activesubjects.

Parameters:

timeout - timeout in seconds

warning - warning time in seconds

 protected void startWarningIndicators()

 public void setSessionID(String sessionID)

Set the session ID for this session.

Parameters:

sessionID - The session ID for the session.

See Also:

getSessionID, sessionID

 public String getSessionID()

Get the session ID of this session.

Returns:

The session ID of this test session.

See Also:

setSessionID, sessionID

 public void setConfigFile(String filename)

 public File getTestDirectory()

Get the test directory of this test.

Returns:

The test directory.

 public String getTestDirectoryName()

Get the test directory of this test.

Returns:

The directory name.

 public void setTestDirectory(String dir)

Set the test directory.

Parameters:

dir - The test directory. If it is a file, its parent directory will be used.

 public void setTestDirectory(File dir)

Set the test directory.

Parameters:

dir - The test directory. If it is a file, its parent directory will be used.

 protected void progressCheck(String error)

 protected void progressCheck()

 public void loadItems() throws Exception

Load test items from files to the test.

Throws: Exception

if something goes wrong in loading.

 public void makeSessionItems()

 public Item[] makeSessionItems(BindingVector allItems,
                                Vector names)

 public void loadSamples() throws Exception

 public void controlPerformed(ControlEvent e,
                              SessionSubject subj)

 public void doneItem(ControlEvent e,
                      SessionSubject subj)

 protected void setQuestionsEnabled(boolean enabled)

Enable or disable the question (answer) components for all subjects.

 public String getItemClassName()

Get the default class name of the test item used by this test.

Returns:

A class name of test item.

 public Item getDefaultItemTemplate()

Get or construct a default test item template for use with this test. The default implementation creates a template by creating an instance of the default item class got from getItemClassName(). Subclasses may also override this with their own.

Returns:

A test item template or null if class not specified or instantiation failed.

See Also:

getItemClassName

 public Dictionary getItemTemplates()

Get a table (dictionary) of test item templates that are used in the test. The table generally contains at least the 'default' template.

Parameters:

A - dictionary of test item templates.

 public void setItemsFilename(String filename)

 public String getItemsFilename()

 public File getItemsFile()

 public void setUIFilename(String filename)

 public String getUIFilename()

 public File getUIFile()

 public void setSamplesFilename(String filename)

 public String getSamplesFilename()

 public File getSamplesFile()

 public void setResultsFilename(String filename)

 public String getResultsFilename()

 public File getResultsFile()

 public void setPlaylistFilename(String filename)

Set the file name of the playlist file.

Parameters:

playlist - Name of the playlist file.

 public String getPlaylistFilename()

Get the name of the playlist file.

Returns:

The file name of the playlist or null if no playlist has been set.

 public File getPlaylistFile()

 public void propertyLoad(Properties p,
                          String name) throws IllegalArgumentException

 public static Test loadTest(String configFilename) throws Exception

Note: loadTest() is deprecated. use TestHelp.loadTest methods instead.

 public static Test loadTest(String configFilename,
                             String name) throws Exception

Note: loadTest() is deprecated. use TestHelp.loadTest methods instead.

All Packages  Class Hierarchy  This Package  Previous  Next  Index