mondrian.rolap
Class RolapLevel

java.lang.Object
  mondrian.olap.OlapElementBase
      mondrian.olap.LevelBase
          mondrian.rolap.RolapLevel

All Implemented Interfaces:

Annotated, Level, OlapElement

Direct Known Subclasses:

RolapCubeLevel

public class RolapLevel
extends LevelBase

RolapLevel implements Level for a ROLAP database.

Since:

10 August, 2001

Author:

jhyde

Nested Class Summary

static class

RolapLevel.HideMemberCondition Conditions under which a level's members may be hidden (thereby creating a ragged hierarchy).

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

OlapElement.LocalizedProperty

Field Summary

protected MondrianDef.Expression	captionExp The column or expression which yields the level members' caption.
(package private) static int	FLAG_ALL
(package private) static int	FLAG_UNIQUE For SQL generator.
protected MondrianDef.Expression	keyExp The column or expression which yields the level's key.
protected MondrianDef.Expression	nameExp Ths expression which gives the name of members of this level.
protected MondrianDef.Expression	ordinalExp The column or expression which yields the level's ordinal.
protected MondrianDef.Expression	parentExp The expression which joins to the parent member in a parent-child hierarchy, or null if this is a regular hierarchy.
protected MondrianDef.Closure	xmlClosure

Fields inherited from class mondrian.olap.LevelBase

approxRowCount, depth, description, hierarchy, levelType, memberFormatter, name, uniqueName

Fields inherited from class mondrian.olap.OlapElementBase

caption, visible

Constructor Summary

RolapLevel(RolapHierarchy hierarchy, int depth, MondrianDef.Level xmlLevel)

RolapLevel(RolapHierarchy hierarchy, String name, String caption, boolean visible, String description, int depth, MondrianDef.Expression keyExp, MondrianDef.Expression nameExp, MondrianDef.Expression captionExp, MondrianDef.Expression ordinalExp, MondrianDef.Expression parentExp, String nullParentValue, MondrianDef.Closure xmlClosure, RolapProperty[] properties, int flags, Dialect.Datatype datatype, SqlStatement.Type internalType, RolapLevel.HideMemberCondition hideMemberCondition, LevelType levelType, String approxRowCount, Map<String,Annotation> annotationMap)
Creates a level.

Method Summary

boolean	areMembersUnique()
Map<String,Annotation>	getAnnotationMap() Returns a list of annotations.
int	getApproxRowCount() Returns the approximate number of members in this level, or Integer.MIN_VALUE if no approximation is known.
MondrianDef.Expression	getCaptionExp()
RolapLevel	getClosedPeer()
(package private) Dialect.Datatype	getDatatype()
(package private) int	getFlags()
(package private) RolapLevel.HideMemberCondition	getHideMemberCondition()
RolapHierarchy	getHierarchy()
Property[]	getInheritedProperties() Returns properties defined against this level and parent levels.
SqlStatement.Type	getInternalType()
MondrianDef.Expression	getKeyExp()
protected org.apache.log4j.Logger	getLogger()
MondrianDef.Expression	getNameExp()
(package private) String	getNullParentValue()
(package private) MondrianDef.Expression	getOrdinalExp()
(package private) MondrianDef.Expression	getParentExp()
RolapProperty[]	getProperties() Returns properties defined against this level.
String	getTableAlias()
(package private) String	getTableName()
boolean	hasCaptionColumn()
(package private) boolean	hasClosedPeer() Returns true when the level is part of a parent/child hierarchy and has an equivalent closed level.
(package private) void	init(MondrianDef.CubeDimension xmlDimension)
boolean	isAll()
boolean	isParentChild() Returns whether this level is parent-child.
boolean	isSimple() Indicates that level is not ragged and not a parent/child level.
boolean	isUnique()
OlapElement	lookupChild(SchemaReader schemaReader, Id.Segment name)
OlapElement	lookupChild(SchemaReader schemaReader, Id.Segment name, MatchType matchType) Looks up a child element, returning null if it does not exist.
static RolapLevel	lookupLevel(RolapLevel[] levels, String levelName)

Methods inherited from class mondrian.olap.LevelBase

getChildLevel, getDepth, getDescription, getDimension, getLevelType, getMemberFormatter, getName, getParentLevel, getQualifiedName, getUniqueName, isMeasure, setApproxRowCount

Methods inherited from class mondrian.olap.OlapElementBase

clone, computeHashCode, equals, equals, getCaption, getLocalized, hashCode, isVisible, setCaption, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface mondrian.olap.OlapElement

getCaption, getLocalized, isVisible

Field Detail

keyExp

protected MondrianDef.Expression keyExp

The column or expression which yields the level's key.

ordinalExp

protected MondrianDef.Expression ordinalExp

The column or expression which yields the level's ordinal.

captionExp

protected MondrianDef.Expression captionExp

The column or expression which yields the level members' caption.

FLAG_ALL

static final int FLAG_ALL

See Also:

Constant Field Values

FLAG_UNIQUE

static final int FLAG_UNIQUE

For SQL generator. Whether values of "column" are unique globally unique (as opposed to unique only within the context of the parent member).

See Also:

Constant Field Values

nameExp

protected MondrianDef.Expression nameExp

Ths expression which gives the name of members of this level. If null, members are named using the key expression.

parentExp

protected MondrianDef.Expression parentExp

The expression which joins to the parent member in a parent-child hierarchy, or null if this is a regular hierarchy.

xmlClosure

protected final MondrianDef.Closure xmlClosure

Constructor Detail

RolapLevel

RolapLevel(RolapHierarchy hierarchy,
           String name,
           String caption,
           boolean visible,
           String description,
           int depth,
           MondrianDef.Expression keyExp,
           MondrianDef.Expression nameExp,
           MondrianDef.Expression captionExp,
           MondrianDef.Expression ordinalExp,
           MondrianDef.Expression parentExp,
           String nullParentValue,
           MondrianDef.Closure xmlClosure,
           RolapProperty[] properties,
           int flags,
           Dialect.Datatype datatype,
           SqlStatement.Type internalType,
           RolapLevel.HideMemberCondition hideMemberCondition,
           LevelType levelType,
           String approxRowCount,
           Map<String,Annotation> annotationMap)

Creates a level.

Pre-condition:

parentExp != null || nullParentValue == null, properties != null, levelType != null, hideMemberCondition != null

RolapLevel

RolapLevel(RolapHierarchy hierarchy,
           int depth,
           MondrianDef.Level xmlLevel)

Method Detail

getHierarchy

public RolapHierarchy getHierarchy()

Specified by:

getHierarchy in interface Level

Specified by:

getHierarchy in interface OlapElement

Overrides:

getHierarchy in class LevelBase

getAnnotationMap

public Map<String,Annotation> getAnnotationMap()

Description copied from interface: Annotated

Returns a list of annotations.

The map may be empty, never null.

Returns:

Map from annotation name to annotations.

getLogger

protected org.apache.log4j.Logger getLogger()

Specified by:

getLogger in class OlapElementBase

getTableName

String getTableName()

getKeyExp

public MondrianDef.Expression getKeyExp()

getOrdinalExp

MondrianDef.Expression getOrdinalExp()

getCaptionExp

public MondrianDef.Expression getCaptionExp()

hasCaptionColumn

public boolean hasCaptionColumn()

getFlags

final int getFlags()

getHideMemberCondition

RolapLevel.HideMemberCondition getHideMemberCondition()

isUnique

public final boolean isUnique()

getDatatype

final Dialect.Datatype getDatatype()

getNullParentValue

final String getNullParentValue()

isParentChild

public boolean isParentChild()

Returns whether this level is parent-child.

getParentExp

MondrianDef.Expression getParentExp()

getNameExp

public MondrianDef.Expression getNameExp()

init

void init(MondrianDef.CubeDimension xmlDimension)

isAll

public final boolean isAll()

Specified by:

isAll in interface Level

Specified by:

isAll in class LevelBase

areMembersUnique

public boolean areMembersUnique()

getTableAlias

public String getTableAlias()

getProperties

public RolapProperty[] getProperties()

Description copied from interface: Level

Returns properties defined against this level.

getInheritedProperties

public Property[] getInheritedProperties()

Description copied from interface: Level

Returns properties defined against this level and parent levels.

getApproxRowCount

public int getApproxRowCount()

Description copied from interface: Level

Returns the approximate number of members in this level, or Integer.MIN_VALUE if no approximation is known.

getInternalType

public SqlStatement.Type getInternalType()

lookupChild

public OlapElement lookupChild(SchemaReader schemaReader,
                               Id.Segment name)

lookupChild

public OlapElement lookupChild(SchemaReader schemaReader,
                               Id.Segment name,
                               MatchType matchType)

Description copied from interface: OlapElement

Looks up a child element, returning null if it does not exist.

Specified by:

lookupChild in interface OlapElement

Overrides:

lookupChild in class LevelBase

isSimple

public boolean isSimple()

Indicates that level is not ragged and not a parent/child level.

hasClosedPeer

boolean hasClosedPeer()

Returns true when the level is part of a parent/child hierarchy and has an equivalent closed level.

getClosedPeer

public RolapLevel getClosedPeer()

lookupLevel

public static RolapLevel lookupLevel(RolapLevel[] levels,
                                     String levelName)