com.sas.storage.olap
Interface DimensionInterface

All Superinterfaces:

MetadataEntityInterface

All Known Implementing Classes:

Dimension

@SASScope(value="ALL")
public interface DimensionInterface
extends MetadataEntityInterface

Represents a dimension in a multidimensional cube. In addition to the basic information about the dimension itself, the parent and child interfaces can also be retrieved directly from the DimensionInterface. The getCube() method returns the CubeInterface which parents this dimension, and the hierarchies can be retrieved with getHierarchies(). The dimension may also be bound to an instance of the MetadataInterface, which is accessible from the getMetadata() method.

See Also:

MetadataInterface, CubeInterface, HierarchyInterface

Field Summary

static int	TYPE_MEASURE The name of the dimension whose type is measure, as well as the return value for the getType method.
static int	TYPE_OTHER The name of the dimension whose type is something other than time or meausure, as well as the return value for the getType method.
static int	TYPE_TIME The name of the dimension whose type is time, as well as the return value for the getType method.
static int	TYPE_UNKNOWN The name of the dimension whose type is unknown, as well as the return value for the getType method.

Method Summary

abstract CubeInterface	getCube() Returns the name of the cube to which the dimension belongs.
abstract HierarchyInterface	getDefaultHierarchy() Returns the default hierarchy for this dimension.
abstract Filter	getFilter() Returns a copy of the Filter object that was used to obtain this DimensionInterface.
abstract HierarchyInterface[]	getHierarchies() Returns the hierarchies associated with this dimension.
abstract int	getMemberCount() Returns the number of members in this dimension
abstract MemberInterface[]	getMembers() Get all the members that belong to this dimension.
abstract int	getType() Returns the type of the dimension.

Methods inherited from interface com.sas.storage.olap.MetadataEntityInterface

getCreationDateTime, getDescription, getLabel, getMetadata, getName, getUniqueName, getUpdateDateTime

Field Detail

TYPE_TIME

static final int TYPE_TIME

The name of the dimension whose type is time, as well as the return value for the getType method.

See Also:

Constant Field Values

TYPE_MEASURE

static final int TYPE_MEASURE

The name of the dimension whose type is measure, as well as the return value for the getType method.

See Also:

Constant Field Values

TYPE_OTHER

static final int TYPE_OTHER

The name of the dimension whose type is something other than time or meausure, as well as the return value for the getType method.

See Also:

Constant Field Values

TYPE_UNKNOWN

static final int TYPE_UNKNOWN

The name of the dimension whose type is unknown, as well as the return value for the getType method.

See Also:

Constant Field Values

Method Detail

getMembers

MemberInterface[] getMembers()
                             throws OLAPException

Get all the members that belong to this dimension.

Returns:

an array of MemberInterface objects that belong to this dimension

Throws:

OLAPException - if the database error occurs

getCube

CubeInterface getCube()
                      throws OLAPException

Returns the name of the cube to which the dimension belongs.

Returns:

The name of the cube to which the dimension belongs.

Throws:

OLAPException - if a database error occurs

getType

int getType()
            throws OLAPException

Returns the type of the dimension. TYPE_TIME, TYPE_MEASURE, TYPE_OTHER, TYPE_UNKNOWN

Returns:

The type of the dimension.

Throws:

OLAPException - if a database error occurs

getMemberCount

int getMemberCount()
                   throws OLAPException

Returns the number of members in this dimension

Returns:

The number of members in this dimension

Throws:

OLAPException - if a database error occurs

getDefaultHierarchy

HierarchyInterface getDefaultHierarchy()
                                       throws OLAPException

Returns the default hierarchy for this dimension.

Returns:

The default hierarchy for this dimension.

Throws:

OLAPException - if a database error occurs

getHierarchies

HierarchyInterface[] getHierarchies()
                                    throws OLAPException

Returns the hierarchies associated with this dimension.

Returns:

An array of hierarchies associated with this dimension.

Throws:

OLAPException - if a database error occurs

getFilter

Filter getFilter()
                 throws OLAPException

Returns a copy of the Filter object that was used to obtain this DimensionInterface. The filter object may be applied explicitly via the MetadataInterface, or it may be created implicitly via a getDimensions() method.

Returns:

A copy of the Filter object that was used to obtain this DimensionInterface

Throws:

OLAPException - if a database error occurs