mondrian.olap.fun

Class VisualTotalsFunDef.VisualTotalMember

java.lang.Object

mondrian.olap.OlapElementBase

mondrian.olap.MemberBase

mondrian.rolap.RolapMemberBase

mondrian.olap.fun.VisualTotalsFunDef.VisualTotalMember

All Implemented Interfaces:

Comparable, Annotated, Member, OlapElement, RolapCalculation, RolapMember

Enclosing class:

VisualTotalsFunDef

public static class VisualTotalsFunDef.VisualTotalMember
extends RolapMemberBase

Calculated member for VisualTotals function.

It corresponds to a real member, and most of its properties are similar. The main differences are:

• its name is derived from the VisualTotals pattern, e.g. "*Subtotal - Dairy" as opposed to "Dairy"
• its value is a calculation computed by aggregating all of the members which occur following it in the list

Nested Class Summary

Nested classes/interfaces inherited from class mondrian.rolap.RolapMemberBase

RolapMemberBase.DefaultPropertyValueMapFactory, RolapMemberBase.PropertyValueMapFactory, RolapMemberBase.PropertyValueMapFactoryFactory

Nested classes/interfaces inherited from interface mondrian.olap.Member

Member.MemberType

Nested classes/interfaces inherited from interface mondrian.olap.OlapElement

OlapElement.LocalizedProperty

Field Summary

Fields inherited from class mondrian.olap.MemberBase

flags, level, parentMember, uniqueName

Fields inherited from class mondrian.olap.OlapElementBase

visible

Constructor Summary

Constructors

Constructor and Description
VisualTotalMember(Member member, String name, String caption, Exp exp)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Compares this member to another RolapMemberBase.
protected boolean	computeCalculated(Member.MemberType memberType) Computes the value to be returned by MemberBase.isCalculated(), so it can be cached in a variable.
boolean	equals(Object o)
String	getCaption() Returns the display name of this catalog element.
Member	getDataMember() Returns the system-generated data member that is associated with a nonleaf member of a dimension.
Exp	getExpression() Returns the expression by which this member is calculated.
Member	getMember()
int	getOrdinal() Returns the ordinal of this member within its hierarchy.
Object	getPropertyValue(String propertyName, boolean matchCase) Returns the value of the property named propertyName, matching according to the required case-sensitivity.
String	getQualifiedName() Returns the name of this element qualified by its class, for example "hierarchy 'Customers'".
int	getSolveOrder() Returns the solve order of this calculation.
int	hashCode()
void	setExpression(Evaluator evaluator, List<Member> childMembers)
void	setExpression(Exp exp)

Methods inherited from class mondrian.rolap.RolapMemberBase

childLevelHasApproxRowCount, containsAggregateFunction, equals, getAllMembers, getAnnotationMap, getCaptionValue, getCompiledExpression, getDepth, getHierarchy, getHierarchyCardinality, getHierarchyOrdinal, getKey, getLevel, getLogger, getName, getOrderKey, getParentMember, getProperties, getPropertyFormattedValue, getPropertyFromMap, getPropertyValue, isAllMember, isCalculatedInQuery, isHidden, isParentChildLeaf, keyToString, setCaptionValue, setContextIn, setName, setOrdinals, setProperty, setUniqueName

Methods inherited from class mondrian.olap.MemberBase

getAncestorMembers, getDescription, getDimension, getMemberType, getParentUniqueName, getUniqueName, isAll, isCalculated, isChildOrEqualTo, isChildOrEqualTo, isEvaluated, isMeasure, isNull, isParentChildPhysicalMember, lookupChild

Methods inherited from class mondrian.olap.OlapElementBase

clone, computeHashCode, getLocalized, isVisible, setCaption, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mondrian.olap.Member

getAncestorMembers, getMemberType, getParentUniqueName, isAll, isCalculated, isChildOrEqualTo, isEvaluated, isMeasure, isNull, isParentChildPhysicalMember

Methods inherited from interface mondrian.olap.OlapElement

getDescription, getDimension, getLocalized, getUniqueName, isVisible, lookupChild

Constructor Detail

VisualTotalMember

VisualTotalMember(Member member,
                  String name,
                  String caption,
                  Exp exp)

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class RolapMemberBase

compareTo

public int compareTo(Object o)

Description copied from class: RolapMemberBase

Compares this member to another RolapMemberBase.

The method first compares on keys; null keys always collate last. If the keys are equal, it compares using unique name.

This method does not consider RolapMemberBase.ordinal field, because ordinal is only unique within a parent. If you want to compare members which may be at any position in the hierarchy, use FunUtil.compareHierarchically(mondrian.olap.Member, mondrian.olap.Member, boolean).

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class RolapMemberBase

Returns:

-1 if this is less, 0 if this is the same, 1 if this is greater

hashCode

public int hashCode()

Overrides:

hashCode in class RolapMemberBase

getCaption

public String getCaption()

Description copied from class: OlapElementBase

Returns the display name of this catalog element. If no caption is defined, the name is returned.

Specified by:

getCaption in interface OlapElement

Overrides:

getCaption in class MemberBase

computeCalculated

protected boolean computeCalculated(Member.MemberType memberType)

Description copied from class: MemberBase

Computes the value to be returned by MemberBase.isCalculated(), so it can be cached in a variable.

Overrides:

computeCalculated in class MemberBase

Parameters:

memberType - Member type

Returns:

Whether this member is calculated

getSolveOrder

public int getSolveOrder()

Description copied from interface: RolapCalculation

Returns the solve order of this calculation. Identifies which order calculations are expanded.

Specified by:

getSolveOrder in interface Member

Specified by:

getSolveOrder in interface RolapCalculation

Overrides:

getSolveOrder in class MemberBase

Returns:

Solve order

getExpression

public Exp getExpression()

Description copied from class: MemberBase

Returns the expression by which this member is calculated. The expression is not null if and only if the member is not calculated.

Specified by:

getExpression in interface Member

Overrides:

getExpression in class MemberBase

setExpression

public void setExpression(Exp exp)

setExpression

public void setExpression(Evaluator evaluator,
                          List<Member> childMembers)

getOrdinal

public int getOrdinal()

Description copied from class: MemberBase

Returns the ordinal of this member within its hierarchy. The default implementation returns -1.

Specified by:

getOrdinal in interface Member

Overrides:

getOrdinal in class RolapMemberBase

getDataMember

public Member getDataMember()

Description copied from interface: Member

Returns the system-generated data member that is associated with a nonleaf member of a dimension.

Returns this member if this member is a leaf member, or if the nonleaf member does not have an associated data member.

Specified by:

getDataMember in interface Member

Overrides:

getDataMember in class MemberBase

getQualifiedName

public String getQualifiedName()

Description copied from interface: OlapElement

Returns the name of this element qualified by its class, for example "hierarchy 'Customers'".

Specified by:

getQualifiedName in interface OlapElement

Overrides:

getQualifiedName in class MemberBase

getMember

public Member getMember()

getPropertyValue

public Object getPropertyValue(String propertyName,
                               boolean matchCase)

Description copied from interface: Member

Returns the value of the property named propertyName, matching according to the required case-sensitivity.

Specified by:

getPropertyValue in interface Member

Overrides:

getPropertyValue in class RolapMemberBase