org.olap4j.type
Class ScalarType

java.lang.Object
  org.olap4j.type.ScalarType

All Implemented Interfaces:

Type

Direct Known Subclasses:

BooleanType, NullType, NumericType, StringType, SymbolType

public class ScalarType
extends Object
implements Type

Base class for types which represent scalar values.

An instance of this class means a scalar value of unknown type. Usually one of the derived classes NumericType, StringType, BooleanType is used instead.

Since:

Feb 17, 2005

Version:

$Id: ScalarType.java 482 2012-01-05 23:27:27Z jhyde $

Author:

jhyde

Constructor Summary

ScalarType()

Method Summary

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.
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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScalarType

public ScalarType()

Method Detail

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

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

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