com.sas.storage.olap.sasmdx
Class Dimension

com.sas.storage.olap.sasmdx.Dimension

All Implemented Interfaces:

DimensionInterface, MetadataEntityInterface

@SASScope(value="ALL")
public class Dimension
implements DimensionInterface

Contains the client side implementation for com.sas.storage.olap.DimensionInterface. 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.DimensionInterface

TYPE_MEASURE, TYPE_OTHER, TYPE_TIME, TYPE_UNKNOWN

Constructor Summary

Dimension(MetadataInterface metadata, com.sas.iom.SASMDX.ISession _session, java.lang.String catalogName, java.lang.String schemaName, java.lang.String cubeName, java.lang.String name, java.lang.String uniqueName, java.lang.String label, int type, int nMems, java.lang.String defaultHier, java.lang.String description)

Method Summary

java.util.Date	getCreationDateTime() This method is not supported
CubeInterface	getCube() Get the dimension's cube object
HierarchyInterface	getDefaultHierarchy() Get the default hierarchy for this dimension
java.lang.String	getDescription() Return the description of dimension
Filter	getFilter() A filter object containing information used in creating this dimension.
HierarchyInterface[]	getHierarchies() Get the hierarchies belonging to this dimension
java.lang.String	getLabel() Get the label of this dimension
int	getMemberCount() Get the number of member that belongs to this dimension
MemberInterface[]	getMembers() Get the member's belonging to the dimension
MetadataInterface	getMetadata() Returns the metadata for this dimension.
java.lang.String	getName() Get the name of this dimension
int	getType() Get the type of dimension at DimensionInterface
java.lang.String	getUniqueName() Get the unique name of this diemsnion
java.util.Date	getUpdateDateTime() this information is not supported

Constructor Detail

Dimension

public Dimension(MetadataInterface metadata,
                 com.sas.iom.SASMDX.ISession _session,
                 java.lang.String catalogName,
                 java.lang.String schemaName,
                 java.lang.String cubeName,
                 java.lang.String name,
                 java.lang.String uniqueName,
                 java.lang.String label,
                 int type,
                 int nMems,
                 java.lang.String defaultHier,
                 java.lang.String description)
          throws OLAPException

Throws:

OLAPException

Method Detail

getName

public java.lang.String getName()
                         throws OLAPException

Get the name of this dimension

Specified by:

getName in interface MetadataEntityInterface

Returns:

name of the dimension

Throws:

OLAPException

getLabel

public java.lang.String getLabel()
                          throws OLAPException

Get the label of this dimension

Specified by:

getLabel in interface MetadataEntityInterface

Returns:

the label of this dimension

Throws:

OLAPException

getUniqueName

public java.lang.String getUniqueName()
                               throws OLAPException

Get the unique name of this diemsnion

Specified by:

getUniqueName in interface MetadataEntityInterface

Returns:

unqiue dimension name

Throws:

OLAPException

getDescription

public java.lang.String getDescription()
                                throws OLAPException

Return the description of dimension

Specified by:

getDescription in interface MetadataEntityInterface

Returns:

description of dimension

Throws:

OLAPException

getCube

public CubeInterface getCube()
                      throws OLAPException

Get the dimension's cube object

Specified by:

getCube in interface DimensionInterface

Returns:

Cube dimension's cube

Throws:

OLAPException - if a database error occurs

getMembers

public MemberInterface[] getMembers()
                             throws OLAPException

Get the member's belonging to the dimension

Specified by:

getMembers in interface DimensionInterface

Returns:

an array of member's dimension

Throws:

OLAPException - if the database error occurs

getType

public int getType()
            throws OLAPException

Get the type of dimension at DimensionInterface

Specified by:

getType in interface DimensionInterface

Returns:

dimension type

Throws:

OLAPException - if a database error occurs

getMemberCount

public int getMemberCount()
                   throws OLAPException

Get the number of member that belongs to this dimension

Specified by:

getMemberCount in interface DimensionInterface

Returns:

number of memebrs that belong to this dimension

Throws:

OLAPException - if a database error occurs

getDefaultHierarchy

public HierarchyInterface getDefaultHierarchy()
                                       throws OLAPException

Get the default hierarchy for this dimension

Specified by:

getDefaultHierarchy in interface DimensionInterface

Returns:

the default heirarchy for this dimension

Throws:

OLAPException - if a database error occurs

getHierarchies

public HierarchyInterface[] getHierarchies()
                                    throws OLAPException

Get the hierarchies belonging to this dimension

Specified by:

getHierarchies in interface DimensionInterface

Returns:

an array of hierarcies

Throws:

OLAPException - if a database error occurs

getFilter

public Filter getFilter()
                 throws OLAPException

A filter object containing information used in creating this dimension. This is not the same filter used to request the dimension information instead it is created with the information returned from the server.

Specified by:

getFilter in interface DimensionInterface

Returns:

filter object

Throws:

OLAPException - if a database error occurs

getMetadata

public MetadataInterface getMetadata()
                              throws OLAPException

Returns the metadata for this dimension.

Specified by:

getMetadata in interface MetadataEntityInterface

Returns:

The metadata object associated with this cube.

Throws:

OLAPException - if a database error occurs

See Also:

DimensionInterface

getCreationDateTime

public java.util.Date getCreationDateTime()
                                   throws OLAPException

This method is not supported

Specified by:

getCreationDateTime in interface MetadataEntityInterface

Returns:

Date time when the object was created

Throws:

OLAPException

getUpdateDateTime

public java.util.Date getUpdateDateTime()
                                 throws OLAPException

this information is not supported

Specified by:

getUpdateDateTime in interface MetadataEntityInterface

Returns:

last update/modified date time of this object

Throws:

OLAPException