OBJORG

The OBJORG function takes, as input, the name of an OLAP cube or cube dimension as defined in the Oracle data dictionary (sometimes called a "logical OLAP object") and returns information about the lower-level, "physical," analytic workspace objects by which that cube or cube dimension is implemented.

Use this function in OLAP DML statements that require an analytic workspace object name rather than an OLAP cube or cube dimension name.

Return value

Analytic workspace object name or TEXT; or NA if an analytic workspace has the requested definition information, but the field is empty.

Syntax

OBJORG(keyword [OWNER owner ] top-level-object-name [ sub-object-name ] )

Parameters

keyword

The valid keywords vary by the type of top-level-object or sub-object specified, as documented in:

• Table 8-3, "Keywords when the top-level-object is a Cube".

• Table 8-4, "Keywords when the top-level-object is a Cube and the sub-object is a Measure".

• Table 8-5, "Keywords when the top-level-object is Cube and the sub-object is a Dimension Calculation Model".

• Table 8-6, "Keywords when the top-level-object is a Cube Dimension".

• Table 8-7, "Keywords when the top-level-object is a Cube Dimension and the sub-object is a Base Attribute".

• Table 8-8, "Keywords when the top-level-object is a Cube Dimension and the sub-object is a Dimension Level".

• Table 8-9, "Keywords when the top-level-object is a Cube Dimension and the sub-object is a Dimension Calculation Model".

Table 8-3 Keywords when the top-level-object is a Cube

Keyword	Returns
Aggmap	The aggmap for the cube. (Note: The function will never return NA when you specify this keyword.)
Composite	When a composite is used for the cube, the name of the composite; or NA if the cube's sparsity type is DENSE, or if the cube is partitioned. (See also the keyword PartitionComposite.)
CubeStorageType	(Property.) The DML data type used for all of the cube's measures; or NA if there is no such single data type (that is, if different measures have different data types).
MeasureDim	When the value returned for the keyword CubeStorageType is not NA, the analytic workspace measure dimension used to refer to the cube's base measures; or NA when the value returned for the keyword CubeStorageType is NA.
PartitionCompositeVar	The text variable, dimensioned by PartitionDim, that holds the names of the composites for the cube's partitions; or NA if the cube's sparsity type is DENSE, or if the cube is not partitioned. (See also, the Composite keyword.)
PartitionDim	The analytic workspace dimension that contains the names of the partitions for the cube; or NA if the cube is not partitioned.
PartitionRel	The relation, dimensioned by PartitionDim, that relates each cube partition to its corresponding root dimension value; or NA if the cube is not partitioned.
PartitionTemplate	The partition template relating each cube partition to its corresponding analytic workspace dimension values; or NA if the cube is not partitioned.
SharedMeasureVar	When the cube has a storage type, the variable (of that type) that stores all of the cube's measures; or NA when it does not.
SparseType	(Property.) The cube sparsity type. Valid values are: COMPRESSED, SPARSE, DENSE, or SPARSE_GLOBAL. Corresponds to column SPARSE_TYPE in the USER_CUBES and ALL_CUBES views.

Table 8-4 Keywords when the top-level-object is a Cube and the sub-object is a Measure

Keyword	Returns
Measure	When the value returned when you specify the CubeStorageType keyword for a cube is NA, the variable that stores this measure; or when not NA, the formula extracting this measure from the cube's top level variable.
OverrideAggMap	The aggmap for the measure, if the measure has one; otherwise returns NA. (Note that when the measure has no aggmap, then the cube's aggmap is used.)

Table 8-5 Keywords when the top-level-object is Cube and the sub-object is a Dimension Calculation Model

Keyword	Returns
AggFloorValueSet	If the cube's consistent solve specification specifies an aggregation at a specific level, the valueset consisting of all members of the dimension that belong to that level; otherwise, NA.
HierValueSet	The valueset containing the names of all hierarchies of the analytic workspace dimension over which the cube is aggregated. (Note that when you specify this keyword, the function never returns NA.)
OperVar	If at least one of the cube's measures has an OverrideAggMap, the variable, dimensioned by the cube's measure dimension, that contains the aggregation operator used for each measure for which an OverrideAggMap exists.; otherwise, NA.
PrecomputeValueSet	When the cube organization specifies a precompute condition, the valueset containing all members of the dimension that satisfy that condition; otherwise NA. (In particular, when the cube organization specifies a precompute percent, returns NA.)

Table 8-6 Keywords when the top-level-object is a Cube Dimension

Keyword	Returns
AggRel	The relation, dimensioned by Dim and HierDim, that relates each dimension value (in each hierarchy) to its parent dimension value (in that hierarchy). (Note that when you specify this keyword, the function never returns NA, even if the dimension has no hierarchies.)
AttributeCubeGIDRel	The relation, dimensioned by Dim, that relates each dimension value to its cube GID (including attribute columns) in ___AW_GID_DIMENSION. AttributeCubeGIDRel is the same as CubeGIDRel, except it includes attribute columns. (Note that when you specify this keyword, the function never returns NA.)
CubeGIDRel	The relation, dimensioned by Dim, that relates each dimension value to its cube GID in ___AW_GID_DIMENSION. When the dimension does not have a materialized view (MV), then CubeGIDRel is empty. The difference between a GID and a cube GID is that cube GIDs span all hierarchies. (Note that when you specify this keyword, the function never returns NA.)
Dim	The analytic workspace physical dimension corresponding to this logical dimension. (Note that when you specify this keyword, the function never returns NA.)
DimOrderVar	The variable, dimensioned by Dim and ___AW_ALL_LANGUAGES, that contains integers (for each dimension value, in each language) used for sorting. (Note that when you specify this keyword, the function never returns NA.)
FamilyRel	The relation, dimensioned by Dim, LevelDim, and HierDim, that relates each dimension value (in each level, in each hierarchy) to the dimension value (at that level, in that hierarchy), if any, of which it is a descendant. FamilyRel is similar to ParentRel, but it allows you to specify a level rather than automatically choosing the next level up. FamilyRel is similar to ValueFamilyRel, but used for level hierarchies. (Note that when you specify this keyword, the function never returns NA.)
GIDRel	The relation, dimensioned by Dim and HierDim, that relates each dimension value (in each hierarchy) to its GID, if any, in ___AW_GID_DIMENSION. (Note that when you specify this keyword, the function never returns NA.)
HierDim	The dimension containing all hierarchies for this dimension. (Note that when you specify this keyword, the function never returns NA.)
HierLevelValueSet	The valueset, dimensioned by HierDim, that (for each hierarchy) contains all levels (from the LevelDim) that belong to that hierarchy. (Note that when you specify this keyword, the function never returns NA.)
HierOrderVar	The variable, dimensioned by Dim, HierDim, and ___AW_ALL_LANGUAGES, that contains integers (for each dimension value, in each hierarchy, in each language) used for sorting. (Note that when you specify this keyword, the function never returns NA.)
InHierValueSet	The valueset, dimensioned by HierDim, that (for each hierarchy) contains all dimension values (contained in that hierarchy). (Note that when you specify this keyword, the function never returns NA, even if the dimension has no hierarchies.)
LevelDim	The dimension containing all levels for this dimension. (Note that when you specify this keyword, the function never returns NA, even if the dimension has no levels.)
LevelRel	The relation, dimensioned by the Dim, that relates each dimension value to a level in the LevelList. (Note that when you specify this keyword, the function never returns NA.)
MemberDepthRel	The relation, dimensioned by Dim and HierDim, that relates each dimension value (in each hierarchy) to its depth (if any) in ___AW_DEPTH_DIMENSION. (Note that when you specify this keyword, the function never returns NA.)
MemberSourceRel	The relation, dimensioned by Dim, that relates each dimension value to an element of ___AW_MEMBER_SOURCES. (Note that when you specify this keyword, the function never returns NA.)
ParentRel	The relation, dimensioned by Dim and HierDim, that relates each dimension value (in each hierarchy) to its parent dimension value (in that hierarchy). (Note that when you specify this keyword, the function never returns NA, even if the dimension has no hierarchies.)
ValueFamilyRel	The relation, dimensioned by Dim, ___AW_GID_DIMENSION, and HierDim, that relates each dimension value (for each GID, in each hierarchy) to the dimension value (with that GID, in that hierarchy), if any, of which it is a descendant. ValueFamilyRel is similar to FamilyRel, but used for value hierarchies. (Note that when you specify this keyword, the function never returns NA.)

Table 8-7 Keywords when the top-level-object is a Cube Dimension and the sub-object is a Base Attribute

Keyword	Returns
Attribute	The value returned varies depending on whether or not the dimension is indexed. When the dimension is not indexed, the (physical) variable, dimensioned by Dim corresponding to the attribute's dimension and used to hold this (logical) attribute. When the dimension is indexed, the (physical) relation, dimensioned by Dim corresponding to the attribute's dimension, that relates each dimension value to a corresponding value from AttributeDim. (Note that when you specify this keyword, the function never returns NA.)
AttributeDim	When the attribute is indexed, the dimension that stores all of the attributes values; otherwise NA.
HierUniqueKeyRel	When the attribute is a unique key attribute, the relation, dimensioned by Dim and HierDim corresponding to the attribute's dimension, that relates each analytic workspace dimension value (in each hierarchy) to a corresponding value from AttributeDim; otherwise, NA.
UniqueKeyRel	When the attribute is a unique key attribute (that is, indexed), the relation, dimensioned by Dim, that corresponds to the attribute's dimension, that relates each dimension value to a corresponding value from AttributeDim.; otherwise, NA.

Table 8-8 Keywords when the top-level-object is a Cube Dimension and the sub-object is a Dimension Level

Keyword	Returns
SurrogateDim	The surrogate for the owning dimension's Dim that contains only those dimension values contained in this dimension level. (Note that when you specify this keyword, the function never returns NA.)

Table 8-9 Keywords when the top-level-object is a Cube Dimension and the sub-object is a Dimension Calculation Model

Keyword	Returns
Model	The model corresponding to this dimension's calculation model. (Note that when you specify this keyword, the function never returns NA.)

OWNER owner

The owner of the cube or cube dimension identified by top-level-object. If you do not include this clause, the function uses the current owner.

top-level-object

A text expression that specifies the name of the cube or the cube dimension for which information is requested.

sub-object

A text expression that specifies the name of the "logical" OLAP sub-object, if any, for which information is requested. Valid values vary depending on whether the top-level-object is a cube or a cube dimension:

• When top-level-object is a cube, you can specify the name of a measure or dimensionality

• When top-level-object is a cube dimension, you can specify the name of a base attribute, hierarchy, dimension level, or dimension calculation model.

Examples

Examples of using OBJORG with various keyword appear in several sample OLAP DML programs described within this manual:

• For examples of using OBJORG with the Dim keyword, see the following sample OLAP DML programs:

  • ADD_L1_2 program in Example 9-5, "Adding Members to an OLAP Cube Dimension"

  • REMOVE_L2_1 program in Example 10-98, "Removing OLAP Cube Dimension Members From a Hierarchy"

  • SETUP_PRE_MODEL and SETUP_POST_MODEL programs in Example 10-118, "Creating Static and Dynamic Models for an OLAP Cube"

  • ADD_L1_2_DATES program in Example 10-169, "Updating the Attributes of an OLAP Cube Dimension"

• For an example of using OBJORG with the Measure keyword, see the ADD_L1_2 program in Example 9-5, "Adding Members to an OLAP Cube Dimension".

• For an example of using OBJORG with the Parentrel keyword, see the REMOVE_L2-1 program in Example 10-98, "Removing OLAP Cube Dimension Members From a Hierarchy".

• For examples of using OBJORG with the Attribute keyword, see the following sample programs:

  • SETUP_POST_MODEL program in Example 10-118, "Creating Static and Dynamic Models for an OLAP Cube"

  • ADD_L1_2_DATES program in Example 10-169, "Updating the Attributes of an OLAP Cube Dimension"