com.sas.storage.olap
Interface LevelInterface

All Superinterfaces:

MetadataEntityInterface

All Known Implementing Classes:

Level

public interface LevelInterface
extends MetadataEntityInterface

Represents a level in a multidimensional cube. In addition to the basic information about the level itself, the parent and child interfaces can also be retrieved directly from the LevelInterface. The getHierarchy() method returns the HierarchyInterface which parents this level, and the members can be retrieved with getMembers() or getMembers(index, count) methods. The level may also be bound to an instance of the MetadataInterface, which is accessible from the getMetadata() method.

See Also:

MetadataInterface, HierarchyInterface, MemberInterface, PropertyInterface

Field Summary

static int	TYPE_ALL The name of the level whose type is all, as well as the return value for the getType method.
static int	TYPE_CALCULATED The name of the level whose type is calculated, as well as the return value for the getType method.
static int	TYPE_REGULAR The name of the level whose type is regular, as well as the return value for the getType method.
static int	TYPE_TIME The name of the level whose type is time, as well as the return value for the getType method.
static int	TYPE_TIME_DAYS The name of the level whose type is days, as well as the return value for the getType method.
static int	TYPE_TIME_HALF_YEAR The name of the level whose type is a half year, as well as the return value for the getType method.
static int	TYPE_TIME_HOURS The name of the level whose type is hours, as well as the return value for the getType method.
static int	TYPE_TIME_MINUTES The name of the level whose type is minutes, as well as the return value for the getType method.
static int	TYPE_TIME_MONTHS The name of the level whose type is a month, as well as the return value for the getType method.
static int	TYPE_TIME_QUARTERS The name of the level whose type is a quarter, as well as the return value for the getType method.
static int	TYPE_TIME_SECONDS The name of the level whose type is seconds, as well as the return value for the getType method.
static int	TYPE_TIME_UNDEFINED The name of the level whose type is time, but undefined, as well as the return value for the getType method.
static int	TYPE_TIME_WEEKS The name of the level whose type is weeks, as well as the return value for the getType method.
static int	TYPE_TIME_YEARS The name of the level whose type is years, as well as the return value for the getType method.
static int	TYPE_UNKNOWN The name of the level whose type is unknown, as well as the return value for the getType method.

Method Summary

CubeInterface	getCube() Returns the cube to which the hierarchy belongs.
int	getDepth() Returns the distance of the level from the root of the hierarchy.
Filter	getFilter() Returns a copy of the Filter object that was used to obtain this LevelInterface.
HierarchyInterface	getHierarchy() Returns the hierarchy that this level is a child of.
int	getMemberCount() Returns the number of members associated with the level.
MemberInterface[]	getMembers() Returns the members associated with this level.
MemberInterface[]	getMembers(int index, int count) Returns the members associated with a given range of indices.
PropertyInterface[]	getProperties() Returns the properties associated with this level.
int	getType() Returns the type of the level.

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

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

Field Detail

TYPE_REGULAR

static final int TYPE_REGULAR

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

See Also:

Constant Field Values

TYPE_CALCULATED

static final int TYPE_CALCULATED

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

See Also:

Constant Field Values

TYPE_ALL

static final int TYPE_ALL

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

See Also:

Constant Field Values

TYPE_TIME

static final int TYPE_TIME

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

See Also:

Constant Field Values

TYPE_TIME_YEARS

static final int TYPE_TIME_YEARS

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

See Also:

Constant Field Values

TYPE_TIME_HALF_YEAR

static final int TYPE_TIME_HALF_YEAR

The name of the level whose type is a half year, as well as the return value for the getType method.

See Also:

Constant Field Values

TYPE_TIME_QUARTERS

static final int TYPE_TIME_QUARTERS

The name of the level whose type is a quarter, as well as the return value for the getType method.

See Also:

Constant Field Values

TYPE_TIME_MONTHS

static final int TYPE_TIME_MONTHS

The name of the level whose type is a month, as well as the return value for the getType method.

See Also:

Constant Field Values

TYPE_TIME_WEEKS

static final int TYPE_TIME_WEEKS

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

See Also:

Constant Field Values

TYPE_TIME_DAYS

static final int TYPE_TIME_DAYS

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

See Also:

Constant Field Values

TYPE_TIME_HOURS

static final int TYPE_TIME_HOURS

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

See Also:

Constant Field Values

TYPE_TIME_MINUTES

static final int TYPE_TIME_MINUTES

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

See Also:

Constant Field Values

TYPE_TIME_SECONDS

static final int TYPE_TIME_SECONDS

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

See Also:

Constant Field Values

TYPE_TIME_UNDEFINED

static final int TYPE_TIME_UNDEFINED

The name of the level whose type is time, but undefined, 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 level whose type is unknown, as well as the return value for the getType method.

See Also:

Constant Field Values

Method Detail

getCube

CubeInterface getCube()
                      throws OLAPException

Returns the cube to which the hierarchy belongs.

Returns:

The cube to which the hierarchy belongs.

Throws:

OLAPException - if a database error occurs

getHierarchy

HierarchyInterface getHierarchy()
                                throws OLAPException

Returns the hierarchy that this level is a child of.

Returns:

The hierarchy that parents this level.

Throws:

OLAPException - if a database error occurs

getType

int getType()
            throws OLAPException

Returns the type of the level. TYPE_REGULAR, TYPE_ALL, TYPE_CALCULATED, TYPE_TIME, TYPE_TIME_YEARS, TYPE_TIME_HALF_YEAR, TYPE_TIME_QUARTERS, TYPE_TIME_MONTHS, TYPE_TIME_WEEKS, TYPE_TIME_DAYS, TYPE_TIME_HOURS TYPE_TIME_MINUTES, TYPE_TIME_SECONDS, TYPE_TIME_UNDEFINED, TYPE_UNKNOWN

Returns:

The type of the level.

Throws:

OLAPException - if a database error occurs

getDepth

int getDepth()
             throws OLAPException

Returns the distance of the level from the root of the hierarchy. The root level is zero.

Returns:

The distance of the level from the root of the hierarchy

Throws:

OLAPException - if a database error occurs

getMemberCount

int getMemberCount()
                   throws OLAPException

Returns the number of members associated with the level.

Returns:

The number of members.

Throws:

OLAPException - if a database error occurs

getMembers

MemberInterface[] getMembers(int index,
                             int count)
                             throws OLAPException

Returns the members associated with a given range of indices.

Parameters:

index - A zero-based member index (0 to getMemberCount()-1).

count - The number of members to return.

Returns:

An array whose first element is the member associated with index, whose second element is the member associated with index+1, and so on such that array[array.length-1] is the member associated with index+count-1.

Throws:

OLAPException - if a database error occurs

getMembers

MemberInterface[] getMembers()
                             throws OLAPException

Returns the members associated with this level.

Returns:

An array of members associated with this level.

Throws:

OLAPException - if a database error occurs

getProperties

PropertyInterface[] getProperties()
                                  throws OLAPException

Returns the properties associated with this level.

Returns:

An array of properties associated with this level.

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 LevelInterface. The filter object may be applied explicitly via the MetadataInterface, or it may be created implicitly via a getLevels() method.

Returns:

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

Throws:

OLAPException - if a database error occurs