Package com.microstrategy.web.objects

Interface WebParsedMetric

  • All Superinterfaces:
    WebParsedObject
    public interface WebParsedMetric
extends WebParsedObject
    This interface represents a metric resulted from parsing by backend. The main part is a token stream, and it may also contain a symbol folder used for resolving naming ambiguity.
    Since:
    MicroStrategy Web 9.2.2

    • Method Detail

      • getPropertySets

        WebPropertyGroup getPropertySets()
        Gets the property sets associated with this metric.
        Returns:
        A WebPropertyGroup object, which contains the property sets associated with this metric.

      • getDataType

        WebDataType getDataType()
        Gets the data type for this metric.
        Returns:
        data type

      • getHeaderFormat

        WebFormat getHeaderFormat()
        Returns the WebFormat object for the header of the metric object.

      • getGridFormat

        WebFormat getGridFormat()
        Returns the WebFormat object for the values/data of the metric object.

      • getAllChildrenJoin

        int getAllChildrenJoin()
        Returns an integer value from EnumDSSXMLOuterJoinTypes indicating the outer join type of this metric.
        Returns:
        an integer value indicating the outer join type

      • setAllChildrenJoin

        void setAllChildrenJoin​(int allChildrenJoinType)
        Set the value of all children join type. Value from EnumDSSXMLOuterJoinTypesl
        Parameters:
        allChildrenJoinType -

      • getMetricType

        int getMetricType()
        Returns an integer value from EnumDSSXMLMetricType indicating the metric type.
        Returns:
        an integer value indicating the metric type

      • setMetricType

        void setMetricType​(int metricType)
        Set the metric type, value from EnumDSSXMLMetricType.
        Parameters:
        metricType -

      • getDecomposable

        int getDecomposable()
        Returns an integer value from EnumDSSXMLDecomposable indicating whether this metric is decomposable.
        Returns:
        an integer value indicating whether this metric is decomposable

      • setDecomposable

        void setDecomposable​(int decomposable)
        Set the value of the decomposable type, value from EnumDSSXMLDecomposable.
        Parameters:
        decomposable -

      • getAggregateFromBase

        int getAggregateFromBase()
        Returns an integer indicating what Aggregated From Base is for a derived metric.
        Returns:
        int

      • setAggregateFromBase

        void setAggregateFromBase​(int aggregateFromBase)
        Set Aggregated From Base for a derived metric.

      • getSubtotalFromBase

        int getSubtotalFromBase()
        Returns an integer indicating what Subtotal From Base is for a derived metric.
        Returns:
        int

      • setSubtotalFromBase

        void setSubtotalFromBase​(int subtotalFromBase)
        Set Subtotal From Base (i.e. AggreateFromBaseStyle) for a derived metric.

      • getFromBaseFlag

        int getFromBaseFlag()
        Returns an integer indicating what DerivedMetricDynamicAggAndSubtotal value is set on a derived metric.
        Returns:
        a boolean value indicating what the AFB Subtotal Style is.

      • setFromBaseFlag

        void setFromBaseFlag​(int fromBaseFlag)
        Set DerivedMetricDynamicAggAndSubtotal value for a derived metric.

      • canBeSmart

        boolean canBeSmart()
        Returns a boolean value indicating whether this metric can be set to smart.
        Returns:
        a boolean value indicating whether this metric can be set to smart.

      • setMetricEditType

        void setMetricEditType​(java.lang.String met)
        Set the metric edit type EnumDSSXMLMetricEditType
        Parameters:
        met - metric edit type

      • getMetricEditType

        java.lang.String getMetricEditType()
        Return the metric edit type EnumDSSXMLMetricEditType generated by backend parser for the token stream.
        Returns:
        metric edit type

      • setMessageID

        void setMessageID​(java.lang.String mid)
        Set Report or RW message ID which will be passed to xmlCommand "pm" to support Derived Metric object.
        Parameters:
        mid -

      • getMessageID

        java.lang.String getMessageID()
        Return the Report or RW message ID associated with this WebParsedMetric object.
        Parameters:
        mid -

      • setFormId

        void setFormId​(java.lang.String formId)
        Set the form id of the parsed object
        Parameters:
        formId -

      • setIsIDForm

        void setIsIDForm​(boolean isIDForm)
        Set whether the form is an ID form.
        Parameters:
        isIDForm -