com.sas.storage.olap.sasmdx
Class Level

com.sas.storage.olap.sasmdx.Level

All Implemented Interfaces:

LevelInterface, MetadataEntityInterface

public class Level
implements LevelInterface

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

TYPE_ALL, TYPE_CALCULATED, TYPE_REGULAR, TYPE_TIME, TYPE_TIME_DAYS, TYPE_TIME_HALF_YEAR, TYPE_TIME_HOURS, TYPE_TIME_MINUTES, TYPE_TIME_MONTHS, TYPE_TIME_QUARTERS, TYPE_TIME_SECONDS, TYPE_TIME_UNDEFINED, TYPE_TIME_WEEKS, TYPE_TIME_YEARS, TYPE_UNKNOWN

Constructor Summary

Level(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 name, java.lang.String uniqueName, java.lang.String label, int type, int memberCount, int depth, java.lang.String description)

Method Summary

java.util.Date	getCreationDateTime() This method is not supported
CubeInterface	getCube() Get this level's cube
int	getDepth() Get the depth of this level
java.lang.String	getDescription() Return the description of level
Filter	getFilter() Get the Filter with the properties used to create this object
HierarchyInterface	getHierarchy() Get the hierarchy that this level belongs to
java.lang.String	getLabel() Get the label/caption for this metadata object
int	getMemberCount() Get the number of members for this hierarchy
MemberInterface[]	getMembers() Get all the members for this level
MemberInterface[]	getMembers(int index, int count) Get the count number of members beginning at the index
MetadataInterface	getMetadata() Returns the metadataSession for this hierarchy.
java.lang.String	getName() Get the Name of this object
PropertyInterface[]	getProperties() Get the properties associated with this level
int	getType() Get the type of the level
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

Level

public Level(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 name,
             java.lang.String uniqueName,
             java.lang.String label,
             int type,
             int memberCount,
             int depth,
             java.lang.String description)
      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 level

Specified by:

getDescription in interface MetadataEntityInterface

Returns:

description of level

Throws:

OLAPException

getHierarchy

public HierarchyInterface getHierarchy()
                                throws OLAPException

Get the hierarchy that this level belongs to

Specified by:

getHierarchy in interface LevelInterface

Returns:

hierarchy object

Throws:

OLAPException - if a database error occurs

getMemberCount

public int getMemberCount()
                   throws OLAPException

Get the number of members for this hierarchy

Specified by:

getMemberCount in interface LevelInterface

Returns:

number of members

Throws:

OLAPException - if a database error occurs

getType

public int getType()
            throws OLAPException

Get the type of the level

Specified by:

getType in interface LevelInterface

Returns:

the type of level

Throws:

OLAPException - if a database error occurs

See Also:

LevelInterface

getDepth

public int getDepth()
             throws OLAPException

Get the depth of this level

Specified by:

getDepth in interface LevelInterface

Returns:

the depth of the level

Throws:

OLAPException - if a database error occurs

getMembers

public MemberInterface[] getMembers()
                             throws OLAPException

Get all the members for this level

Specified by:

getMembers in interface LevelInterface

Returns:

the members

Throws:

OLAPException - if a database error occurs

getMembers

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

Get the count number of members beginning at the index

Specified by:

getMembers in interface LevelInterface

Parameters:

index - start index

count - number of members

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

getProperties

public PropertyInterface[] getProperties()
                                  throws OLAPException

Get the properties associated with this level

Specified by:

getProperties in interface LevelInterface

Returns:

an array of properties

Throws:

OLAPException - if a database error occurs

getFilter

public Filter getFilter()
                 throws OLAPException

Get the Filter with the properties used to create this object

Specified by:

getFilter in interface LevelInterface

Returns:

filter that can be queried for this level's properties

Throws:

OLAPException - if a database error occurs

getCube

public CubeInterface getCube()
                      throws OLAPException

Get this level's cube

Specified by:

getCube in interface LevelInterface

Returns:

cube for this level

Throws:

OLAPException - if a database error occurs

getMetadata

public MetadataInterface getMetadata()
                              throws OLAPException

Returns the metadataSession for this hierarchy.

Specified by:

getMetadata in interface MetadataEntityInterface

Returns:

The metadata object associated with this cube.

Throws:

OLAPException - if a database error occurs

See Also:

LevelInterface

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

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