AGGMAPINFO

The AGGMAPINFO function returns information about the specification of an aggmap object in your analytic workspace.

You can get information about an aggregation specification (that is, an aggmap object with a map type of AGGMAP) only after it has been compiled. You can compile an aggregation specification using a COMPILE statement or by including the FUNCDATA keyword when you execute the AGGREGATE command. When an aggregation specification has not been compiled before you use it with the AGGMAPINFO function, then it is compiled by AGGMAPINFO. You do not need to compile an aggmap for use with ALLOCATE.

Return Value

Varies depending on the type of information that is requested. See Table 7-1, "Keywords for the choice Parameter of the AGGMAPINFO function" for more information.

Syntax

AGGMAPINFO (name {choice | {choice-at-position rel-pos} })

Arguments

name: The name of the aggmap object.
choice: Specifies the type of information that you want returned. See Table 7-1, "Keywords for the choice Parameter of the AGGMAPINFO function", for details.

Table 7-1 Keywords for the choice Parameter of the AGGMAPINFO function

Keyword	Data Type	Description
ADDED_MODELS	`TEXT`	The models that are currently added to an aggmap using AGGMAP ADD or REMOVE model statements.The names of the models are returned as a multi-line text string.
AGGINDEX	`BOOLEAN`	Indicates the setting for the AGGINDEX statement in the aggmap. A `YES` setting specifies that all possible indexes (composite tuples) are created whenever the aggmap is recompiled. (Applies to AGGMAP type aggmaps only.)
CHILDREN member-name	`TEXT`	The dimension members used in the right-hand side of equations used to calculate temporary calculated members added using MAINTAIN ADD SESSION statements. The names of the members are returned as a multi-line text string.
CUSTOMMEMBERS	`TEXT`	The members added using MAINTAIN ADD SESSION statements. The names of the members are returned as a multi-line text string.
DIMENSION	`TEXT`	The names of the dimensions of the models or relations used by the aggmap. The names of the members are returned as a multi-line text string.
FCACHE	`BOOLEAN`	Indicates whether Oracle OLAP has a cache for the AGGREGATE function. (Applies to AGGMAP type aggmaps only.)
MAPTYPE	`TEXT`	The type of the aggmap. Returns AGGMAP for an aggregation specification (that is, when the specification has been entered with an AGGMAP statement). You can use this type of aggmap only with the AGGREGATE command or AGGREGATE function. Returns ALLOCMAP for an allocation specification (that is, when the specification has been entered with an ALLOCMAP statement). You can use this type of aggmap only with ALLOCATE. Returns `NA` when the aggmap has been defined but a specification has not been entered with an AGGMAP or ALLOCMAP statement.
MODELS	`TEXT`	The models in the aggmap. The names of the models are returned as a multi-line text string.
NUMRELS	`INTEGER`	The total number of RELATION (for aggregation) statements in an aggmap specification.
RELATIONS	`TEXT`	The name of relation that is specified by a RELATION (for aggregation) statement in the aggmap object. Each statement is displayed on a separate line.
STORE	`BOOLEAN`	Indicates whether the CACHE statement in the aggmap is set to STORE. A `YES` setting specifies that the data that is calculated on the fly is stored in the cache. (Applies to AGGMAP type aggmaps only.)
VARIABLES	`TEXT`	The variables for which this aggmap object has been specified as the default aggmap using AGGMAP ADD or REMOVE model statements or the $AGGMAP property. The names of the variables are returned as a multi-line text string.

choice-at-position

Specifies the exactly which piece of information you want returned.

PRECOMPUTE returns the text of the limit-clause that follows the PRECOMPUTE keyword in a RELATION statement. You must use the rel-pos argument to specify a single RELATION statement. Returns NA when the RELATION statement does not have a PRECOMPUTE keyword. (Applies to AGGMAP type aggmaps only.)

RELATION returns the name of the relation that follows the RELATION statement that you specify with the rel-pos argument.

STATUS returns the status list that results from the compilation of the PRECOMPUTE clause in the RELATION statement that you specify with the rel-pos argument. (Applies to AGGMAP type aggmaps only.)

rel-pos

An INTEGER that specifies a RELATION statement in the aggmap. The INTEGER indicates the position of the statement in the list of RELATION statements. You can use the rel-pos argument only with the RELATION, PRECOMPUTE, or STATUS keywords. For example, to get information about the first RELATION statement in an aggmap, use an INTEGER with a value of 1 as the rel-pos argument. To get information about the fourth RELATION statement in an aggmap, use the INTEGER 4, and so on. You may use any INTEGER between 1 and the total number of RELATION statements in an aggmap specification. You can use the NUMRELS keyword to obtain the total number of RELATION statements for an aggmap object.

Examples

Example 7-1 Retrieving Information About an Aggmap Object

Suppose an aggmap named sales.agg has been defined with the following statement.

DEFINE sales.agg AGGMAP <time, product, geography>

Suppose the following specification has been added to sales.agg with an AGGMAP statement.

AGGMAP
RELATION time.r PRECOMPUTE (time ne 'Year98')
RELATION product.r
RELATION geography.r
CACHE STORE
END

Once a specification has been added to the aggmap, you can use AGGMAPINFO to get information about its specification.

To see the names of the hierarchies that are specified by the RELATION statements, use the following statement.

SHOW AGGMAPINFO(sales.agg RELATIONS)

The following results are displayed.

time.r
product.r
geography.r

The following statement and result tell you how many RELATION statements are in the aggmap object.

SHOW AGGMAPINFO(sales.agg NUMRELS)
3

The following statement and result verifies that data that is calculated on the fly is stored in the cache for the session. The result is YES because the aggmap contains a CACHE STORE statement.

show AGGMAPINFO(sales.agg STORE)
YES

The following statement displays the relation name that is specified in the second RELATION statement in the aggmap.

SHOW AGGMAPINFO(sales.agg RELATION 2)
product.r

The following statement displays the limit-clause that follows the PRECOMPUTE keyword in the first RELATION statement in the aggmap.

SHOW AGGMAPINFO(sales.agg PRECOMPUTE 1)
time NE 'YEAR98'

Suppose the time dimension values are Jan98 to Dec99, Year98, and Year99. The following statement displays the status list for the dimension in the first RELATION statement in the aggmap.

SHOW AGGMAPINFO(sales.agg STATUS 1)
Jan98 TO Dec99, Year99

Because the limit-clause in the RELATION statement specifies that the time dimension values should not equal Year98, all time dimension values other than Year98 are included in its status.

The following statement displays the aggmap type of sales.agg.

SHOW AGGMAPINFO(sales.agg MAPTYPE)
AGGMAP