mondrian.olap
Class OlapElementBase

java.lang.Object
  mondrian.olap.OlapElementBase

All Implemented Interfaces:

OlapElement

Direct Known Subclasses:

CubeBase, DimensionBase, HierarchyBase, LevelBase, MemberBase, SetBase

public abstract class OlapElementBase
extends Object
implements OlapElement

OlapElementBase is an abstract base class for implementations of OlapElement.

Since:

6 August, 2001

Author:

jhyde

Nested Class Summary

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

OlapElement.LocalizedProperty

Field Summary

protected String	caption
protected boolean	visible

Constructor Summary

protected

OlapElementBase()

Method Summary

Object	clone()
protected int	computeHashCode() Computes this object's hash code.
boolean	equals(Object o)
boolean	equals(OlapElement mdxElement)
String	getCaption() Returns the display name of this catalog element.
String	getLocalized(OlapElement.LocalizedProperty prop, Locale locale) Returns the value of a property (caption or description) of this element in the given locale.
protected abstract org.apache.log4j.Logger	getLogger()
int	hashCode()
boolean	isVisible() Returns whether this element is visible to end-users.
void	setCaption(String caption) Sets the display name of this catalog element.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface mondrian.olap.OlapElement

getDescription, getDimension, getHierarchy, getName, getQualifiedName, getUniqueName, lookupChild

Field Detail

caption

protected String caption

visible

protected boolean visible

Constructor Detail

OlapElementBase

protected OlapElementBase()

Method Detail

getLogger

protected abstract org.apache.log4j.Logger getLogger()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equals

public boolean equals(OlapElement mdxElement)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

computeHashCode

protected int computeHashCode()

Computes this object's hash code. Called at most once.

Returns:

hash code

toString

public String toString()

Overrides:

toString in class Object

clone

public Object clone()

Overrides:

clone in class Object

getCaption

public String getCaption()

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

Specified by:

getCaption in interface OlapElement

setCaption

public void setCaption(String caption)

Sets the display name of this catalog element.

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 interface OlapElement

Returns:

Whether this element is visible

getLocalized

public String getLocalized(OlapElement.LocalizedProperty prop,
                           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 interface OlapElement

locale - Locale

Returns:

Localized caption or description