com.sas.graphics.components
Class AnalysisVariable

java.lang.Object
  |
  +--com.sas.graphics.components.ModelBase
        |
        +--com.sas.graphics.components.Variable
              |
              +--com.sas.graphics.components.RangeVariable
                    |
                    +--com.sas.graphics.components.AnalysisVariable

Direct Known Subclasses:

AnalysisVariableList, SummarizedVariable

public class AnalysisVariable

extends RangeVariable

An AnalysisVariable is used by a chart when a statistic can be applied to the associated data values.

Usage

You can apply a mean statistic to the associated data values by setting the statistic property. Here is an example where an AnalysisVariable is being designated a data column and the statistic assigned is mean.

 AnalysisVariable myAnalysisVariable = new AnalysisVariable("Sales",GraphConstants.STATISTIC_MEAN);
 

*

Behavior

Applying a statistic to an AnalysisVariable determines how the variable will be used as a role in a chart. For example, if the statisic were set to GraphConstants.STATISTIC_MEAN (as in the above example) and the variable used as a response in a bar chart, the bars would be the heights corresponding to the mean of the responses in each category.

Properties

• statistic

Name	statistic
Type	AnalysisVariable
Default value	DEFAULT
Short description	Allows a statistic to be designated on this variable.
Description	Allows a statistic to be designated on this variable. DEFAULT refers is used to imply the chart's default statistic should be applied.

Since:

SAS 9.1

See Also:

GraphConstants, Variable, VariableList, ClassificationVariable, ClassificationVariableList, AnalysisVariableList

Constructor Summary

AnalysisVariable(AnalysisVariable av)
Constructor for AnalysisVariable.

AnalysisVariable(int columnIndex)
Constructor designating data column by index.

AnalysisVariable(int columnIndex, String format, String informat, String label, int statistic)
Constructor designating data column by index along with the names of the SAS format and SAS informat and label to be applied.

AnalysisVariable(int columnIndex, String format, String informat, String label, int statistic, int highColumnIndex, String highLabel, int lowColumnIndex, String lowLabel)
Constructor for AnalysisVariable.

AnalysisVariable(String columnName)
Constructor designating data column by name.

AnalysisVariable(String columnName, int statistic)
Constructor designating data column by name and defining a statistic.

AnalysisVariable(String columnName, String format)
Constructor designating data column by name along with the name of the SAS format to be applied.

AnalysisVariable(String columnName, String format, String informat, String label, int statistic)
Constructor designating data column by name.

AnalysisVariable(String columnName, String format, String informat, String label, int statistic, String highColumnName, String highLabel, String lowColumnName, String lowLabel)
Constructor for AnalysisVariable.

Method Summary

boolean	equals(Object obj) Determines whether another object is equal to this AnalysisVariable.
int	getStatistic() Returns the type of statistic applied to the values in the data column designated by this variable.
int	hashCode() Computes the hash code for this AnalysisVariable.

Methods inherited from class com.sas.graphics.components.RangeVariable

getHighColumnIndex, getHighColumnName, getHighLabel, getLowColumnIndex, getLowColumnName, getLowLabel

Methods inherited from class com.sas.graphics.components.Variable

getColumnIndex, getColumnName, getFormat, getInformat, getLabel

Methods inherited from class com.sas.graphics.components.ModelBase

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalysisVariable

public AnalysisVariable(String columnName)

Constructor designating data column by name.

Parameters:

columnName - the name identifying the data column

AnalysisVariable

public AnalysisVariable(String columnName,
                        int statistic)

Constructor designating data column by name and defining a statistic.

Parameters:

columnName - the name identifying the data column

statistic - the statistic to be applied to the associated data values.

Valid statistic values are:

• GraphConstants.STATISTIC_LAST
• GraphConstants.STATISTIC_MEAN
• GraphConstants.STATISTIC_FREQ
• GraphConstants.STATISTIC_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_SUM
• GraphConstants.STATISTIC_PERCENTAGE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_SUM
• GraphConstants.STATISTIC_MIN
• GraphConstants.STATISTIC_MAX
• GraphConstants.STATISTIC_FIRST

See Also:

GraphConstants

AnalysisVariable

public AnalysisVariable(String columnName,
                        String format)

Constructor designating data column by name along with the name of the SAS format to be applied.

Parameters:

columnName - the name identifying the data column

format - the name of the SAS format applied (by the graph) on the values found in this variable's data column

AnalysisVariable

public AnalysisVariable(String columnName,
                        String format,
                        String informat,
                        String label,
                        int statistic)

Constructor designating data column by name.

Parameters:

columnName - the name identifying the data column

format - the name of the SAS format applied (by the graph) on the values found in this variable's data column

informat - the name of the SAS informat applied (by the graph) on the values found in this variable's data column

label - the label the chart will display via data tips, axis labels and legend labels (where applicable)

statistic - the statistic to be applied to the associated data values.

Valid statistic values are:

• GraphConstants.STATISTIC_LAST
• GraphConstants.STATISTIC_MEAN
• GraphConstants.STATISTIC_FREQ
• GraphConstants.STATISTIC_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_SUM
• GraphConstants.STATISTIC_PERCENTAGE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_SUM
• GraphConstants.STATISTIC_MIN
• GraphConstants.STATISTIC_MAX
• GraphConstants.STATISTIC_FIRST

See Also:

GraphConstants

AnalysisVariable

public AnalysisVariable(int columnIndex)

Constructor designating data column by index.

Parameters:

columnIndex - the index identifying the data column

AnalysisVariable

public AnalysisVariable(int columnIndex,
                        String format,
                        String informat,
                        String label,
                        int statistic)

Constructor designating data column by index along with the names of the SAS format and SAS informat and label to be applied.

Parameters:

columnIndex - the index identifying the data column

format - the name of the SAS format applied (by the graph) on the values found in this variable's data column

informat - the name of the SAS informat applied (by the graph) on the values found in this variable's data column

label - the label the chart will display via data tips, axis labels and legend labels (where applicable)

statistic - the statistic to be applied to the associated data values.

Valid statistic values are:

• GraphConstants.STATISTIC_LAST
• GraphConstants.STATISTIC_MEAN
• GraphConstants.STATISTIC_FREQ
• GraphConstants.STATISTIC_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_SUM
• GraphConstants.STATISTIC_PERCENTAGE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_SUM
• GraphConstants.STATISTIC_MIN
• GraphConstants.STATISTIC_MAX
• GraphConstants.STATISTIC_FIRST

See Also:

GraphConstants

AnalysisVariable

public AnalysisVariable(String columnName,
                        String format,
                        String informat,
                        String label,
                        int statistic,
                        String highColumnName,
                        String highLabel,
                        String lowColumnName,
                        String lowLabel)

Constructor for AnalysisVariable.

Parameters:

columnName - the name identifying the data column

format - the name of the SAS format applied (by the graph) on the values found in this variable's data column

informat - the name of the SAS informat applied (by the graph) on the values found in this variable's data column

label - the label the chart will display via data tips, axis labels and legend labels (where applicable)

statistic - the statistic to be applied to the associated data values.

highColumnName -

highLabel -

lowColumnName -

lowLabel -

Valid statistic values are:

• GraphConstants.STATISTIC_LAST
• GraphConstants.STATISTIC_MEAN
• GraphConstants.STATISTIC_FREQ
• GraphConstants.STATISTIC_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_SUM
• GraphConstants.STATISTIC_PERCENTAGE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_SUM
• GraphConstants.STATISTIC_MIN
• GraphConstants.STATISTIC_MAX
• GraphConstants.STATISTIC_FIRST

See Also:

GraphConstants

AnalysisVariable

public AnalysisVariable(int columnIndex,
                        String format,
                        String informat,
                        String label,
                        int statistic,
                        int highColumnIndex,
                        String highLabel,
                        int lowColumnIndex,
                        String lowLabel)

Constructor for AnalysisVariable.

Parameters:

columnIndex - the index identifying the data column

format - the name of the SAS format applied (by the graph) on the values found in this variable's data column

informat - the name of the SAS informat applied (by the graph) on the values found in this variable's data column

label - the label the chart will display via data tips, axis labels and legend labels (where applicable)

statistic - the statistic to be applied to the associated data values.

highColumnIndex -

highLabel -

lowColumnIndex -

lowLabel -

Valid statistic values are:

• GraphConstants.STATISTIC_LAST
• GraphConstants.STATISTIC_MEAN
• GraphConstants.STATISTIC_FREQ
• GraphConstants.STATISTIC_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_FREQ
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_FREQ
• GraphConstants.STATISTIC_SUM
• GraphConstants.STATISTIC_PERCENTAGE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_SUM
• GraphConstants.STATISTIC_CUMULATIVE_PERCENTAGE_SUM
• GraphConstants.STATISTIC_MIN
• GraphConstants.STATISTIC_MAX
• GraphConstants.STATISTIC_FIRST

See Also:

GraphConstants

AnalysisVariable

public AnalysisVariable(AnalysisVariable av)

Constructor for AnalysisVariable.

Parameters:

av -

Method Detail

getStatistic

public final int getStatistic()

Returns the type of statistic applied to the values in the data column designated by this variable.

equals

public boolean equals(Object obj)

Determines whether another object is equal to this AnalysisVariable.

The result is true if and only if the argument is not null and is a AnalysisVariable object that has the same property values as this object.

Overrides:

equals in class Variable

Parameters:

obj - the object to test for equality with this AnalysisVariable

Returns:

true if the objects are the same; false otherwise.

hashCode

public int hashCode()

Computes the hash code for this AnalysisVariable.

Overrides:

hashCode in class Variable

Returns:

a hash code value for this object.