Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.metadataManager.common
Class MDDimension

java.lang.Object
  |
  +--oracle.dss.metadataUtil.PropertyBag
        |
        +--oracle.dss.metadataManager.common.MDObject
              |
              +--oracle.dss.metadataManager.common.MDFolder
                    |
                    +--oracle.dss.metadataManager.common.MDDimension
All Implemented Interfaces:
BIContext, javax.naming.Context, javax.naming.directory.DirContext, java.io.Serializable

public class MDDimension
extends MDFolder

A client-side representation of a dimension in an analytic workspace. An MDDimension provides, to a java client, information about a dimension in the workspace.

An OLAP dimension is a structure that categorizes data. For example, in analyzing Sales data, typical dimensions would be Product, Time, and Geography.

As an MDFolder, an MDDimension can contain other MDObjects. An MDDimension can contain MDAttribute objects and MDHierarchy objects.

See Also:
MDAttribute, MDHierarchy, Serialized Form

Fields inherited from interface javax.naming.directory.DirContext
ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE

 

Fields inherited from interface javax.naming.Context
APPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES

 

Method Summary
 MDAttribute[] getAttributes()
          Retrieves the MDAttribute objects that have been defined for this MDDimension.
 java.lang.String getDataType()
          Retrieves the data type for this MDDimension.
 MDHierarchy getDefaultHierarchy()
          Retrieves the default hierarchy for this MDDimension object.
 MDAttribute getEndDate()
          Retrieves endDate attribute for this MDDimension object.
 MDFolder getFolder()
          Retrieves the folder that contains this MDDimension.
 MDFolder[] getFolders()
          Retrieves the MDFolder objects that this this MDDimension uses.
 MDHierarchy[] getHierarchies()
          Retrieves the MDHierarchy objects that have been defined for this MDDimension.
 java.lang.String getLongPluralLabel()
          Retrieves the long plural label for this MDDimension.
 MDMeasure[] getMeasures()
          Retrieves the MDMeasure objects that are dimensioned by this MDDimension.
 MDMemberMetadata getMemberLongLabelMetadata()
          Retrieves the long labels of the members of this MDDimension object.
 MDMemberMetadata getMemberShortLabelMetadata()
          Retrieves the short labels of the members of this MDDimension object.
 java.lang.String getShortPluralLabel()
          Retrieves the short plural label for this MDDimension.
 MDAttribute getTimeSpan()
          Retrieves timeSpan attribute for this MDDimension object.
 boolean isTimeDimension()
          Determine if the dimension is a Time dimension.

 

Methods inherited from class oracle.dss.metadataManager.common.MDFolder
addToEnvironment, bind, bind, bind, bind, close, composeName, composeName, copy, copy, createSubcontext, createSubcontext, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getAcl, getAttributes, getAttributes, getAttributes, getAttributes, getDimensions, getEnvironment, getErrorHandler, getLocale, getNameParser, getNameParser, getSelections, list, list, listBindings, listBindings, lookup, lookup, lookup, lookup, lookup, lookup, lookup, lookup, lookupLink, lookupLink, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, move, move, rebind, rebind, rebind, rebind, removeFromEnvironment, rename, rename, search, search, search, search, search, search, setFolders, setLocale, unbind, unbind

 

Methods inherited from class oracle.dss.metadataManager.common.MDObject
getClassName, getDescription, getDriverType, getDriverTypes, getLabel, getLongLabel, getMetadataManagerServices, getName, getObjectType, getPath, getShortLabel, getSubObjectType, getUniqueID, nameEquals, setClassName, setDriverType, setMetadataManagerServices, setName, setObjectType, setSubObjectType, toString, toString

 

Methods inherited from class oracle.dss.metadataUtil.PropertyBag
getIntPropertyValue, getLongPropertyValue, getObjPropertyValue, getPropertyDataType, getStringVectorPropertyValue, getStrPropertyValue, mergePropertyBags, removeProperty, setIntPropertyValue, setIntPropertyValue, setLongPropertyValue, setLongPropertyValue, setObjPropertyValue, setObjPropertyValue, setProperty, setPropertyBag, setStringVectorPropertyValue, setStringVectorPropertyValue, setStrPropertyValue, setStrPropertyValue, size

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Methods inherited from interface oracle.dss.bicontext.BIContext
refresh

 

Methods inherited from interface javax.naming.directory.DirContext
getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, search, search, search, search

 

Methods inherited from interface javax.naming.Context
getNameInNamespace

 

Method Detail

getFolder

public MDFolder getFolder()
                   throws MetadataManagerException
Retrieves the folder that contains this MDDimension.
Returns:
The folder that contains this MDDimension.
Throws:
MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getFolders

public MDFolder[] getFolders()
                      throws MetadataManagerException
Retrieves the MDFolder objects that this this MDDimension uses.
Overrides:
getFolders in class MDFolder
Returns:
The folders that this dimension uses.
Throws:
MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getMeasures

public MDMeasure[] getMeasures()
                        throws MetadataManagerException
Retrieves the MDMeasure objects that are dimensioned by this MDDimension.
Overrides:
getMeasures in class MDFolder
Returns:
The measures that are dimensioned by this dimension.
Throws:
MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getAttributes

public MDAttribute[] getAttributes()
                            throws MetadataManagerException
Retrieves the MDAttribute objects that have been defined for this MDDimension.
Returns:
The attributes for this dimension.
Throws:
MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getHierarchies

public MDHierarchy[] getHierarchies()
                             throws MetadataManagerException
Retrieves the MDHierarchy objects that have been defined for this MDDimension.
Returns:
The hierarchies that are defined for this dimension.
Throws:
MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getDefaultHierarchy

public MDHierarchy getDefaultHierarchy()
                                throws MetadataManagerException
Retrieves the default hierarchy for this MDDimension object.
Returns:
The MDHierarchy that represents default hierarchy for this dimension.
Throws:
MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getMemberShortLabelMetadata

public MDMemberMetadata getMemberShortLabelMetadata()
                                             throws MetadataManagerException
Retrieves the short labels of the members of this MDDimension object.
Returns:
The metadata that contains the short labels of the members.
Throws:
MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getMemberLongLabelMetadata

public MDMemberMetadata getMemberLongLabelMetadata()
                                            throws MetadataManagerException
Retrieves the long labels of the members of this MDDimension object.
Returns:
The metadata that contains the long labels of the members.
Throws:
MetadataManagerException - If the connection fails during the execution of this method or if there is a problem retrieving objects from the server.

getShortPluralLabel

public java.lang.String getShortPluralLabel()
Retrieves the short plural label for this MDDimension.
Returns:
The short plural label, such as "Products".

getLongPluralLabel

public java.lang.String getLongPluralLabel()
Retrieves the long plural label for this MDDimension.
Returns:
The long plural label, such as "Products in Inventory".

getDataType

public java.lang.String getDataType()
Retrieves the data type for this MDDimension.
Returns:
A constant that represents the data type. The valid constants are listed in the See Also section.
See Also:
MM.BOOLEAN, MM.SHORT, MM.INTEGER, MM.LONG, MM.FLOAT, MM.DOUBLE, MM.STRING

isTimeDimension

public boolean isTimeDimension()
Determine if the dimension is a Time dimension.
Returns:
true if the dimension is a Time dimension, false otherwise.

getEndDate

public MDAttribute getEndDate()
                       throws MetadataManagerException
Retrieves endDate attribute for this MDDimension object.
Returns:
endDate attribute of the time dimension. Null is returned if this MDDimension is not a time dimension.

getTimeSpan

public MDAttribute getTimeSpan()
                        throws MetadataManagerException
Retrieves timeSpan attribute for this MDDimension object.
Returns:
timeSpan attribute of the time dimension. Null is returned if this MDDimension is not a time dimension.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.