public class TestMember extends Object implements Member
Member
for testing.Member.MemberType
OlapElement.LocalizedProperty
Constructor and Description |
---|
TestMember(String identifer) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Object o) |
List<Member> |
getAncestorMembers()
Returns a list of the ancestor members of this member.
|
Map<String,Annotation> |
getAnnotationMap()
Returns a list of annotations.
|
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 dimensions
|
String |
getDescription() |
Dimension |
getDimension()
Returns the dimension of a this expression, or null if no dimension is
defined.
|
Exp |
getExpression() |
Hierarchy |
getHierarchy() |
Level |
getLevel() |
String |
getLocalized(OlapElement.LocalizedProperty prop,
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.
|
String |
getName() |
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 by
Hierarchy.getNullMember() ) if it has no parent. |
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.
|
String |
getPropertyFormattedValue(String propertyName)
Returns the formatted value of the property named
propertyName . |
Object |
getPropertyValue(String propertyName)
Returns the value of the property named
propertyName . |
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() |
String |
getUniqueName() |
boolean |
isAll()
Returns whether this is the 'all' member.
|
boolean |
isCalculated()
Returns whether this member is computed using either a
with
member clause in an mdx query or a calculated member defined in
cube. |
boolean |
isCalculatedInQuery()
Returns whether this member is computed from a
WITH MEMBER
clause in an MDX query. |
boolean |
isChildOrEqualTo(Member member)
Returns whether
member is equal to, a child, or a
descendent of this Member . |
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 |
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(String name)
Only allowable if the member is part of the
WITH clause of
a query. |
void |
setProperty(String name,
Object value)
Sets a property of this member to a given value.
|
String |
toString() |
public TestMember(String identifer)
public int compareTo(Object o)
compareTo
in interface Comparable
public Member getParentMember()
Member
Hierarchy.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)
.
getParentMember
in interface Member
public Hierarchy getHierarchy()
getHierarchy
in interface Member
getHierarchy
in interface OlapElement
public String getParentUniqueName()
Member
getParentUniqueName
in interface Member
public Member.MemberType getMemberType()
Member
getMemberType
in interface Member
public boolean isParentChildLeaf()
isParentChildLeaf
in interface Member
public void setName(String name)
Member
WITH
clause of
a query.public boolean isAll()
Member
public boolean isMeasure()
Member
public boolean isNull()
Member
public boolean isChildOrEqualTo(Member member)
Member
member
is equal to, a child, or a
descendent of this Member
.isChildOrEqualTo
in interface Member
public boolean isCalculated()
Member
with
member
clause in an mdx query or a calculated member defined in
cube.isCalculated
in interface Member
public boolean isEvaluated()
Member
Normally Member.isCalculated()
and Member.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.
isEvaluated
in interface Member
public int getSolveOrder()
getSolveOrder
in interface Member
public Exp getExpression()
getExpression
in interface Member
public List<Member> getAncestorMembers()
Member
getAncestorMembers
in interface Member
public boolean isCalculatedInQuery()
Member
WITH MEMBER
clause in an MDX query.isCalculatedInQuery
in interface Member
public Object getPropertyValue(String propertyName)
Member
propertyName
.
Name match is case-sensitive.getPropertyValue
in interface Member
public Object getPropertyValue(String propertyName, boolean matchCase)
Member
propertyName
,
matching according to the required case-sensitivity.getPropertyValue
in interface Member
public String getPropertyFormattedValue(String propertyName)
Member
propertyName
.getPropertyFormattedValue
in interface Member
public void setProperty(String name, Object value)
Member
setProperty
in interface Member
public Property[] getProperties()
Member
getProperties
in interface Member
public int getOrdinal()
Member
getOrdinal
in interface Member
public Comparable getOrderKey()
Member
getOrderKey
in interface Member
public boolean isHidden()
Member
public int getDepth()
Member
public Member getDataMember()
Member
Returns this member if this member is a leaf member, or if the nonleaf member does not have an associated data member.
getDataMember
in interface Member
public String getUniqueName()
getUniqueName
in interface OlapElement
public String getName()
getName
in interface OlapElement
public String getDescription()
getDescription
in interface OlapElement
public OlapElement lookupChild(SchemaReader schemaReader, Id.Segment s, MatchType matchType)
OlapElement
lookupChild
in interface OlapElement
public String getQualifiedName()
OlapElement
getQualifiedName
in interface OlapElement
public String getCaption()
getCaption
in interface OlapElement
public String getLocalized(OlapElement.LocalizedProperty prop, Locale locale)
OlapElement
getLocalized
in interface OlapElement
locale
- Localepublic boolean isVisible()
OlapElement
Visibility is a hint for client applications. An element's visibility does not affect how it is treated when MDX queries are evaluated.
isVisible
in interface OlapElement
public Dimension getDimension()
OlapElement
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)
getDimension
in interface OlapElement
public Map<String,Annotation> getAnnotationMap()
Annotated
The map may be empty, never null.
getAnnotationMap
in interface Annotated