com.sas.storage.olap
Interface MemberInterface

All Superinterfaces:

MetadataEntityInterface

All Known Implementing Classes:

Member

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

Represents a member in a multidimensional cube. The member is the core element that is surfaced by the OLAP metadata interfaces. It's cardinality can be very high, so it stradles the line between metadata and data; however, this interface is in fact part of the MetadataInterfaces and is treated as such. In addition to the basic information about the member itself, the parent and child interfaces can also be retrieved directly from the MemberInterface. The getLevel() method returns the LevelInterface which parents this member, and the properties associated with a given member can be retrieved via the getProperties() methods. The member may also be bound to an instance of the MetadataInterface, which is accessible from the getMetadata() method.

See Also:

MetadataInterface, LevelInterface, PropertyInterface

Field Summary

static int	TYPE_ALL The name of the member whose type is all, as well as the return value for the getType method.
static int	TYPE_FORMULA The name of the member whose type is a formula, as well as the return value for the getType method.
static int	TYPE_MEASURE The name of the member whose type is a measure, as well as the return value for the getType method.
static int	TYPE_REGULAR The name of the member whose type is regular, as well as the return value for the getType method.
static int	TYPE_UNSPECIFIED The name of the member whose type is regular, as well as the return value for the getType method.

Method Summary

abstract int	getChildCount() Returns the number of children for this member.
abstract MemberInterface[]	getChildren() Returns the children members of this member.
abstract CubeInterface	getCube() Returns the name of the cube to which the measure belongs.
abstract DimensionInterface	getDimension() Returns the Dimension that this member is a child of.
abstract Filter	getFilter() Returns a copy of the Filter object that was used to obtain this MemberInterface.
abstract LevelInterface	getLevel() Returns the level that this member is a child of.
abstract MemberInterface	getParentMember() Returns the parent member
abstract PropertyInterface[]	getProperties() Returns the properties associated with this member.
abstract int	getType() Returns the type of the member.

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

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

Field Detail

TYPE_UNSPECIFIED

static final int TYPE_UNSPECIFIED

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

See Also:

Constant Field Values

TYPE_REGULAR

static final int TYPE_REGULAR

The name of the member whose type is regular, 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 member whose type is all, as well as the return value for the getType method.

See Also:

Constant Field Values

TYPE_FORMULA

static final int TYPE_FORMULA

The name of the member whose type is a formula, 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 member whose type is a measure, as well as the return value for the getType method.

See Also:

Constant Field Values

Method Detail

getCube

CubeInterface getCube()
                      throws OLAPException

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

Returns:

The name of the cube to which the measure belongs.

Throws:

OLAPException - if a database error occurs

getType

int getType()
            throws OLAPException

Returns the type of the member. TYPE_REGULAR, TYPE_ALL, TYPE_FORMULA, TYPE_MEASURE, TYPE_UNKNOWN

Returns:

The name of the type of the member.

Throws:

OLAPException - if a database error occurs

getLevel

LevelInterface getLevel()
                        throws OLAPException

Returns the level that this member is a child of.

Returns:

The level that parents this member.

Throws:

OLAPException - if a database error occurs

getDimension

DimensionInterface getDimension()
                                throws OLAPException

Returns the Dimension that this member is a child of.

Returns:

The dimension that parents this member.

Throws:

OLAPException - if a database error occurs

getProperties

PropertyInterface[] getProperties()
                                  throws OLAPException

Returns the properties associated with this member.

Returns:

An array of properties associated with this member.

Throws:

OLAPException - if a database error occurs

getChildCount

int getChildCount()
                  throws OLAPException

Returns the number of children for this member.

Returns:

The number of children for this member.

Throws:

OLAPException - if a database error occurs

getChildren

MemberInterface[] getChildren()
                              throws OLAPException

Returns the children members of this member.

Returns:

The children for this member.

Throws:

OLAPException - if a database error occurs

getParentMember

MemberInterface getParentMember()
                                throws OLAPException

Returns the parent member

Returns:

The parent member

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

Returns:

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

Throws:

OLAPException - if a database error occurs