com.softwarefx.chartfx.server.statistical
Class StudyTest

java.lang.Object
  com.softwarefx.chartfx.server.statistical.Study
      com.softwarefx.chartfx.server.statistical.StudyTest

All Implemented Interfaces:

IStudy

public class StudyTest
extends Study
implements IStudy

Provides access to the StudyTest object

This class is specifically used to control attributes of test studies.

Constructor Summary

StudyTest(StudyType studyType, int id)

Method Summary

int	getConfidence() Gets the Confidence.
String	getValue(int series) Sets the value for a StudyCustom object.
boolean	isShowConfidence() Gets the ShowConfidence.
void	setConfidence(int value) Sets the confidence level for the selected test.
void	setShowConfidence(boolean value) Sets a value indicating whether the confidence level will be displayed.

Methods inherited from class com.softwarefx.chartfx.server.statistical.Study

createStudy, createStudy, createStudy, createStudy, createStudy, getColor, getDecimals, getID, getText, getValue, isBold, isIndented, isInteractive, isVisible, setBold, setDecimals, setIndented, setText, setValue, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.softwarefx.chartfx.server.statistical.IStudy

getColor, getText, isBold, isIndented, isInteractive, isVisible, setBold, setIndented, setVisible

Constructor Detail

StudyTest

public StudyTest(StudyType studyType,
                 int id)

Method Detail

getConfidence

public int getConfidence()

Gets the Confidence. For more detail see setConfidence(int).

getValue

public String getValue(int series)

Sets the value for a StudyCustom object.

Remarks:

The Statistics.getStudies() property of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies property may also be used to obain the entire StudiesCollection.

This property may only be used with StudyCustom objects, as other study objects will have precalcuated values based on the chart data. In order for a StudyCustom item to have a value, it must be configured.

Specified by:

getValue in interface IStudy

Overrides:

getValue in class Study

See Also:

Statistics.getStudies(), StudyCustom, StudiesCollection, Statistics

isShowConfidence

public boolean isShowConfidence()

Gets the ShowConfidence. For more detail see setShowConfidence(boolean).

setConfidence

public void setConfidence(int value)

Sets the confidence level for the selected test.

Remarks:

You can obtain the StudyTest object for a selected test when adding the test to the Studies collection as follows:

The #ShowProbability property indicates whether to show Passed/Failed or the actual probablity value of the test as the result.

See Also:

#setShowProbability, Statistics.getStudies(), StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), Statistics, StudiesCollection

setShowConfidence

public void setShowConfidence(boolean value)

Sets a value indicating whether the confidence level will be displayed.

Remarks:

When this property is set to false, the pass or fail results will be displayed for the test in the legend. When set to true, the actual probablity value will be displayed in the legend.

You can obtain the StudyTest object for a selected test when adding the test to the Studies collection as follows:

See Also:

setConfidence(int), #setShowProbability, StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection, Statistics