com.sas.graphics.components.radarchart
Class RadarChartOLAPDataModel

com.sas.graphics.components.radarchart.RadarChartOLAPDataModel

public class RadarChartOLAPDataModel

A RadarChartOLAPDataModel assigns an OLAPDataSetInterface to a RadarChart. The com.sas.storage.olap.OLAPDataSetInterface encapsulates the OLAP data structure, and the RadarChartOLAPDataModel conveys that structure to a graph by automatically mapping the OLAP axis dimensions to appropriate graph elements. The following limitations apply to the mapping:

• OLAP expands are not displayed
• A maximum of two OLAP axes can be displayed.

If the OLAP axis that supplies the category variable has more than one dimension, the RadarChartOLAPDataModel's subgroupEnabled property can be used to display graph subgroups.

Topics:

Basic Requirements
Default Logic Used to Map OLAP Data
Selecting Measures in OLAP Data

RadarChart Samples:

Swing-based Samples
Servlet-based Samples

Since:

SAS 9.1

See Also:

RadarChart

Constructor Summary

RadarChartOLAPDataModel()
Constructs a RadarChartOLAPDataModel that is used to assign OLAP data in the form of a com.sas.storage.olap.OLAPDataSetInterface to a RadarChart.

RadarChartOLAPDataModel(OLAPDataSetInterface newModel)
Constructs a RadarChartOLAPDataModel that is used to assign OLAP data in the form of a com.sas.storage.olap.OLAPDataSetInterface to a RadarChart.

RadarChartOLAPDataModel(OLAPDataSetInterface newModel, boolean newSubgroupEnabled)
Constructs a RadarChartOLAPDataModel that is used to assign OLAP data in the form of a com.sas.storage.olap.OLAPDataSetInterface to a RarChart with a flag to indicate whether or not subgrouped data elements are desired.

Method Summary

void	apply(RadarChartOLAPDataModel theOtherModel) Utility method to convey properties contained in "theOtherModel" to this object.
boolean	equals(java.lang.Object obj) Determines whether another object is equal to this RadarChartOLAPDataModel.
Variable[]	getAuxiliaryVariable() Returns the array of data columns that was most recently set by the setAuxiliaryVariable() method.
Variable[]	getDataTipVariable() Returns the array of data columns that was most recently set by the setDataTipVariable() method.
OLAPDataSetInterface	getModel() Set the OLAP data source.
javax.swing.ListSelectionModel	getSelectionModel() Returns the ListSelectionModel that indicates which data values are selected.
int	hashCode() Computes the hash code for this RadarChartOLAPDataModel.
boolean	isSubgroupEnabled() Returns whether or not the RadarChart should attempt to subgroup its data elements.
void	setAuxiliaryVariable(Variable[] newVariables) Specifies an array of Variables that are included among the variables that are passed in the events on the RadarChart data elements.
void	setDataTipVariable(Variable[] newVariables) Specifies an array of Variables to be displayed in the data tip.
void	setModel(OLAPDataSetInterface newModel) Set the OLAP data source.
void	setSelectionModel(javax.swing.ListSelectionModel newModel) Sets the selection model that identifies which cells are selected.
void	setSubgroupEnabled(boolean newSubgroupEnabled) Sets whether or not the RadarChart should attempt to subgroup its data elements.

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

apply, getLocale, getRulesContext, getSortStrategy, setLocale, setRulesContext, setSortStrategy

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

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

Constructor Detail

RadarChartOLAPDataModel

public RadarChartOLAPDataModel()

Constructs a RadarChartOLAPDataModel that is used to assign OLAP data in the form of a com.sas.storage.olap.OLAPDataSetInterface to a RadarChart.

RadarChartOLAPDataModel

public RadarChartOLAPDataModel(OLAPDataSetInterface newModel)

Constructs a RadarChartOLAPDataModel that is used to assign OLAP data in the form of a com.sas.storage.olap.OLAPDataSetInterface to a RadarChart.

Parameters:

newModel - the OLAP data

RadarChartOLAPDataModel

public RadarChartOLAPDataModel(OLAPDataSetInterface newModel,
                               boolean newSubgroupEnabled)

Constructs a RadarChartOLAPDataModel that is used to assign OLAP data in the form of a com.sas.storage.olap.OLAPDataSetInterface to a RarChart with a flag to indicate whether or not subgrouped data elements are desired.

Method Detail

apply

public void apply(RadarChartOLAPDataModel theOtherModel)

Utility method to convey properties contained in "theOtherModel" to this object.

Note: Contained "models" (i.e. properties that are subclasses of ModelBase) will in turn be called on to convey their properties to the like contained models in the other object. In that respect this can be considered a "tree" type copy.

Also Note: This is a deep copy. Thus after the copy, mutable properties will not be shared by the two instances.

Parameters:

theOtherModel - properties applied to this instance

setSubgroupEnabled

public void setSubgroupEnabled(boolean newSubgroupEnabled)

Sets whether or not the RadarChart should attempt to subgroup its data elements.

See Also:

isSubgroupEnabled()

isSubgroupEnabled

public boolean isSubgroupEnabled()

Returns whether or not the RadarChart should attempt to subgroup its data elements.

See Also:

setSubgroupEnabled(boolean)

setModel

public void setModel(OLAPDataSetInterface newModel)

Set the OLAP data source.

Parameters:

newModel - a handle to the data source or null

See Also:

getModel()

getModel

public OLAPDataSetInterface getModel()

Set the OLAP data source.

Returns:

the handle to the data source or null

See Also:

setModel(com.sas.storage.olap.OLAPDataSetInterface)

setSelectionModel

public void setSelectionModel(javax.swing.ListSelectionModel newModel)

Sets the selection model that identifies which cells are selected. The graph will highlight the selected elements as well as enable selection on the graph elements via mouse clicks and brushing. To create a brush, click and drag in the element area. To move the brush (represented as a rectangle) click inside the brush area and drag.

Parameters:

newModel - the selection model identifying selected cells

Throws:

java.lang.IllegalArgumentException - if newModel is null.

See Also:

getSelectionModel()

getSelectionModel

public javax.swing.ListSelectionModel getSelectionModel()

Returns the ListSelectionModel that indicates which data values are selected.

Returns:

the ListSelectionModel containing the indicies of the selected data values.

See Also:

setSelectionModel(javax.swing.ListSelectionModel)

equals

public boolean equals(java.lang.Object obj)

Determines whether another object is equal to this RadarChartOLAPDataModel.

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

Overrides:

equals in class DataModel

Parameters:

obj - the object to test for equality with this RadarChartOLAPDataModel

Returns:

true if the objects are the same; false otherwise.

hashCode

public int hashCode()

Computes the hash code for this RadarChartOLAPDataModel.

Overrides:

hashCode in class DataModel

Returns:

a hash code value for this object.

setAuxiliaryVariable

public void setAuxiliaryVariable(Variable[] newVariables)

Specifies an array of Variables that are included among the variables that are passed in the events on the RadarChart data elements. Auxiliary variables are not represented in the chart. By default, they are not displayed in the datatip, although they can be included in the array of variables set by setDataTipVariable().

Parameters:

newVariables - contains Variables for GraphActionEvent return.

Throws:

java.lang.IllegalArgumentException - if a non-null array of zero length is passed in.

See Also:

getAuxiliaryVariable(), setDataTipVariable(com.sas.graphics.components.Variable[])

getAuxiliaryVariable

public Variable[] getAuxiliaryVariable()

Returns the array of data columns that was most recently set by the setAuxiliaryVariable() method. Returns null if the auxiliary variables were not set.

Returns:

variables for Auxiliary values

See Also:

setAuxiliaryVariable(com.sas.graphics.components.Variable[]), setDataTipVariable(com.sas.graphics.components.Variable[])

setDataTipVariable

public void setDataTipVariable(Variable[] newVariables)

Specifies an array of Variables to be displayed in the data tip. By default, the variables specified on setDataTipVariable() are appended to the end of the default data tip display. To replace the default display with the list of variables in the Variable[] array, use the GraphModel to get the DataTipModel , and the call the DataTipModel's setContent() method with the value GraphConstants.DATA_TIP_REPLACE.

The following code fragment specifies two variables for the data tip display and uses them to replace the default data tip display:

 // Create an array of variables to set in the data tip display
 Variable dataTipVars[]=new Variable[2];
 dataTipVars[0]=new Variable("Task");
 dataTipVars[1]=new Variable("Duration");
 radarChart.getGraphModel().getDataTipModel().setContent(
                GraphConstants.DATA_TIP_REPLACE);
 

Parameters:

newVariables - array of Variables to display in data tip

Throws:

java.lang.IllegalArgumentException - if a non-null array of zero length is passed in.

See Also:

getDataTipVariable(), setAuxiliaryVariable(com.sas.graphics.components.Variable[])

getDataTipVariable

public Variable[] getDataTipVariable()

Returns the array of data columns that was most recently set by the setDataTipVariable() method. Returns null if the data tip variables were not set.

Returns:

variables for data tip values

See Also:

setDataTipVariable(com.sas.graphics.components.Variable[])