Interface WebDerivedElement

    • Method Detail

      • getExpression

        WebExpression getExpression()
        Returns the Derived Element expression.
        Returns:
        the Derived Element expression.
      • getPassThroughExpression

        java.lang.String getPassThroughExpression()
        Returns the pass-through expression string of the DE
        Returns:
        the pass-through expression string of the DE
      • setPassThroughExpression

        void setPassThroughExpression​(java.lang.String passThroughExpression)
      • getAttribute

        WebAttribute getAttribute()
        Returns the Derived Element's attribute
        Returns:
        the Derived Element's attribute
      • setAttribute

        void setAttribute​(WebAttribute value)
        Sets the Derived Element's attribute
        Parameters:
        value - attribute object
      • getListNode

        WebElementsObjectNode getListNode()
        Returns the Elements node for List Derived Elements
        Returns:
        the Elements node.
      • getCalculationNode

        WebOperatorNode getCalculationNode()
        Returns the operator node for Calculation Derived Element
        Returns:
        the operator node for Calculation Derived Element
      • getElementType

        int getElementType()
        Returns Derived Element type
        Returns:
        Derived Element type
      • getElementType

        int getElementType​(WebExpression expr)
        Determins the Derived Element Type for a given expression.
        Parameters:
        expr - expression
        Returns:
        Derived Element type.
      • getShowChildren

        boolean getShowChildren()
        Returns value of the Show Children flag.
        Returns:
        value of the Show Children flag.
      • setShowChildren

        void setShowChildren​(boolean value)
        Sets value of the Show Children flag.
        Parameters:
        value - value
      • getShowParent

        boolean getShowParent()
        Returns value of the Show Parent flag.
        Returns:
        value of the Show Parent flag.
      • setShowParent

        void setShowParent​(boolean value)
        Sets value of the Show Parent flag
        Parameters:
        value - value
      • getFormats

        WebFormat[] getFormats()
        Returns collection of derived element formats.
        Returns:
        collection of derived element formats.
      • isVisible

        boolean isVisible()
        Returns the value of the Visible flag.
        Returns:
        the value of the Visible flag.
      • setVisible

        void setVisible​(boolean value)
        Sets value of the Visible flag.
        Parameters:
        value - value
      • isSmart

        boolean isSmart()
        Indicates whether the derived element's value comes from data source such as subsetting or query engine, or it should be calculated by Analytical Engine.
        Returns:
        true if element is smart
      • setIsSmart

        void setIsSmart​(boolean value)
        Sets the is smart flag value
        Parameters:
        value -
      • getAggregationMode

        int getAggregationMode()
        Returns the aggregation mode value that controls how the parent's value is calculated.
        Returns:
        aggregation mode
        See Also:
        EnumDSSXMLAggregation
      • setAggregationMode

        void setAggregationMode​(int value)
        Sets aggregation mode
        Parameters:
        value -
      • getApplyToAllOthers

        boolean getApplyToAllOthers()
        Indicates whether the leaves of the element should be considered when calculating the Residue (Other) element.
        Returns:
        true if the leaves of the element should be considered when calculating the Residue (Other) element.
      • setApplyToAllOthers

        void setApplyToAllOthers​(boolean value)
        Sets the ApplyToAllOthers flag value
        Parameters:
        value -
      • getDeltaXml

        java.lang.String getDeltaXml()
      • getDeltaXml

        java.lang.String getDeltaXml​(boolean isNewDE)
      • isDormant

        boolean isDormant()
      • setUsage

        void setUsage​(int value)
      • getUsage

        int getUsage()
      • setExpressionTokenStream

        void setExpressionTokenStream​(WebTokenStream tokenStream)
      • setGenerateDeltaByTokenStream

        void setGenerateDeltaByTokenStream​(boolean value)
      • setParentElement

        void setParentElement​(java.lang.String id,
                              java.lang.String name)
      • clearParentElement

        void clearParentElement()