Package mondrian.olap.fun
Class TestMember
- java.lang.Object
-
- mondrian.olap.fun.TestMember
-
- All Implemented Interfaces:
java.lang.Comparable
,Annotated
,Member
,OlapElement
public class TestMember extends java.lang.Object implements Member
Mock implementation ofMember
for testing.- Author:
- Richard M. Emberson
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface mondrian.olap.Member
Member.MemberType
-
Nested classes/interfaces inherited from interface mondrian.olap.OlapElement
OlapElement.LocalizedProperty
-
-
Constructor Summary
Constructors Constructor Description TestMember(java.lang.String identifer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(java.lang.Object o)
java.util.List<Member>
getAncestorMembers()
Returns a list of the ancestor members of this member.java.util.Map<java.lang.String,Annotation>
getAnnotationMap()
Returns a list of annotations.java.lang.String
getCaption()
Member
getDataMember()
Returns the system-generated data member that is associated with a nonleaf member of a dimension.int
getDepth()
returns the depth of this member, which is not the level's depth in case of parent child dimensionsjava.lang.String
getDescription()
Dimension
getDimension()
Returns the dimension of a this expression, or null if no dimension is defined.Exp
getExpression()
Hierarchy
getHierarchy()
Level
getLevel()
java.lang.String
getLocalized(OlapElement.LocalizedProperty prop, java.util.Locale locale)
Returns the value of a property (caption or description) of this element in the given locale.Member.MemberType
getMemberType()
Returns the type of member.java.lang.String
getName()
java.lang.Comparable
getOrderKey()
Returns the order key of the member (relative to its siblings); null if undefined or unavailable.int
getOrdinal()
Returns the ordinal of the member.Member
getParentMember()
Returns this member's parent, or null (not the 'null member', as returned byHierarchy.getNullMember()
) if it has no parent.java.lang.String
getParentUniqueName()
Returns name of parent member, or empty string (not null) if we are the root.Property[]
getProperties()
Returns the definitions of the properties this member may have.java.lang.String
getPropertyFormattedValue(java.lang.String propertyName)
Returns the formatted value of the property namedpropertyName
.java.lang.Object
getPropertyValue(java.lang.String propertyName)
Returns the value of the property namedpropertyName
.java.lang.Object
getPropertyValue(java.lang.String propertyName, boolean matchCase)
Returns the value of the property namedpropertyName
, matching according to the required case-sensitivity.java.lang.String
getQualifiedName()
Returns the name of this element qualified by its class, for example "hierarchy 'Customers'".int
getSolveOrder()
java.lang.String
getUniqueName()
boolean
isAll()
Returns whether this is the 'all' member.boolean
isCalculated()
Returns whether this member is computed using either awith member
clause in an mdx query or a calculated member defined in cube.boolean
isCalculatedInQuery()
Returns whether this member is computed from aWITH MEMBER
clause in an MDX query.boolean
isChildOrEqualTo(Member member)
Returns whethermember
is equal to, a child, or a descendent of thisMember
.boolean
isEvaluated()
Returns whether this member should be evaluated within the Evaluator.boolean
isHidden()
Returns whether this member is 'hidden', as per the rules which define a ragged hierarchy.boolean
isMeasure()
Returns whether this is a member of the measures dimension.boolean
isNull()
Returns whether this is the 'null member'.boolean
isParentChildLeaf()
boolean
isParentChildPhysicalMember()
boolean
isVisible()
Returns whether this element is visible to end-users.OlapElement
lookupChild(SchemaReader schemaReader, Id.Segment s, MatchType matchType)
Looks up a child element, returning null if it does not exist.void
setName(java.lang.String name)
Only allowable if the member is part of theWITH
clause of a query.void
setProperty(java.lang.String name, java.lang.Object value)
Sets a property of this member to a given value.java.lang.String
toString()
-
-
-
Method Detail
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
compareTo
public int compareTo(java.lang.Object o)
- Specified by:
compareTo
in interfacejava.lang.Comparable
-
getParentMember
public Member getParentMember()
Description copied from interface:Member
Returns this member's parent, or null (not the 'null member', as returned byHierarchy.getNullMember()
) if it has no parent.In an access-control context, a member may have no visible parents, so use
SchemaReader.getMemberParent(mondrian.olap.Member)
.- Specified by:
getParentMember
in interfaceMember
-
getHierarchy
public Hierarchy getHierarchy()
- Specified by:
getHierarchy
in interfaceMember
- Specified by:
getHierarchy
in interfaceOlapElement
-
getParentUniqueName
public java.lang.String getParentUniqueName()
Description copied from interface:Member
Returns name of parent member, or empty string (not null) if we are the root.- Specified by:
getParentUniqueName
in interfaceMember
-
getMemberType
public Member.MemberType getMemberType()
Description copied from interface:Member
Returns the type of member.- Specified by:
getMemberType
in interfaceMember
-
isParentChildLeaf
public boolean isParentChildLeaf()
- Specified by:
isParentChildLeaf
in interfaceMember
- Returns:
- True when the member is a leaf member, meaning it has no children
-
isParentChildPhysicalMember
public boolean isParentChildPhysicalMember()
- Specified by:
isParentChildPhysicalMember
in interfaceMember
- Returns:
- True when the member is part of a Parent-Child hierarchy and it is a physical member. In a Parent Child Hierarchy without a closure table, each member needs to be treated as calculated. We need a way to distinguish between true calculated members and physical members that exist in the source data
-
setName
public void setName(java.lang.String name)
Description copied from interface:Member
Only allowable if the member is part of theWITH
clause of a query.
-
isAll
public boolean isAll()
Description copied from interface:Member
Returns whether this is the 'all' member.
-
isMeasure
public boolean isMeasure()
Description copied from interface:Member
Returns whether this is a member of the measures dimension.
-
isNull
public boolean isNull()
Description copied from interface:Member
Returns whether this is the 'null member'.
-
isChildOrEqualTo
public boolean isChildOrEqualTo(Member member)
Description copied from interface:Member
Returns whethermember
is equal to, a child, or a descendent of thisMember
.- Specified by:
isChildOrEqualTo
in interfaceMember
-
isCalculated
public boolean isCalculated()
Description copied from interface:Member
Returns whether this member is computed using either awith member
clause in an mdx query or a calculated member defined in cube.- Specified by:
isCalculated
in interfaceMember
-
isEvaluated
public boolean isEvaluated()
Description copied from interface:Member
Returns whether this member should be evaluated within the Evaluator.Normally
Member.isCalculated()
andMember.isEvaluated()
should return the same value, but in situations where mondrian would like to treat the two concepts separately such in role based security, these values may differ.- Specified by:
isEvaluated
in interfaceMember
- Returns:
- true if evaluated
-
getSolveOrder
public int getSolveOrder()
- Specified by:
getSolveOrder
in interfaceMember
-
getExpression
public Exp getExpression()
- Specified by:
getExpression
in interfaceMember
-
getAncestorMembers
public java.util.List<Member> getAncestorMembers()
Description copied from interface:Member
Returns a list of the ancestor members of this member.- Specified by:
getAncestorMembers
in interfaceMember
-
isCalculatedInQuery
public boolean isCalculatedInQuery()
Description copied from interface:Member
Returns whether this member is computed from aWITH MEMBER
clause in an MDX query.- Specified by:
isCalculatedInQuery
in interfaceMember
-
getPropertyValue
public java.lang.Object getPropertyValue(java.lang.String propertyName)
Description copied from interface:Member
Returns the value of the property namedpropertyName
. Name match is case-sensitive.- Specified by:
getPropertyValue
in interfaceMember
-
getPropertyValue
public java.lang.Object getPropertyValue(java.lang.String propertyName, boolean matchCase)
Description copied from interface:Member
Returns the value of the property namedpropertyName
, matching according to the required case-sensitivity.- Specified by:
getPropertyValue
in interfaceMember
-
getPropertyFormattedValue
public java.lang.String getPropertyFormattedValue(java.lang.String propertyName)
Description copied from interface:Member
Returns the formatted value of the property namedpropertyName
.- Specified by:
getPropertyFormattedValue
in interfaceMember
-
setProperty
public void setProperty(java.lang.String name, java.lang.Object value)
Description copied from interface:Member
Sets a property of this member to a given value.- Specified by:
setProperty
in interfaceMember
-
getProperties
public Property[] getProperties()
Description copied from interface:Member
Returns the definitions of the properties this member may have.- Specified by:
getProperties
in interfaceMember
-
getOrdinal
public int getOrdinal()
Description copied from interface:Member
Returns the ordinal of the member.- Specified by:
getOrdinal
in interfaceMember
-
getOrderKey
public java.lang.Comparable getOrderKey()
Description copied from interface:Member
Returns the order key of the member (relative to its siblings); null if undefined or unavailable.- Specified by:
getOrderKey
in interfaceMember
-
isHidden
public boolean isHidden()
Description copied from interface:Member
Returns whether this member is 'hidden', as per the rules which define a ragged hierarchy.
-
getDepth
public int getDepth()
Description copied from interface:Member
returns the depth of this member, which is not the level's depth in case of parent child dimensions
-
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 interfaceMember
-
getUniqueName
public java.lang.String getUniqueName()
- Specified by:
getUniqueName
in interfaceOlapElement
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceOlapElement
-
getDescription
public java.lang.String getDescription()
- Specified by:
getDescription
in interfaceOlapElement
-
lookupChild
public OlapElement lookupChild(SchemaReader schemaReader, Id.Segment s, MatchType matchType)
Description copied from interface:OlapElement
Looks up a child element, returning null if it does not exist.- Specified by:
lookupChild
in interfaceOlapElement
-
getQualifiedName
public java.lang.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 interfaceOlapElement
-
getCaption
public java.lang.String getCaption()
- Specified by:
getCaption
in interfaceOlapElement
-
getLocalized
public java.lang.String getLocalized(OlapElement.LocalizedProperty prop, java.util.Locale locale)
Description copied from interface:OlapElement
Returns the value of a property (caption or description) of this element in the given locale.- Specified by:
getLocalized
in interfaceOlapElement
locale
- Locale- Returns:
- Localized caption or description
-
isVisible
public boolean isVisible()
Description copied from interface:OlapElement
Returns whether this element is visible to end-users.Visibility is a hint for client applications. An element's visibility does not affect how it is treated when MDX queries are evaluated.
- Specified by:
isVisible
in interfaceOlapElement
- Returns:
- Whether this element is visible
-
getDimension
public Dimension getDimension()
Description copied from interface:OlapElement
Returns the dimension of a this expression, or null if no dimension is defined. Applicable only to set expressions.Example 1:
has dimension[Sales].children
[Sales]
.Example 2:
has dimension [Promotion Media].order(except([Promotion Media].[Media Type].members, {[Promotion Media].[Media Type].[No Media]}), [Measures].[Unit Sales], DESC)
Example 3:
has no dimension (well, actually it is [Product] x [Gender], but we can't represent that, so we return null);CrossJoin([Product].[Product Department].members, [Gender].members)
- Specified by:
getDimension
in interfaceOlapElement
-
getAnnotationMap
public java.util.Map<java.lang.String,Annotation> getAnnotationMap()
Description copied from interface:Annotated
Returns a list of annotations.The map may be empty, never null.
- Specified by:
getAnnotationMap
in interfaceAnnotated
- Returns:
- Map from annotation name to annotations.
-
-