com.softwarefx.chartfx.server.statistical
Class Study

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

All Implemented Interfaces:

IStudy

Direct Known Subclasses:

StudyInteractive, StudyTest

public class Study
extends Object
implements IStudy

Provides access to the Study object

The Study class provides developers with an API to control general attributes consistent with all the supported studies of the Chart FX Statistical Extention. These members may be used to customize statistic studies in the chart. All study specific classes are derived from this class.

Constructor Summary

Study(StudyType studyType, int id)

Method Summary

static Study	createStudy(Analysis analysis) Used to create a study without adding the study to the StudiesCollection.
static Study	createStudy(AnalysisMulti analysis) Used to create a study without adding the study to the StudiesCollection.
static StudyFormula	createStudy(DistributionFormula distribution) Used to create a study without adding the study to the StudiesCollection.
static StudyTest	createStudy(Test test) Used to create a study without adding the study to the StudiesCollection.
static StudyTest	createStudy(TestMulti test) Used to create a study without adding the study to the StudiesCollection.
Color	getColor() Error: Member Study.Color member not found
int	getDecimals() Gets the Decimals.
int	getID() Returns the Id of a study object.
String	getText() Gets the Text.
double	getValue() Gets the Value.
String	getValue(int series) Gets the Value.
boolean	isBold() Gets the Bold.
boolean	isIndented() Gets the Indented.
boolean	isInteractive() Error: Member Study.Interactive member not found
boolean	isVisible() Error: Member Study.Visible member not found
void	setBold(boolean value) Sets a value indicating whether the selected study's title will be bold.
void	setDecimals(int value) Sets the number of decimal spaces displayed for a study.
void	setIndented(boolean value) Sets a value indicating whether the selected study's title will indent.
void	setText(String value) Sets the string used for the selected study's title.
void	setValue(double value) Sets the value for a StudyCustom object.
void	setVisible(boolean value) Error: Member Study.Visible member not found

Methods inherited from class java.lang.Object

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

Constructor Detail

Study

public Study(StudyType studyType,
             int id)

Method Detail

createStudy

public static Study createStudy(Analysis analysis)

Used to create a study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a selected study without adding it to the StudiesCollection object. The StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

analysis - Create a AnalysisMulti study.

See Also:

StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection

createStudy

public static Study createStudy(AnalysisMulti analysis)

Used to create a study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a selected study without adding it to the StudiesCollection object. The StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

analysis - Create a AnalysisMulti study.

See Also:

StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection

createStudy

public static StudyFormula createStudy(DistributionFormula distribution)

Used to create a study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a selected study without adding it to the StudiesCollection object. The StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

distribution - Create a DistributionFormula study.

See Also:

StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection

createStudy

public static StudyTest createStudy(Test test)

Used to create a study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a selected study without adding it to the StudiesCollection object. The StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

test - Create a Test study.

See Also:

StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection

createStudy

public static StudyTest createStudy(TestMulti test)

Used to create a study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a selected study without adding it to the StudiesCollection object. The StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

test - Create a Test study.

See Also:

StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection

getColor

public Color getColor()

Error: Member Study.Color member not found

ERROR: Doc member not found

Specified by:

getColor in interface IStudy

getDecimals

public int getDecimals()

Gets the Decimals. For more detail see setDecimals(int).

getID

public int getID()

Returns the Id of a study 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 is a read-only property.

The setText(java.lang.String) property allows you to customize the text for a selected study's title.

The setBold(boolean) property allows you to display the study's title bold or in non-bold font.

See Also:

Statistics.getStudies(), setBold(boolean), setDecimals(int), setIndented(boolean), setText(java.lang.String), Statistics, StudiesCollection

getText

public String getText()

Gets the Text. For more detail see setText(java.lang.String).

Specified by:

getText in interface IStudy

getValue

public double getValue()

Gets the Value. For more detail see setValue(double).

getValue

public String getValue(int series)

Gets the Value. For more detail see setValue(double).

Specified by:

getValue in interface IStudy

isBold

public boolean isBold()

Gets the Bold. For more detail see setBold(boolean).

Specified by:

isBold in interface IStudy

isIndented

public boolean isIndented()

Gets the Indented. For more detail see setIndented(boolean).

Specified by:

isIndented in interface IStudy

isInteractive

public boolean isInteractive()

Error: Member Study.Interactive member not found

ERROR: Doc member not found

Specified by:

isInteractive in interface IStudy

isVisible

public boolean isVisible()

Error: Member Study.Visible member not found

ERROR: Doc member not found

Specified by:

isVisible in interface IStudy

setBold

public void setBold(boolean value)

Sets a value indicating whether the selected study's title will be bold.

Remarks:

The setText(java.lang.String) property allows you to customize the text for a selected study's title.

The setIndented(boolean) property allows you to control if the selected study's title will be indented or not.

Specified by:

setBold in interface IStudy

See Also:

Statistics.getStudies(), setText(java.lang.String), setIndented(boolean), StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), Statistics, StudiesCollection

setDecimals

public void setDecimals(int value)

Sets the number of decimal spaces displayed for a study.

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.

The setText(java.lang.String) property allows you to customize the text for a selected study's title.

The setBold(boolean) property allows you to display the study's title bold or in non-bold font.

See Also:

Statistics.getStudies(), setText(java.lang.String), setBold(boolean), setIndented(boolean), getID(), Statistics, StudiesCollection

setIndented

public void setIndented(boolean value)

Sets a value indicating whether the selected study's title will indent.

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.

The setText(java.lang.String) property allows you to customize the text for a selected study's title.

The setBold(boolean) property allows you to display the study's title bold or in non-bold font.

Specified by:

setIndented in interface IStudy

See Also:

Statistics.getStudies(), setText(java.lang.String), setBold(boolean), Statistics, StudiesCollection

setText

public void setText(String value)

Sets the string used for the selected study's title.

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.

The setBold(boolean) property allows you to display the study's title bold or in non-bold font.

The setIndented(boolean) property allows you to control if the selected study's title will be indented or not.

See Also:

Statistics.getStudies(), setBold(boolean), setIndented(boolean), Statistics, StudiesCollection

setValue

public void setValue(double value)

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.

See Also:

Statistics.getStudies(), StudyCustom, StudiesCollection, Statistics

setVisible

public void setVisible(boolean value)

Error: Member Study.Visible member not found

ERROR: Doc member not found

Specified by:

setVisible in interface IStudy