com.softwarefx.chartfx.server.statistical

Class Statistics

java.lang.Object

com.softwarefx.chartfx.server.statistical.Statistics

All Implemented Interfaces:

IExtension

public class Statistics
extends java.lang.Object
implements IExtension

Provides access to the Statistics object

This is the core class of the Statistical Extension. The supported members of the Statistics class allow developers to access many other classes implemented in the Statistical Extension. Calculating statistical values, adding studies to a chart and controling the legend are a few of the tasks you will need to access this class to complete.

Constructor Summary

Constructors

Constructor and Description
Statistics() Constructs a newly allocated Statistics object

Method Summary

Methods

Modifier and Type	Method and Description
void	addDataChangedListener(EventListener value) Adds a DataChangedListener to the listener list.
void	addStudyChangedListener(StudyChangedListener value) Adds a StudyChangedListener to the listener list.
CalculatorMulti	getCalculators() Gets a CalculatorMulti or Calculator object containing chart values.
CalculatorMulti	getCalculatorsRaw() Gets a CalculatorMulti or Calculator object containing all the original data values passed to the chart.
Chart	getChart() Gets or sets a value indicating the chart which the Statistical Extension will be included.
int	getCommandID(StatisticsCommandId id) Used to obtain the CommandID for Statistical commands.
int	getConfidence() Gets or sets the default Confidence level for the Statistical Extension.
java.util.Locale	getCulture() Gets or sets a CultureInfo object to localize a Statistics object for a specific language and region.
Galleries	getGallery() Returns a Galleries object.
int[]	getIgnoredSeries() Gets or sets an array indicating the chart series to ignore in chart calculations.
LegendBox	getLegendBox() Gets or sets a value indicating whether to show or hide the statistical legend.
int	getSelectedSeries() Gets or sets the selected series for statistical analysis.
StudiesCollection	getStudies() Gets the Studies Collection object.
boolean	isAutoSelectSeries() Gets or sets a value indicating the Statistical extension to automatically select a series during the highlight event.
boolean	isEnableViewState() Description goes here
boolean	isFreeze() Gets or sets a value specifying whether to stop the calculation of limit values used in SPC charts for evaluations or to continue processing new data values.
boolean	isSampleData() Gets or sets a value indicating whether calculations based on Sample or Population data.
void	loadState(java.io.InputStream stream) Used to load previous Usl and Lsl values to be saved from a SPC chart at a earlier time.
void	removeDataChangedListener(EventListener value) Removes a DataChangedListener from the listener list.
void	removeStudyChangedListener(StudyChangedListener value) Removes a StudyChangedListener from the listener list.
void	resetAutoSelectSeries() Set the property AutoSelectSeries to its default value.
void	resetConfidence() Set the property Confidence to its default value.
void	resetFreeze() Set the property Freeze to its default value.
void	resetSampleData() Set the property SampleData to its default value.
void	resetSelectedSeries() Set the property SelectedSeries to its default value.
void	saveState(java.io.OutputStream stream) Used to save the current Usl and Lsl values to be loaded into an SPC chart at a later time.
void	setAutoSelectSeries(boolean value) Gets or sets a value indicating the Statistical extension to automatically select a series during the highlight event.
void	setChart(Chart value) Gets or sets a value indicating the chart which the Statistical Extension will be included.
void	setConfidence(int value) Gets or sets the default Confidence level for the Statistical Extension.
void	setCulture(java.util.Locale value) Gets or sets a CultureInfo object to localize a Statistics object for a specific language and region.
void	setEnableViewState(boolean value) Description goes here
void	setFreeze(boolean value) Gets or sets a value specifying whether to stop the calculation of limit values used in SPC charts for evaluations or to continue processing new data values.
void	setIgnoredSeries(int[] value) Gets or sets an array indicating the chart series to ignore in chart calculations.
void	setSampleData(boolean value) Gets or sets a value indicating whether calculations based on Sample or Population data.
void	setSelectedSeries(int value) Gets or sets the selected series for statistical analysis.

Methods inherited from class java.lang.Object

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

Constructor Detail

Statistics

public Statistics()

Constructs a newly allocated Statistics object

Method Detail

isAutoSelectSeries

public boolean isAutoSelectSeries()

Gets or sets a value indicating the Statistical extension to automatically select a series during the highlight event.

The Statistical Legend will display study information specific to the series selected in a highlight event when multiple data series are included in a chart. Chart FX automatically configures the series highlighted as the selected series.

Due to the nature in which some statistical galleries are created, the automatically selected series can display incorrect information in the legend. An example of this is when the BoxPlot gallery is selected.

By configuring this method to false and handling the HightLight event, you can configure the selected series method for the Statistical extension so the correct data is displayed in the legend.

To disable the auto select series feature:

See Also:

resetAutoSelectSeries

setAutoSelectSeries

public void setAutoSelectSeries(boolean value)

Gets or sets a value indicating the Statistical extension to automatically select a series during the highlight event.

The Statistical Legend will display study information specific to the series selected in a highlight event when multiple data series are included in a chart. Chart FX automatically configures the series highlighted as the selected series.

Due to the nature in which some statistical galleries are created, the automatically selected series can display incorrect information in the legend. An example of this is when the BoxPlot gallery is selected.

By configuring this method to false and handling the HightLight event, you can configure the selected series method for the Statistical extension so the correct data is displayed in the legend.

To disable the auto select series feature:

Parameters:

value -

See Also:

resetAutoSelectSeries

getCalculators

public CalculatorMulti getCalculators()

Gets a CalculatorMulti or Calculator object containing chart values.

getCalculatorsRaw

public CalculatorMulti getCalculatorsRaw()

Gets a CalculatorMulti or Calculator object containing all the original data values passed to the chart.

getChart

public Chart getChart()

Gets or sets a value indicating the chart which the Statistical Extension will be included.

If more than chart is exists on a form or a page, this method is used to select the chart the extension will be attached.

The setConfidence method allows you to configure the confidence level for the statstical extension.

To configure chart1 as the statistical chart:

setChart

public void setChart(Chart value)

Gets or sets a value indicating the chart which the Statistical Extension will be included.

If more than chart is exists on a form or a page, this method is used to select the chart the extension will be attached.

The setConfidence method allows you to configure the confidence level for the statstical extension.

To configure chart1 as the statistical chart:

Parameters:

value -

getConfidence

public int getConfidence()

Gets or sets the default Confidence level for the Statistical Extension.

The Confidence Level is defined as the degree of confidence associated with a confidence interval; the probablity that the interval contains the true value of the parameter.

The setSelectedSeries method is used to select a particular series for analysis in the chart.

To configure the Confidence for a chart to 90:

See Also:

resetConfidence

setConfidence

public void setConfidence(int value)

Gets or sets the default Confidence level for the Statistical Extension.

The Confidence Level is defined as the degree of confidence associated with a confidence interval; the probablity that the interval contains the true value of the parameter.

The setSelectedSeries method is used to select a particular series for analysis in the chart.

To configure the Confidence for a chart to 90:

Parameters:

value -

See Also:

resetConfidence

getCulture

public java.util.Locale getCulture()

Gets or sets a CultureInfo object to localize a Statistics object for a specific language and region.

When setting this method, you may need the Culture Name or Culture Identifier constants for the desired culture. These values are documented in your development environment documentation.

For more information regarding the CultureInfo type, please refer to your development environment documentation.

setCulture

public void setCulture(java.util.Locale value)

Gets or sets a CultureInfo object to localize a Statistics object for a specific language and region.

When setting this method, you may need the Culture Name or Culture Identifier constants for the desired culture. These values are documented in your development environment documentation.

For more information regarding the CultureInfo type, please refer to your development environment documentation.

Parameters:

value -

isEnableViewState

public boolean isEnableViewState()

Description goes here

setEnableViewState

public void setEnableViewState(boolean value)

Description goes here

Parameters:

value -

isFreeze

public boolean isFreeze()

Gets or sets a value specifying whether to stop the calculation of limit values used in SPC charts for evaluations or to continue processing new data values.

A Statistical Process Control (SPC) or control chart provides basis for deciding whether the variation in the output is due to common causes (in control) or assignable causes (out of control).

By "freezing" the extension, values used to determine the upper and lower specification limits will not be adjusted. Once a acceptable limit values have been set, new samples observations may be evaluated to determine whether a process is in control.

The loadState method may be used to load previous setUsl and setLsl values to be saved from a SPC chart at a earlier time.

The saveState method may be used to save a current SPC chart's state.

To instruct the statistical extension to freeze all the limit variables in an SPC chart:

See Also:

resetFreeze

setFreeze

public void setFreeze(boolean value)

Gets or sets a value specifying whether to stop the calculation of limit values used in SPC charts for evaluations or to continue processing new data values.

A Statistical Process Control (SPC) or control chart provides basis for deciding whether the variation in the output is due to common causes (in control) or assignable causes (out of control).

By "freezing" the extension, values used to determine the upper and lower specification limits will not be adjusted. Once a acceptable limit values have been set, new samples observations may be evaluated to determine whether a process is in control.

The loadState method may be used to load previous setUsl and setLsl values to be saved from a SPC chart at a earlier time.

The saveState method may be used to save a current SPC chart's state.

To instruct the statistical extension to freeze all the limit variables in an SPC chart:

Parameters:

value -

See Also:

resetFreeze

getGallery

public Galleries getGallery()

Returns a Galleries object.

getIgnoredSeries

public int[] getIgnoredSeries()

Gets or sets an array indicating the chart series to ignore in chart calculations.

This method allows you to specify a set of series to be completely ignored by the calculators, studies and all the gallery types.

To instruct Chart FX to ignore series 3 and 4:

setIgnoredSeries

public void setIgnoredSeries(int[] value)

Gets or sets an array indicating the chart series to ignore in chart calculations.

This method allows you to specify a set of series to be completely ignored by the calculators, studies and all the gallery types.

To instruct Chart FX to ignore series 3 and 4:

Parameters:

value -

getLegendBox

public LegendBox getLegendBox()

Gets or sets a value indicating whether to show or hide the statistical legend.

isSampleData

public boolean isSampleData()

Gets or sets a value indicating whether calculations based on Sample or Population data.

See Also:

resetSampleData

setSampleData

public void setSampleData(boolean value)

Gets or sets a value indicating whether calculations based on Sample or Population data.

Parameters:

value -

See Also:

resetSampleData

getSelectedSeries

public int getSelectedSeries()

Gets or sets the selected series for statistical analysis.

For many studies, it will be required to select a determined series in order to analyze that data specifically. For example, before adding a the UpperQuartile study, here the first series is selected as the SelectedSeries:

To configure the 3rd series as the SelectedSeries:

See Also:

resetSelectedSeries

setSelectedSeries

public void setSelectedSeries(int value)

Gets or sets the selected series for statistical analysis.

For many studies, it will be required to select a determined series in order to analyze that data specifically. For example, before adding a the UpperQuartile study, here the first series is selected as the SelectedSeries:

To configure the 3rd series as the SelectedSeries:

Parameters:

value -

See Also:

resetSelectedSeries

getStudies

public StudiesCollection getStudies()

Gets the Studies Collection object.

getCommandID

public int getCommandID(StatisticsCommandId id)

Used to obtain the CommandID for Statistical commands.

When the Statistical Extension is added to the Chart, commands may be added to the default Chart FX CommandID list. If you wanted to customize this command, you will need to know the CommandID assigned by the Chart FX CommandID list. This method will return this value. For example, the following code could be used to obtain the CommandID of the Statistical Legend added to the chart:

To obtain the CommandID of the Statistical Legend added to the chart:

Parameters:

id - Statistical CommandID.

loadState

public void loadState(java.io.InputStream stream)

Used to load previous Usl and Lsl values to be saved from a SPC chart at a earlier time.

A Statistical Process Control (SPC) or control chart provides basis for deciding whether the variation in the output is due to common causes (in control) or assignable causes (out of control).

Using this method, you can load the upper and lower limits from a previous process. By loading limit values from a previous sample that was determined to be "in control", you can easily determine if the current sample is "in control" or "out of control".

The saveState method may be used to save a current SPC chart's state.

To load the state of a SPC chart from a stream:

Parameters:

stream - Output stream to load the state values.

resetAutoSelectSeries

public void resetAutoSelectSeries()

Set the property AutoSelectSeries to its default value.

See Also:

isAutoSelectSeries

resetConfidence

public void resetConfidence()

Set the property Confidence to its default value.

See Also:

setConfidence

resetFreeze

public void resetFreeze()

Set the property Freeze to its default value.

See Also:

isFreeze

resetSampleData

public void resetSampleData()

Set the property SampleData to its default value.

See Also:

isSampleData

resetSelectedSeries

public void resetSelectedSeries()

Set the property SelectedSeries to its default value.

See Also:

setSelectedSeries

saveState

public void saveState(java.io.OutputStream stream)

Used to save the current Usl and Lsl values to be loaded into an SPC chart at a later time.

A Statistical Process Control (SPC) or control chart provides basis for deciding whether the variation in the output is due to common causes (in control) or assignable causes (out of control).

Using this method, you can load the upper and lower limits from a previous process. By loading limit values from a previous sample that was determined to be "in control", you can easily determine if the current sample is "in control" or "out of control".

The loadState method may be used to load a previously saved SPC chart state.

To save the state of a SPC chart to a stream:

Parameters:

stream - Output stream to save the state values.

addDataChangedListener

public void addDataChangedListener(EventListener value)

Adds a DataChangedListener to the listener list.

Parameters:

value -

removeDataChangedListener

public void removeDataChangedListener(EventListener value)

Removes a DataChangedListener from the listener list.

Parameters:

value -

addStudyChangedListener

public void addStudyChangedListener(StudyChangedListener value)

Adds a StudyChangedListener to the listener list.

Parameters:

value -

removeStudyChangedListener

public void removeStudyChangedListener(StudyChangedListener value)

Removes a StudyChangedListener from the listener list.

Parameters:

value -