All Superinterfaces:

EnumWebPersistableState, KeyedObject, Persistable, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite
```
public interface WebDerivedElement
extends WebObjectInfo, Persistable
```
This interface represents a Derived Element object.

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields
Modifier and Type Field Description

static int USAGE_SORT
- Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
  BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clearParentElement()`
`int`	`getAggregationMode()`	Returns the aggregation mode value that controls how the parent's value is calculated.
`boolean`	`getApplyToAllOthers()`	Indicates whether the leaves of the element should be considered when calculating the Residue (Other) element.
`WebAttribute`	`getAttribute()`	Returns the Derived Element's attribute
`WebOperatorNode`	`getCalculationNode()`	Returns the operator node for Calculation Derived Element
`java.lang.String`	`getDeltaXml()`
`java.lang.String`	`getDeltaXml(boolean isNewDE)`
`int`	`getElementType()`	Returns Derived Element type
`int`	`getElementType(WebExpression expr)`	Determins the Derived Element Type for a given expression.
`WebExpression`	`getExpression()`	Returns the Derived Element expression.
`WebTokenStream`	`getExpressionTokenStream()`
`WebFormat[]`	`getFormats()`	Returns collection of derived element formats.
`WebElementsObjectNode`	`getListNode()`	Returns the Elements node for List Derived Elements
`WebElement`	`getParentElement()`
`java.lang.String`	`getPassThroughExpression()`	Returns the pass-through expression string of the DE
`boolean`	`getShowChildren()`	Returns value of the Show Children flag.
`boolean`	`getShowParent()`	Returns value of the Show Parent flag.
`int`	`getUsage()`
`boolean`	`isDormant()`
`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.
`boolean`	`isVisible()`	Returns the value of the Visible flag.
`void`	`setAggregationMode(int value)`	Sets aggregation mode
`void`	`setApplyToAllOthers(boolean value)`	Sets the ApplyToAllOthers flag value
`void`	`setAttribute(WebAttribute value)`	Sets the Derived Element's attribute
`void`	`setExpressionTokenStream(WebTokenStream tokenStream)`
`void`	`setGenerateDeltaByTokenStream(boolean value)`
`void`	`setIsSmart(boolean value)`	Sets the is smart flag value
`void`	`setParentElement(java.lang.String id, java.lang.String name)`
`void`	`setPassThroughExpression(java.lang.String passThroughExpression)`
`void`	`setShowChildren(boolean value)`	Sets value of the Show Children flag.
`void`	`setShowParent(boolean value)`	Sets value of the Show Parent flag
`void`	`setUsage(int value)`
`void`	`setVisible(boolean value)`	Sets value of the Visible flag.

Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey

Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances

- Field Detail
  - USAGE_SORT
```
static final int USAGE_SORT
```
    See Also:
    
    Constant Field Values
- 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()
```
  - getExpressionTokenStream
```
WebTokenStream getExpressionTokenStream()
```
  - setExpressionTokenStream
```
void setExpressionTokenStream(WebTokenStream tokenStream)
```
  - setGenerateDeltaByTokenStream
```
void setGenerateDeltaByTokenStream(boolean value)
```
  - setParentElement
```
void setParentElement(java.lang.String id,
                      java.lang.String name)
```
  - getParentElement
```
WebElement getParentElement()
```
  - clearParentElement
```
void clearParentElement()
```

Interface WebDerivedElement

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

Method Summary

Methods inherited from interface com.microstrategy.utils.KeyedObject

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

Field Detail

USAGE_SORT

Method Detail

getExpression

getPassThroughExpression

setPassThroughExpression

getAttribute

setAttribute

getListNode

getCalculationNode

getElementType

getElementType

getShowChildren

setShowChildren

getShowParent

setShowParent

getFormats

isVisible

setVisible

isSmart

setIsSmart

getAggregationMode

setAggregationMode

getApplyToAllOthers

setApplyToAllOthers

getDeltaXml

getDeltaXml

isDormant

setUsage

getUsage

getExpressionTokenStream

setExpressionTokenStream

setGenerateDeltaByTokenStream

setParentElement

getParentElement

clearParentElement