com.goldenhammer.test
Class Study

java.lang.Object
  com.goldenhammer.test.Study

All Implemented Interfaces:

java.io.Serializable

public class Study

extends java.lang.Object

implements java.io.Serializable

This class represents a study which is executed by a modality and is created through a test profile.

See Also:

Serialized Form

Field Summary

static java.lang.String	DOCTYPE
static java.lang.String	SERIE_IMAGE_PATH_NODE The name of the node containing the path of an image for a series.
static java.lang.String	SERIES_IMAGES_NODE The name of the study's images node.
static java.lang.String	SERIES_INTERVAL_ATTRIBUTE The name of the study's name attribute node.
static java.lang.String	SERIES_NAME_ATTRIBUTE The name of a series' name attribute node.
static java.lang.String	SERIES_NODE_NAME The name of a node containing a Series' data.
static java.lang.String	SERIES_NUMBER_ATTRIBUTE The name of the study's name attribute node.
static java.lang.String	SERIES_RANDOM_ATTRIBUTE The name of the study's name attribute node.
static java.lang.String	SERIES_SLEEP_ATTRIBUTE The name of the study's name attribute node.
static java.lang.String	STUDY_NAME_ATTRIBUTE The name of the study's name attribute node.
static java.lang.String	STUDY_TEMPLATE

Constructor Summary

Study()
Constructor

Study(java.lang.String xmlProfile)
Creates a new study.

Study(java.lang.String xmlProfile, int repeat, java.lang.String rand)
Creates a new study.

Method Summary

void	addSeries(Series series) Add a series to this study
java.lang.String	getRandomFunc()
int	getRepeat()
java.util.Collection	getSeries()
java.lang.String	getStudyName()
java.lang.String	getStudyProfile()
void	save(java.lang.String filename) Saves this modality to an XML file.
void	setRandomFunc(java.lang.String randomFunc)
void	setRepeat(int repeat)
void	setStudyName(java.lang.String studyName)
void	setStudyProfile(java.lang.String studyProfile)

Methods inherited from class java.lang.Object

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

Field Detail

STUDY_NAME_ATTRIBUTE

public static final java.lang.String STUDY_NAME_ATTRIBUTE

The name of the study's name attribute node.

See Also:

Constant Field Values

SERIES_NAME_ATTRIBUTE

public static final java.lang.String SERIES_NAME_ATTRIBUTE

The name of a series' name attribute node.

See Also:

Constant Field Values

SERIES_NUMBER_ATTRIBUTE

public static final java.lang.String SERIES_NUMBER_ATTRIBUTE

The name of the study's name attribute node.

See Also:

Constant Field Values

SERIES_RANDOM_ATTRIBUTE

public static final java.lang.String SERIES_RANDOM_ATTRIBUTE

The name of the study's name attribute node.

See Also:

Constant Field Values

SERIES_INTERVAL_ATTRIBUTE

public static final java.lang.String SERIES_INTERVAL_ATTRIBUTE

The name of the study's name attribute node.

See Also:

Constant Field Values

SERIES_SLEEP_ATTRIBUTE

public static final java.lang.String SERIES_SLEEP_ATTRIBUTE

The name of the study's name attribute node.

See Also:

Constant Field Values

SERIES_IMAGES_NODE

public static final java.lang.String SERIES_IMAGES_NODE

The name of the study's images node.

See Also:

Constant Field Values

SERIE_IMAGE_PATH_NODE

public static final java.lang.String SERIE_IMAGE_PATH_NODE

The name of the node containing the path of an image for a series.

See Also:

Constant Field Values

SERIES_NODE_NAME

public static final java.lang.String SERIES_NODE_NAME

The name of a node containing a Series' data.

See Also:

Constant Field Values

DOCTYPE

public static final java.lang.String DOCTYPE

See Also:

Constant Field Values

STUDY_TEMPLATE

public static final java.lang.String STUDY_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

Study

public Study(java.lang.String xmlProfile,
             int repeat,
             java.lang.String rand)
      throws StudyException

Creates a new study.

Parameters:

xmlProfile - The path to the study's XML template.

repeat - // TODO Define repeat

rand - // TODO Define the random function.

Throws:

StudyException - thrown if an illegal xml document is passed

Study

public Study(java.lang.String xmlProfile)
      throws StudyException

Creates a new study.

Parameters:

xmlProfile - The path to the study's XML template.

Throws:

StudyException - thrown if an illegal xml document is passed

Study

public Study()

Constructor

Method Detail

getSeries

public java.util.Collection getSeries()

Returns:

Returns the series.

getStudyName

public java.lang.String getStudyName()

Returns:

Returns the studyName.

getStudyProfile

public java.lang.String getStudyProfile()

Returns:

Returns the location of the studie's XML profile.

setStudyProfile

public void setStudyProfile(java.lang.String studyProfile)

Parameters:

studyProfile - The studyProfile to set.

setStudyName

public void setStudyName(java.lang.String studyName)

Parameters:

studyName - The studyName to set.

addSeries

public void addSeries(Series series)

Add a series to this study

Parameters:

series - the series to add

getRandomFunc

public java.lang.String getRandomFunc()

Returns:

Returns the randomFunc.

setRandomFunc

public void setRandomFunc(java.lang.String randomFunc)

Parameters:

randomFunc - The randomFunc to set.

getRepeat

public int getRepeat()

Returns:

Returns the repeat.

setRepeat

public void setRepeat(int repeat)

Parameters:

repeat - The repeat to set.

save

public void save(java.lang.String filename)
          throws java.io.IOException

Saves this modality to an XML file.

Parameters:

filename - The desired name of the XML file.

Throws:

java.io.IOException - If the file could not be written.