Package com.inductiveautomation.rm.base

Class RMGrouping

  • All Implemented Interfaces:
    Archivable, RMPropertyChanger, java.lang.Cloneable
    public class RMGrouping
extends RMObject
implements Archivable
    This object represents an individual grouping with attributes like key, sorts, topN sort, etc.

    • Constructor Detail

      • RMGrouping

        public RMGrouping()
        Creates an empty grouping.

      • RMGrouping

        public RMGrouping​(java.lang.String aKey)
        Creates a grouping with the given key.

    • Method Detail

      • getKey

        public java.lang.String getKey()
        Returns the grouping key.

      • setKey

        public void setKey​(java.lang.String aValue)
        Sets the grouping key.

      • getSorts

        public java.util.List<RMSort> getSorts()
        Returns the groupings list of sorts.

      • getSortCount

        public int getSortCount()
        Returns the number of sorts in the grouping.

      • getSort

        public RMSort getSort​(int anIndex)
        Returns the individual sort at the given index.

      • addSort

        public RMGrouping addSort​(RMSort aSort)
        Adds the given sort to the grouping.

      • addSort

        public void addSort​(RMSort aSort,
                    int anIndex)
        Adds the given sort to the grouping.

      • removeSort

        public RMSort removeSort​(int anIndex)
        Removes the sort at the given index.

      • removeAllSorts

        public void removeAllSorts()

      • addSorts

        public void addSorts​(java.util.List<RMSort> aList)
        Adds the list of sorts to the grouping.

      • addSort

        public void addSort​(java.lang.String aSortKey)
        Adds a sort to the grouping for the given sort key.

      • removeSort

        public int removeSort​(RMSort aSort)
        Removes the given sort from the grouping.

      • moveSort

        public void moveSort​(int fromIndex,
                     int toIndex)
        Moves a sort from the source index to the destination index.

      • getTopNSort

        public RMTopNSort getTopNSort()
        Returns the top N sort for the grouping.

      • setTopNSort

        public void setTopNSort​(RMTopNSort aSort)
        Sets the top N sort for the grouping.

      • getIncludeAllValues

        public boolean getIncludeAllValues()
        Returns whether the grouping includes all values.

      • setIncludeAllValues

        public void setIncludeAllValues​(boolean aValue)
        Sets whether the grouping includes all values.

      • getValuesString

        public java.lang.String getValuesString()
        Returns the values (in the form of comma separated keychain keys) explicitly defined to sort or to include.

      • setValuesString

        public void setValuesString​(java.lang.String aString)
        Sets the values (in the form of comma separated keychain keys) explicitly defined to sort or to include.

      • getValues

        public java.util.List getValues()
        Returns a list of explicit values for this grouping.

      • getSortOnValues

        public boolean getSortOnValues()
        Returns whether to sort on values explicitly provided.

      • setSortOnValues

        public void setSortOnValues​(boolean aFlag)
        Sets whether to sort on values explicitly provided.

      • getIncludeValues

        public boolean getIncludeValues()
        Returns whether to include values explicitly provided.

      • setIncludeValues

        public void setIncludeValues​(boolean aFlag)
        Sets whether to include values explicitly provided.

      • getHasHeader

        public boolean getHasHeader()
        Returns whether the grouping has a header.

      • setHasHeader

        public void setHasHeader​(boolean aValue)
        Sets whether the grouping has a header.

      • getHasDetails

        public boolean getHasDetails()
        Returns whether the grouping has a details.

      • setHasDetails

        public void setHasDetails​(boolean aValue)
        Sets whether the grouping has a details.

      • getHasSummary

        public boolean getHasSummary()
        Returns whether the grouping has a summary.

      • setHasSummary

        public void setHasSummary​(boolean aValue)
        Sets whether the grouping has a summary.

      • getSelectedSortIndex

        public int getSelectedSortIndex()
        Returns the currently selected grouping's currently selected sort (for editing, mostly).

      • setSelectedSortIndex

        public void setSelectedSortIndex​(int anIndex)
        Sets the currently selected grouping's currently selected sort (for editing, mostly).

      • getSelectedSort

        public RMSort getSelectedSort()
        Returns the currently selected grouping's sort (while editing only).

      • equals

        public boolean equals​(java.lang.Object anObj)
        Standard equals implementation.
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Returns string representation of grouping.
        Overrides:
        toString in class RMObject