org.olap4j.type

Class CubeType

java.lang.Object

org.olap4j.type.CubeType

All Implemented Interfaces:

Type

public class CubeType
extends Object
implements Type

The type of an expression which represents a Cube or Virtual Cube.

Since:

Feb 17, 2005

Author:

jhyde

Constructor Summary

Constructors

Constructor and Description
CubeType(Cube cube) Creates a type representing a cube.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Cube	getCube() Returns the cube.
Dimension	getDimension() Returns the dimension of this type, or null if not known.
Hierarchy	getHierarchy() Returns the hierarchy of this type.
Level	getLevel() Returns the level of this type, or null if not known.
int	hashCode()
boolean	usesDimension(Dimension dimension, boolean maybe) Returns whether this type contains a given dimension. For example: DimensionType([Gender]) uses only the [Gender] dimension. TupleType(MemberType([Gender]), MemberType([Store])) uses [Gender] and [Store] dimensions. The maybe parameter comes into play when the dimensional information is incomplete.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CubeType

public CubeType(Cube cube)

Creates a type representing a cube.

Parameters:

cube - Cube

Method Detail

getCube

public Cube getCube()

Returns the cube.

Returns:

the cube

usesDimension

public boolean usesDimension(Dimension dimension,
                             boolean maybe)

Description copied from interface: Type

Returns whether this type contains a given dimension.

For example:

• DimensionType([Gender]) uses only the [Gender] dimension.
• TupleType(MemberType([Gender]), MemberType([Store])) uses [Gender] and [Store] dimensions.

The maybe parameter comes into play when the dimensional information is incomplete. For example, when applied to TupleType(MemberType(null), MemberType([Store])), usesDimension([Gender], false) returns true because it is possible that the expression returns a member of the [Gender] dimension.

Specified by:

usesDimension in interface Type

Parameters:

dimension - Dimension

maybe - If true, returns true only if this type definitely uses the dimension

Returns:

whether this type definitely (or if maybe is true, possibly) uses the given dimension

getDimension

public Dimension getDimension()

Description copied from interface: Type

Returns the dimension of this type, or null if not known.

Specified by:

getDimension in interface Type

Returns:

dimension of this type

getHierarchy

public Hierarchy getHierarchy()

Description copied from interface: Type

Returns the hierarchy of this type. If not applicable, throws.

Specified by:

getHierarchy in interface Type

Returns:

hierarchy of this type

getLevel

public Level getLevel()

Description copied from interface: Type

Returns the level of this type, or null if not known.

Specified by:

getLevel in interface Type

Returns:

level of this type

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object