public interface

WebDerivedElement

implements Persistable WebObjectInfo
com.microstrategy.web.objects.WebDerivedElement

Class Overview

This interface represents a Derived Element object.

Summary

Constants
int USAGE_SORT
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void clearParentElement()
abstract int getAggregationMode()
Returns the aggregation mode value that controls how the parent’s value is calculated.
abstract boolean getApplyToAllOthers()
Indicates whether the leaves of the element should be considered when calculating the Residue (Other) element.
abstract WebAttribute getAttribute()
Returns the Derived Element's attribute
abstract WebOperatorNode getCalculationNode()
Returns the operator node for Calculation Derived Element
abstract String getDeltaXml(boolean isNewDE)
abstract String getDeltaXml()
abstract int getElementType()
Returns Derived Element type
abstract int getElementType(WebExpression expr)
Determins the Derived Element Type for a given expression.
abstract WebExpression getExpression()
Returns the Derived Element expression.
abstract WebTokenStream getExpressionTokenStream()
abstract WebFormat[] getFormats()
Returns collection of derived element formats.
abstract WebElementsObjectNode getListNode()
Returns the Elements node for List Derived Elements
abstract WebElement getParentElement()
abstract boolean getShowChildren()
Returns value of the Show Children flag.
abstract boolean getShowParent()
Returns value of the Show Parent flag.
abstract int getUsage()
abstract boolean isDormant()
abstract 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.
abstract boolean isVisible()
Returns the value of the Visible flag.
abstract void setAggregationMode(int value)
Sets aggregation mode
abstract void setApplyToAllOthers(boolean value)
Sets the ApplyToAllOthers flag value
abstract void setAttribute(WebAttribute value)
Sets the Derived Element's attribute
abstract void setExpressionTokenStream(WebTokenStream tokenStream)
abstract void setGenerateDeltaByTokenStream(boolean value)
abstract void setIsSmart(boolean value)
Sets the is smart flag value
abstract void setParentElement(String id, String name)
abstract void setShowChildren(boolean value)
Sets value of the Show Children flag.
abstract void setShowParent(boolean value)
Sets value of the Show Parent flag
abstract void setUsage(int value)
abstract void setVisible(boolean value)
Sets value of the Visible flag.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Constants

public static final int USAGE_SORT

Constant Value: 1 (0x00000001)

Public Methods

public abstract void clearParentElement ()

public abstract int getAggregationMode ()

Returns the aggregation mode value that controls how the parent’s value is calculated.

Returns
  • aggregation mode

public abstract 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.

public abstract WebAttribute getAttribute ()

Returns the Derived Element's attribute

Returns
  • the Derived Element's attribute

public abstract WebOperatorNode getCalculationNode ()

Returns the operator node for Calculation Derived Element

Returns
  • the operator node for Calculation Derived Element

public abstract String getDeltaXml (boolean isNewDE)

public abstract String getDeltaXml ()

public abstract int getElementType ()

Returns Derived Element type

Returns
  • Derived Element type

public abstract int getElementType (WebExpression expr)

Determins the Derived Element Type for a given expression.

Parameters
expr expression
Returns
  • Derived Element type.

public abstract WebExpression getExpression ()

Returns the Derived Element expression.

Returns
  • the Derived Element expression.

public abstract WebTokenStream getExpressionTokenStream ()

public abstract WebFormat[] getFormats ()

Returns collection of derived element formats.

Returns
  • collection of derived element formats.

public abstract WebElementsObjectNode getListNode ()

Returns the Elements node for List Derived Elements

Returns
  • the Elements node.

public abstract WebElement getParentElement ()

public abstract boolean getShowChildren ()

Returns value of the Show Children flag.

Returns
  • value of the Show Children flag.

public abstract boolean getShowParent ()

Returns value of the Show Parent flag.

Returns
  • value of the Show Parent flag.

public abstract int getUsage ()

public abstract boolean isDormant ()

public abstract 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

public abstract boolean isVisible ()

Returns the value of the Visible flag.

Returns
  • the value of the Visible flag.

public abstract void setAggregationMode (int value)

Sets aggregation mode

public abstract void setApplyToAllOthers (boolean value)

Sets the ApplyToAllOthers flag value

public abstract void setAttribute (WebAttribute value)

Sets the Derived Element's attribute

Parameters
value attribute object

public abstract void setExpressionTokenStream (WebTokenStream tokenStream)

public abstract void setGenerateDeltaByTokenStream (boolean value)

public abstract void setIsSmart (boolean value)

Sets the is smart flag value

public abstract void setParentElement (String id, String name)

public abstract void setShowChildren (boolean value)

Sets value of the Show Children flag.

Parameters
value value

public abstract void setShowParent (boolean value)

Sets value of the Show Parent flag

Parameters
value value

public abstract void setUsage (int value)

public abstract void setVisible (boolean value)

Sets value of the Visible flag.

Parameters
value value