public interface

RWGridGraphDef

implements RWTransactable RWUnitDef
com.microstrategy.web.objects.rw.RWGridGraphDef

Class Overview

Represents a view definition object (Grid or Graph).

Summary

Public Methods
abstract void addAssociatedNodes(Set<String> nodeKeys, int manipulationCategory)
abstract RWControl addControl(String controlKey, int templateAxis, int templatePosition)
Adds control to template unit
abstract RWControl addControl(String controlKey, String tuObjectId, int tuObjectType)
Adds control to template unit
abstract WebTemplateMetric addUserMetric(RWUserMetric userMetric)
Adds the user derived metric to the view defintion.
abstract WebTemplateMetric addUserMetric(RWUserMetric userMetric, int beforeKey)
Adds the user derived metric to the view defintion.
abstract Set<String> getAssociatedNodes(int manipulationCategory)
Returns associated nodes for the specified manipulationCategory.
abstract RWControl getControl(String tuObjectId, int tuObjectType)
Returns control for specified template unit
abstract String getControlKeysWithTopMost()
get the keys of controls that are set to auto pick top most.
abstract List getControls()
abstract RWDataSet getDataSet()
Returns the data set this object is based on
abstract RWDataSet getDefaultDataSet()
Returns the default dataset of RW definition, see getDefault().
abstract int getDisplayMode()
Returns the view mode from EnumDSSXMLDisplayMode.
abstract RWDataSet getEffectiveDataSet()
Returns either Joined data set or data set this object is based on
abstract RWGridIfSettings getIfSettings()
abstract WebFilter getViewFilter()
Returns the view filter that is applied to the grid object within the RW document.
abstract WebViewInstance getViewInstance()
Returns a view instance representing grid/graph definition
abstract WebExpression getViewLimits()
abstract WebVisualizationSettings getVisualizationSettings()
Returns Visualization settings
abstract boolean hasControls()
abstract void iterateDIC(RWDICVisitor visitor)
abstract void removeAssociatedNodes(Set<String> nodeKeys, int manipulationCategory)
abstract void removeControl(String tuObjectId, int tuObjectType)
Removes control from specified template unit
abstract void removeControl(String ctlKey)
Removes control by its key
abstract void removePlaceHolderTargets(Set<Integer> phRemoves)
Remove placeholders that has been targeted to a selector
abstract void setDataSet(String id)
Connects this object to a data set
abstract void setDataSet(RWDataSet value)
Connects this object to a data set
abstract void setDisplayMode(int displayMode)
Sets the report view mode (EnumDSSXMLDisplayMode) By default, the view mode was set to the gride mode.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebThresholdsContainer
From interface com.microstrategy.web.objects.rw.RWTransactable
From interface com.microstrategy.web.objects.rw.RWUnitDef

Public Methods

public abstract void addAssociatedNodes (Set<String> nodeKeys, int manipulationCategory)

public abstract RWControl addControl (String controlKey, int templateAxis, int templatePosition)

Adds control to template unit

Parameters
controlKey control key
templateAxis template axis
templatePosition template unit position on the axis
Returns
  • RWControl control
Throws
WebObjectsException
WebObjectsException

public abstract RWControl addControl (String controlKey, String tuObjectId, int tuObjectType)

Adds control to template unit

Parameters
controlKey control key
tuObjectId template unit object ID
tuObjectType template unit object type
Returns
  • RWControl control
Throws
WebObjectsException
WebObjectsException

public abstract WebTemplateMetric addUserMetric (RWUserMetric userMetric)

Adds the user derived metric to the view defintion. Note that this would change the TemplateMetrics collection for the view instance corresponding to this definition object. The metric would be added at the end of the template metrics collection.

Parameters
userMetric the user metric to add. The user metric should be present on the dataset object associate with the definition.
Returns
  • the template metric corresponding to the user metric added.
Throws
IllegalArgumentException if the user metric is not in the dataset.
WebObjectsException

public abstract WebTemplateMetric addUserMetric (RWUserMetric userMetric, int beforeKey)

Adds the user derived metric to the view defintion. Note that this would change the TemplateMetrics collection for the view instance corresponding to this definition object.

Parameters
userMetric the user metric to add. The user metric should be present on the dataset object associate with the definition.
Returns
  • the template metric corresponding to the user metric added.
Throws
IllegalArgumentException if the user metric is not in the dataset.
WebObjectsException

public abstract Set<String> getAssociatedNodes (int manipulationCategory)

Returns associated nodes for the specified manipulationCategory. The returned set is never null.

Parameters
manipulationCategory in EnumDSSXMLRWManipulationCategory
Returns
  • a set containing associated nodes. If no associated node is found returns a empty set

public abstract RWControl getControl (String tuObjectId, int tuObjectType)

Returns control for specified template unit

Parameters
tuObjectId template unit object ID
tuObjectType template unit object type
Returns
  • control or null

public abstract String getControlKeysWithTopMost ()

get the keys of controls that are set to auto pick top most.

Returns
  • keys join by ''

public abstract List getControls ()

public abstract RWDataSet getDataSet ()

Returns the data set this object is based on

Returns
  • the data set this grid/graph is based on

public abstract RWDataSet getDefaultDataSet ()

Returns the default dataset of RW definition, see getDefault().

public abstract int getDisplayMode ()

Returns the view mode from EnumDSSXMLDisplayMode. By default, the view mode is set to the grid mode.

Returns
  • the report view mode.

public abstract RWDataSet getEffectiveDataSet ()

Returns either Joined data set or data set this object is based on

Returns
  • either Joined data set or data set this object is based on

public abstract RWGridIfSettings getIfSettings ()

public abstract WebFilter getViewFilter ()

Returns the view filter that is applied to the grid object within the RW document. This filter can be edited to change the filter that is on the grid. In order to apply any filter changes, the applyChanges method on the RWManipulation interface must be called.

Returns
  • A WebFilter object, that represents the view filter of the grid/graph def.

public abstract WebViewInstance getViewInstance ()

Returns a view instance representing grid/graph definition

Returns
  • a view instance representing grid/graph definition

public abstract WebExpression getViewLimits ()

Throws
WebObjectsException

public abstract WebVisualizationSettings getVisualizationSettings ()

Returns Visualization settings

Returns
  • Visualization settings
Throws
WebObjectsException
WebObjectsException

public abstract boolean hasControls ()

public abstract void iterateDIC (RWDICVisitor visitor)

public abstract void removeAssociatedNodes (Set<String> nodeKeys, int manipulationCategory)

public abstract void removeControl (String tuObjectId, int tuObjectType)

Removes control from specified template unit

Parameters
tuObjectId template unit object ID
tuObjectType template unit object type
Throws
WebObjectsException
WebObjectsException

public abstract void removeControl (String ctlKey)

Removes control by its key

Parameters
ctlKey control key
Throws
WebObjectsException
WebObjectsException

public abstract void removePlaceHolderTargets (Set<Integer> phRemoves)

Remove placeholders that has been targeted to a selector

public abstract void setDataSet (String id)

Connects this object to a data set

Parameters
id data set ID

public abstract void setDataSet (RWDataSet value)

Connects this object to a data set

Parameters
value data set

public abstract void setDisplayMode (int displayMode)

Sets the report view mode (EnumDSSXMLDisplayMode) By default, the view mode was set to the gride mode.

Parameters
displayMode a new report view mode.