Package com.microstrategy.web.objects.rw

Interface RWGroupBys

  • public interface RWGroupBys
    A collection of GroupBy objects
    Since:
    MicroStrategy Web 8.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      RWGroupBy add​(WebObjectInfo obj, java.lang.String key, java.lang.String beforeKey)
      Adds new group by before specified key.
      RWGroupBy add​(WebObjectInfo obj, java.lang.String key, java.lang.String beforeKey, java.lang.String headerKey, java.lang.String headerSubsectionKey, java.lang.String footerKey, java.lang.String footerSubsectionKey)  
      RWGroupBy add​(java.lang.String objectId, int objectType, java.lang.String key, java.lang.String beforeKey)
      Adds new group by before specified key.
      boolean contains​(WebObjectInfo ob)
      Returns true if specified object already present in the group by collection
      RWGroupBy get​(int i)
      Gets i-th group by
      RWGroupBy getByKey​(java.lang.String key)
      Returns group by with specified key
      RWGroupBy getByLevel​(int level)
      Returns a group by with specified level
      RWDefinition getRwDefinition()
      Returns parent RW Document definition
      boolean hasInvalidUnits()
      Returns true if there's group by not having associate section in definition.
      int indexOf​(RWGroupBy groupBy)
      Returns an index of the group by in the group by collection
      boolean isFirstPage()
      Returns true if current data represent first group by page
      boolean isLastPage()
      Returns true if current data represent last group by page
      void moveByKey​(java.lang.String key, java.lang.String beforeKey)
      Moves a group by in the group by collection.
      RWGroupBy removeByKey​(java.lang.String key)
      Removes group by with specified key.
      int size()
      Returns grup by collection size

    • Method Detail

      • getRwDefinition

        RWDefinition getRwDefinition()
        Returns parent RW Document definition
        Returns:
        parent RW Document definition

      • size

        int size()
        Returns grup by collection size
        Returns:
        grup by collection size

      • get

        RWGroupBy get​(int i)
        Gets i-th group by
        Parameters:
        i - indext
        Returns:
        i-th group by

      • getByKey

        RWGroupBy getByKey​(java.lang.String key)
        Returns group by with specified key
        Parameters:
        key - grpup by object key
        Returns:
        group by with specified key

      • getByLevel

        RWGroupBy getByLevel​(int level)
        Returns a group by with specified level
        Parameters:
        level - groupby level
        Returns:
        a group by with specified level

      • indexOf

        int indexOf​(RWGroupBy groupBy)
        Returns an index of the group by in the group by collection
        Parameters:
        groupBy - group by object
        Returns:
        an index of group by object or -1 if this object does not belong to the collection.

      • add

        RWGroupBy add​(java.lang.String objectId,
              int objectType,
              java.lang.String key,
              java.lang.String beforeKey)
       throws java.lang.IllegalArgumentException
        Adds new group by before specified key. The group by will be initialized with passed object. This method also creates corresponding group by section.
        Parameters:
        objectId - an id of target object for new group by
        objectType - the type of target object for new group by
        key - group by key
        beforeKey - the key of group by object before which a new on shall be added
        Returns:
        new group by object.
        Throws:
        java.lang.IllegalArgumentException - if specified object does not belong to the default data set or if specified group by object already present in the collection

      • add

        RWGroupBy add​(WebObjectInfo obj,
              java.lang.String key,
              java.lang.String beforeKey)
       throws java.lang.IllegalArgumentException
        Adds new group by before specified key. The group by will be initialized with passed object. This method also creates corresponding group by section.
        Parameters:
        obj - group by object
        key - group by key
        beforeKey - the key of group by object before which a new on shall be added
        Returns:
        new group by object.
        Throws:
        java.lang.IllegalArgumentException - if specified object does not belong to the default data set or if specified group by object already present in the collection

      • contains

        boolean contains​(WebObjectInfo ob)
        Returns true if specified object already present in the group by collection
        Parameters:
        ob - object
        Returns:
        true if specified object already present in the group by collection

      • removeByKey

        RWGroupBy removeByKey​(java.lang.String key)
        Removes group by with specified key. This method also modify layout hierarchy accordingly. Namely the child of the group by section is reattached to its parent, then the group by section is removed
        Parameters:
        key - the group by key
        Returns:
        removed group by object

      • moveByKey

        void moveByKey​(java.lang.String key,
               java.lang.String beforeKey)
        Moves a group by in the group by collection. Layout hierarchy is adjusted accordingly.
        Parameters:
        key - group by key
        beforeKey - the key of group by before which it shall be moved.

      • isFirstPage

        boolean isFirstPage()
        Returns true if current data represent first group by page
        Returns:
        true if current data represent first group by page

      • isLastPage

        boolean isLastPage()
        Returns true if current data represent last group by page
        Returns:
        true if current data represent last group by page

      • add

        RWGroupBy add​(WebObjectInfo obj,
              java.lang.String key,
              java.lang.String beforeKey,
              java.lang.String headerKey,
              java.lang.String headerSubsectionKey,
              java.lang.String footerKey,
              java.lang.String footerSubsectionKey)
        Since:
        MicroStrategy Web 9.0.0

      • hasInvalidUnits

        boolean hasInvalidUnits()
        Returns true if there's group by not having associate section in definition.
        Returns:
        true if there's group by not having associate section in definition.