public interface

WebGridTitles

implements WebCssFormatContainer
com.microstrategy.web.objects.WebGridTitles

Class Overview

This interface provides collection type methods to traverse and obtain WebTitle objects in the report.

Summary

Public Methods
abstract Enumeration elements()
abstract WebTitle get(int index)
Returns the WebTitle at the given index (starting from 0).
abstract List<? extends WebTitleUnit> getResolvedTitleUnits(boolean forceShowAttributeForm)
abstract List<? extends WebTitleUnit> getResolvedTitleUnits()
This is the recommended means to obtain WebTitleUnit collections in each axis for display purposes.
abstract boolean hasMetrics()
Returns a boolean indicating whether the metrics are present in the current collection of WebTitle objects.
abstract boolean isEmpty()
abstract int size()
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebCssFormatContainer

Public Methods

public abstract Enumeration elements ()

Returns

public abstract WebTitle get (int index)

Returns the WebTitle at the given index (starting from 0).

Parameters
index index of the element to return.
Returns
  • the element at the specified position.
Throws
IndexOutOfBoundsException if index is out of range (index < 0 || index >= size()).
See Also

public abstract List<? extends WebTitleUnit> getResolvedTitleUnits (boolean forceShowAttributeForm)

public abstract List<? extends WebTitleUnit> getResolvedTitleUnits ()

This is the recommended means to obtain WebTitleUnit collections in each axis for display purposes. Each WebTitleUnit may be a WebTitle or WebSubTitle. The list returned is based on the following rules:

  • If attribute forms are shown:
    1. If a WebTitle has more than one WebSubTitle, each of the WebSubTitle are used
    2. .
    3. Otherwise if a WebTitle has exactly one WebSubTitle, the WebTitle is used.
  • Otherwise if no attribute forms are shown then only WebTitle are shown.
Whether attribute forms are shown depend on the WebPreferenceGridShowSubtitle preference.

public abstract boolean hasMetrics ()

Returns a boolean indicating whether the metrics are present in the current collection of WebTitle objects. Using this, we can determine whether a particular axis contains the metrics

public abstract boolean isEmpty ()

Returns
  • whether size()==0.

public abstract int size ()

Returns
  • the number of elements in this collection.