com.sas.graphics.components
Class RangeVariable

com.sas.graphics.components.RangeVariable

Direct Known Subclasses:

AnalysisVariable, PlotVariable

public abstract class RangeVariable

A RangeVariable is an abstract class which supports the association of low, high and target columns with the column property inherited from the Variable class.

Subclasses of this variable may add additional properties that may not necessarily be applicable in all applications of this variable. Documentation on the DataModel properties (where instances of these variables can be set) should provide additional documentation on which variable properties are applicable. Not all variable properties are applicable in all configurations.
For instance, the targetColumn properties (actually targetColumnName or targetColumnIndex) are applicable in graphs capable of displaying target data elements. In the SAS v9.2 release this is only applicable to the BarChart, BarLineChart and KPIChart graphs.
Similarly the highColumn and lowColumn are only applicable in graphs that support high/low data elements which in SAS v9.2 includes BarChart, BarLineChart, LineChart, ScatterPlot and LinePlot.

Since:

SAS 9.1

See Also:

Variable, VariableList, PlotVariable, PlotVariableList

Constructor Summary

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

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

RangeVariable(int columnIndex, java.lang.String format, java.lang.String informat, java.lang.String label, com.sas.graphics.components.CategorizationModel categorizationModel, com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle)

RangeVariable(int columnIndex, java.lang.String format, java.lang.String informat, java.lang.String label, com.sas.graphics.components.CategorizationModel categorizationModel, com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle, int targetColumnIndex, java.lang.String targetLabel)
Constructor designating data column and target column by index along with the names of the SAS format and SAS informat and labels to be applied.

RangeVariable(int columnIndex, java.lang.String format, java.lang.String informat, java.lang.String label, com.sas.graphics.components.CategorizationModel categorizationModel, com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle, int highColumnIndex, java.lang.String highLabel, int lowColumnIndex, java.lang.String lowLabel)
Constructor designating data column, high column and low column by index along with the names of the SAS format and SAS informat and labels to be applied.

RangeVariable(int columnIndex, java.lang.String format, java.lang.String informat, java.lang.String label, int targetColumnIndex, java.lang.String targetLabel)
Constructor designating data column and target column by index along with the names of the SAS format and SAS informat and labels to be applied.

RangeVariable(int columnIndex, java.lang.String format, java.lang.String informat, java.lang.String label, int highColumnIndex, java.lang.String highLabel, int lowColumnIndex, java.lang.String lowLabel)
Constructor designating data column, high column and low column by index along with the names of the SAS format and SAS informat and labels to be applied.

RangeVariable(RangeVariable rv)
Constructor for RangeVariable

RangeVariable(java.lang.String columnName)
Constructor designating data column by name.

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

RangeVariable(java.lang.String columnName, java.lang.String format, java.lang.String informat, java.lang.String label)
Constructor designating data column by name along with formats and the label.

RangeVariable(java.lang.String columnName, java.lang.String format, java.lang.String informat, java.lang.String label, com.sas.graphics.components.CategorizationModel categorizationModel, com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle)

RangeVariable(java.lang.String columnName, java.lang.String format, java.lang.String informat, java.lang.String label, com.sas.graphics.components.CategorizationModel categorizationModel, com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle, java.lang.String targetColumnName, java.lang.String targetLabel)
Constructor designating data column and target column by name along with the names of the SAS format and SAS informat and labels to be applied.

RangeVariable(java.lang.String columnName, java.lang.String format, java.lang.String informat, java.lang.String label, com.sas.graphics.components.CategorizationModel categorizationModel, com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle, java.lang.String highColumnName, java.lang.String highLabel, java.lang.String lowColumnName, java.lang.String lowLabel)
Constructor designating data column, high column and low column by name along with the names of the SAS format and SAS informat and labels to be applied.

RangeVariable(java.lang.String columnName, java.lang.String format, java.lang.String informat, java.lang.String label, java.lang.String targetColumnName, java.lang.String targetLabel)
Constructor designating data column and target column by name along with the names of the SAS format and SAS informat and labels to be applied.

RangeVariable(java.lang.String columnName, java.lang.String format, java.lang.String informat, java.lang.String label, java.lang.String highColumnName, java.lang.String highLabel, java.lang.String lowColumnName, java.lang.String lowLabel)
Constructor designating data column, high column and low column by name along with the names of the SAS format and SAS informat and labels to be applied.

Method Summary

int	getHighColumnIndex() Returns the data column index specified by the user.
java.lang.String	getHighColumnName() Returns the data column name specified by the user.
java.lang.String	getHighLabel() Returns the user-specified label.
int	getLowColumnIndex() Returns the data column index specified by the user.
java.lang.String	getLowColumnName() Returns the data column name specified by the user.
java.lang.String	getLowLabel() Returns the user-specified label.
int	getTargetColumnIndex() Returns the "target" data column index specified by the user.
java.lang.String	getTargetColumnName() Returns the "target" data column name specified by the user.
java.lang.String	getTargetLabel() Returns the user-specified "target" label.

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

equals, getCategorizationModel, getColumnIndex, getColumnName, getFormat, getInformat, getLabel, getSegmentedRangeStyle, hashCode

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

addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, removePropertyChangeListener, setContainedModel

Constructor Detail

RangeVariable

public RangeVariable(java.lang.String columnName)

Constructor designating data column by name.

Parameters:

columnName - the name identifying the data column

RangeVariable

public RangeVariable(java.lang.String columnName,
                     java.lang.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

RangeVariable

public RangeVariable(java.lang.String columnName,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label)

Constructor designating data column by name along with formats and the label.

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)

RangeVariable

public RangeVariable(java.lang.String columnName,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     com.sas.graphics.components.CategorizationModel categorizationModel,
                     com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle)

RangeVariable

public RangeVariable(int columnIndex)

Constructor designating data column by index.

Parameters:

columnIndex - the column index identifying the data column

RangeVariable

public RangeVariable(int columnIndex,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label)

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 column 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)

RangeVariable

public RangeVariable(int columnIndex,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     com.sas.graphics.components.CategorizationModel categorizationModel,
                     com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle)

RangeVariable

public RangeVariable(java.lang.String columnName,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     java.lang.String highColumnName,
                     java.lang.String highLabel,
                     java.lang.String lowColumnName,
                     java.lang.String lowLabel)

Constructor designating data column, high column and low column by name along with the names of the SAS format and SAS informat and labels 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

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)

highColumnName - the name identifying the high data column

highLabel - the label the chart will display via data tips.

lowColumnName - the name identifying the low data column

lowLabel - the label the chart will display via data tips.

RangeVariable

public RangeVariable(int columnIndex,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     int highColumnIndex,
                     java.lang.String highLabel,
                     int lowColumnIndex,
                     java.lang.String lowLabel)

Constructor designating data column, high column and low column by index along with the names of the SAS format and SAS informat and labels to be applied.

Parameters:

columnIndex - the column 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)

highColumnIndex - the index identifying the high data column

highLabel - the label the chart will display via data tips.

lowColumnIndex - the index identifying the low data column

lowLabel - the label the chart will display via data tips.

RangeVariable

public RangeVariable(java.lang.String columnName,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     java.lang.String targetColumnName,
                     java.lang.String targetLabel)

Constructor designating data column and target column by name along with the names of the SAS format and SAS informat and labels 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

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)

targetColumnName - the name identifying the target data column

targetLabel - the label the chart will display via data tips.

RangeVariable

public RangeVariable(int columnIndex,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     int targetColumnIndex,
                     java.lang.String targetLabel)

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

Parameters:

columnIndex - the column 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)

targetColumnIndex - the index identifying the target data column

targetLabel - the label the chart will display via data tips.

RangeVariable

public RangeVariable(java.lang.String columnName,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     com.sas.graphics.components.CategorizationModel categorizationModel,
                     com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle,
                     java.lang.String highColumnName,
                     java.lang.String highLabel,
                     java.lang.String lowColumnName,
                     java.lang.String lowLabel)

Constructor designating data column, high column and low column by name along with the names of the SAS format and SAS informat and labels 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

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)

categorizationModel - model to be used

segmentedRangeStyle - range style attributes to use

highColumnName - the name identifying the high data column

highLabel - the label the chart will display via data tips.

lowColumnName - the name identifying the low data column

lowLabel - the label the chart will display via data tips.

RangeVariable

public RangeVariable(int columnIndex,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     com.sas.graphics.components.CategorizationModel categorizationModel,
                     com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle,
                     int highColumnIndex,
                     java.lang.String highLabel,
                     int lowColumnIndex,
                     java.lang.String lowLabel)

Constructor designating data column, high column and low column by index along with the names of the SAS format and SAS informat and labels to be applied.

Parameters:

columnIndex - the column 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)

categorizationModel - model to be used

segmentedRangeStyle - range style attributes to use

highColumnIndex - the index identifying the high data column

highLabel - the label the chart will display via data tips.

lowColumnIndex - the index identifying the low data column

lowLabel - the label the chart will display via data tips.

RangeVariable

public RangeVariable(java.lang.String columnName,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     com.sas.graphics.components.CategorizationModel categorizationModel,
                     com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle,
                     java.lang.String targetColumnName,
                     java.lang.String targetLabel)

Constructor designating data column and target column by name along with the names of the SAS format and SAS informat and labels 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

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)

categorizationModel - model to be used

segmentedRangeStyle - range style attributes to use

targetColumnName - the name identifying the target data column

targetLabel - the label the chart will display via data tips.

RangeVariable

public RangeVariable(int columnIndex,
                     java.lang.String format,
                     java.lang.String informat,
                     java.lang.String label,
                     com.sas.graphics.components.CategorizationModel categorizationModel,
                     com.sas.graphics.components.SegmentedRangeStyle segmentedRangeStyle,
                     int targetColumnIndex,
                     java.lang.String targetLabel)

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

Parameters:

columnIndex - the column 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)

categorizationModel - model to be used

segmentedRangeStyle - range style attributes to use

targetColumnIndex - the index identifying the target data column

targetLabel - the label the chart will display via data tips.

RangeVariable

public RangeVariable(RangeVariable rv)

Constructor for RangeVariable

Parameters:

rv - the variable which supplies all properties for the new variable.

Method Detail

getTargetColumnName

public java.lang.String getTargetColumnName()

Returns the "target" data column name specified by the user. The default value is null.

Returns:

data column name

See Also:

getTargetColumnIndex()

getTargetColumnIndex

public int getTargetColumnIndex()

Returns the "target" data column index specified by the user. The default value is -1.

Returns:

data column index

See Also:

getHighColumnName()

getTargetLabel

public java.lang.String getTargetLabel()

Returns the user-specified "target" label.

Returns:

user-specified label

getHighColumnName

public java.lang.String getHighColumnName()

Returns the data column name specified by the user. The default value is null.

Returns:

data column name

See Also:

getHighColumnIndex()

getHighColumnIndex

public int getHighColumnIndex()

Returns the data column index specified by the user. The default value is -1.

Returns:

data column index

See Also:

getHighColumnName()

getHighLabel

public java.lang.String getHighLabel()

Returns the user-specified label.

Returns:

user-specified label

getLowColumnName

public java.lang.String getLowColumnName()

Returns the data column name specified by the user. The default value is null.

Returns:

data column name

See Also:

getLowColumnIndex()

getLowColumnIndex

public int getLowColumnIndex()

Returns the data column index specified by the user. The default value is -1.

Returns:

data column index

See Also:

getLowColumnName()

getLowLabel

public java.lang.String getLowLabel()

Returns the user-specified label.

Returns:

user-specified label