com.sas.storage.olap.sasmdx
Class Member

com.sas.storage.olap.sasmdx.Member

All Implemented Interfaces:

MemberInterface, MetadataEntityInterface

@SASScope(value="ALL")
public class Member
implements MemberInterface

Contains the client side implementation for com.sas.storage.olap.MemberInterface. This implementation uses the IOM/OLAP interfaces provided by the SAS OLAP server. There actually aren't any remote calls in this particular class. All remote metadata calls are made from within the MetadataInterface implementation.

Field Summary

Fields inherited from interface com.sas.storage.olap.MemberInterface

TYPE_ALL, TYPE_FORMULA, TYPE_MEASURE, TYPE_REGULAR, TYPE_UNSPECIFIED

Constructor Summary

Member(MetadataInterface metadata, com.sas.iom.SASMDX.ISession _session, java.lang.String catalogName, java.lang.String schemaName, java.lang.String cubeName, java.lang.String uniqueDimensionName, java.lang.String uniqueHierarchyName, java.lang.String uniqueLevelName, int levelDepth, java.lang.String name, java.lang.String uniqueName, java.lang.String label, int type, int childCount, java.lang.String parentMemberName, int propertyDataTypes, java.lang.String[] propertyNames)

Method Summary

int	getChildCount() Returns the number of children for this member.
MemberInterface[]	getChildren() Return children of this member.
java.util.Date	getCreationDateTime() Get the creation date of this object
CubeInterface	getCube() Returns the name of the cube to which the measure belongs.
java.lang.String	getDescription() Return the description of a member.
DimensionInterface	getDimension() Returns the Dimension that this member is a child of.
Filter	getFilter() Returns a copy of the Filter object that was used to obtain this MemberInterface.
java.lang.String	getLabel() Get the label/caption for this metadata object
LevelInterface	getLevel() Returns a level that this member belongs to.
MetadataInterface	getMetadata() Returns the metadataSession for this member.
java.lang.String	getName() Get the Name of this object
MemberInterface	getParentMember() Returns the parent member
PropertyInterface[]	getProperties() Returns the properties associated with this member.
int	getType() Returns the type of the member.
java.lang.String	getUniqueName() Get the Unique name of this object
java.util.Date	getUpdateDateTime() Get the last update/modified date time for this object

Constructor Detail

Member

public Member(MetadataInterface metadata,
              com.sas.iom.SASMDX.ISession _session,
              java.lang.String catalogName,
              java.lang.String schemaName,
              java.lang.String cubeName,
              java.lang.String uniqueDimensionName,
              java.lang.String uniqueHierarchyName,
              java.lang.String uniqueLevelName,
              int levelDepth,
              java.lang.String name,
              java.lang.String uniqueName,
              java.lang.String label,
              int type,
              int childCount,
              java.lang.String parentMemberName,
              int propertyDataTypes,
              java.lang.String[] propertyNames)
       throws OLAPException

Throws:

OLAPException

Method Detail

getName

public java.lang.String getName()
                         throws OLAPException

Description copied from interface: MetadataEntityInterface

Get the Name of this object

Specified by:

getName in interface MetadataEntityInterface

Returns:

Name of the metadata object

Throws:

OLAPException

getLabel

public java.lang.String getLabel()
                          throws OLAPException

Description copied from interface: MetadataEntityInterface

Get the label/caption for this metadata object

Specified by:

getLabel in interface MetadataEntityInterface

Returns:

label

Throws:

OLAPException

getUniqueName

public java.lang.String getUniqueName()
                               throws OLAPException

Description copied from interface: MetadataEntityInterface

Get the Unique name of this object

Specified by:

getUniqueName in interface MetadataEntityInterface

Returns:

unique name of the object

Throws:

OLAPException

getDescription

public java.lang.String getDescription()
                                throws OLAPException

Return the description of a member. This implementation returns caption/label

Specified by:

getDescription in interface MetadataEntityInterface

Returns:

description of member. Alias for getLabel()

Throws:

OLAPException

getLevel

public LevelInterface getLevel()
                        throws OLAPException

Returns a level that this member belongs to.

Specified by:

getLevel in interface MemberInterface

Returns:

The level that parents this member.

Throws:

OLAPException - if a database error occurs

getDimension

public DimensionInterface getDimension()
                                throws OLAPException

Description copied from interface: MemberInterface

Returns the Dimension that this member is a child of.

Specified by:

getDimension in interface MemberInterface

Returns:

The dimension that parents this member.

Throws:

OLAPException - if a database error occurs

getChildCount

public int getChildCount()
                  throws OLAPException

Description copied from interface: MemberInterface

Returns the number of children for this member.

Specified by:

getChildCount in interface MemberInterface

Returns:

The number of children for this member.

Throws:

OLAPException - if a database error occurs

getType

public int getType()
            throws OLAPException

Description copied from interface: MemberInterface

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

Specified by:

getType in interface MemberInterface

Returns:

The name of the type of the member.

Throws:

OLAPException - if a database error occurs

getProperties

public PropertyInterface[] getProperties()
                                  throws OLAPException

Description copied from interface: MemberInterface

Returns the properties associated with this member.

Specified by:

getProperties in interface MemberInterface

Returns:

An array of properties associated with this member.

Throws:

OLAPException - if a database error occurs

getParentMember

public MemberInterface getParentMember()
                                throws OLAPException

Description copied from interface: MemberInterface

Returns the parent member

Specified by:

getParentMember in interface MemberInterface

Returns:

The parent member

Throws:

OLAPException - if a database error occurs

getFilter

public Filter getFilter()
                 throws OLAPException

Description copied from interface: MemberInterface

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.

Specified by:

getFilter in interface MemberInterface

Returns:

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

Throws:

OLAPException - if a database error occurs

getMetadata

public MetadataInterface getMetadata()
                              throws OLAPException

Returns the metadataSession for this member.

Specified by:

getMetadata in interface MetadataEntityInterface

Returns:

The metadata object associated with this cube.

Throws:

OLAPException - if a database error occurs

See Also:

MemberInterface

getCreationDateTime

public java.util.Date getCreationDateTime()
                                   throws OLAPException

Description copied from interface: MetadataEntityInterface

Get the creation date of this object

Specified by:

getCreationDateTime in interface MetadataEntityInterface

Returns:

Date time when the object was created

Throws:

OLAPException

getUpdateDateTime

public java.util.Date getUpdateDateTime()
                                 throws OLAPException

Description copied from interface: MetadataEntityInterface

Get the last update/modified date time for this object

Specified by:

getUpdateDateTime in interface MetadataEntityInterface

Returns:

last update/modified date time of this object

Throws:

OLAPException

getCube

public CubeInterface getCube()
                      throws OLAPException

Description copied from interface: MemberInterface

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

Specified by:

getCube in interface MemberInterface

Returns:

The name of the cube to which the measure belongs.

Throws:

OLAPException - if a database error occurs

getChildren

public MemberInterface[] getChildren()
                              throws OLAPException

Return children of this member.

Specified by:

getChildren in interface MemberInterface

Returns:

an array of children for this member

Throws:

OLAPException - if a database error occurs