Skip navigation links

oracle.olapi.metadata.deployment
Class AWCubeOrganization

java.lang.Object
oracle.olapi.metadata.BaseMetadataObject
oracle.olapi.metadata.deployment.CubeOrganization
oracle.olapi.metadata.deployment.AWCubeOrganization

All Implemented Interfaces:

MetadataObject

public class AWCubeOrganization

extends CubeOrganization

A CubeOrganization for an analytic workspace. An AWCubeOrganization contains information about how the data for the measures of an MdmCube is organized by Oracle OLAP. It also contains the BuildSpecification objects that specify how Oracle OLAP builds the cube.

An application creates an AWCubeOrganization with the createAWOrganization method of the MdmCube.

You can specify a sparsity type for all of the dimensions of the cube by using the setSparseType method, or you can specify individual dimensions as sparse by using the addSparseDimension method.

For information on cube partitioning, sparsity types, and storage types, and the use of materialized views (MVs), see Oracle OLAP User's Guide.

Field Summary

static java.lang.String	COMPLETE_REFRESH_MV_OPTION A constant that represents the complete refresh option, which indicates that Oracle OLAP performs a complete refresh of the materialized views for the cube.
static java.lang.String	COMPRESSED_SPARSE_TYPE A constant that represents a compressed sparsity type, which indicates an extremely sparse cube.
static java.lang.String	CREATE_ET_VIEW_OPTION A constant that represents the create ET view option, which indicates that Oracle OLAP does create ET views.
static java.lang.String	DENSE_SPARSE_TYPE A constant that represents a dense sparsity type, which indicates a dense cube.
static java.lang.String	FAST_REFRESH_MV_OPTION A constant that represents the fast refresh option, which indicates that Oracle OLAP performs an incremental refresh of the materialized views for the cube based on changes to the relational sources, if possible.
static java.lang.String	GENERIC_NULL_STORAGE A constant that represents generic null storage, which indicates that Oracle OLAP does not distinguish between a true NA value and an NA value that exists because Oracle OLAP has not yet calculated the value.
static java.lang.String	INDEPENDENT_MEASURE_STORAGE A constant that represents independent measure storage, which indicates that Oracle OLAP stores the values of each of the measures of the cube in separate objects.
static java.lang.String	MV_READY_NULL_STORAGE A constant that represents materialized view ready null storage, which indicates that Oracle OLAP makes a distinction between a true NA value and an NA value that exists because Oracle OLAP has not yet calculated the value.
static java.lang.String	NONE_ET_VIEW_OPTION A constant that represents the none ET view option, which indicates that Oracle OLAP does not create ET views.
static java.lang.String	NONE_MV_OPTION A constant that represents the none option, which indicates that Oracle OLAP does not refresh materialized views or use them for rewriting queries.
static java.lang.String	REWRITE_MV_OPTION A constant that represents the rewrite option, which indicates that Oracle OLAP uses the rewrite materialized view for the cube.
static java.lang.String	SHARED_MEASURE_STORAGE A constant that represents shared measure storage, which indicates that Oracle OLAP stores the values of all of the measures of the cube in the same object.
static java.lang.String	SPARSE_GLOBAL_SPARSE_TYPE A constant that represents a sparse global sparsity type, which indicates a sparse cube that has partitions and that stores all of the partitioned data in a single object.
static java.lang.String	SPARSE_SPARSE_TYPE A constant that represents a sparse sparsity type, which indicates a sparse cube.
static java.lang.String[]	VALID_ET_VIEW_OPTIONS A constant that has the valid values for the ET view options.
static java.lang.String[]	VALID_MEASURE_STORAGE_TYPES A constant that has the valid values for the types of measure storage.
static java.lang.String[]	VALID_MV_OPTIONS A constant that has the valid values for materialized view options.
static java.lang.String[]	VALID_NULL_STORAGE_TYPES A constant that has the valid values for the types of storage of null values.
static java.lang.String[]	VALID_SPARSE_TYPES A constant that has the valid values for sparsity type.

Method Summary

void	addBuildSpecification(BuildSpecification spec) Adds a BuildSpecification to the list of those associated with this AWCubeOrganization.
MVCreationOptions	findOrCreateMVCreationOptions()
AW	getAW() Gets the analytic workspace associated with this AWCubeOrganization.
java.util.List<BuildSpecification>	getBuildSpecifications() Gets the BuildSpecification objects associated with this AWCubeOrganization.
java.lang.String	getCubeStorageType() Gets the data type for the shared measure storage.
BuildSpecification	getDefaultBuildSpecification() Gets the default BuildSpecification of this AWCubeOrganization.
java.lang.String	getETViewOption() Gets the ET view option for this AWCubeOrganization, which indicates whether Oracle OLAP creates ET views for the cube.
java.lang.String	getMeasureStorage() Gets the storage type of the measures of the cube that is associated with this AWCubeOrganization.
java.lang.String	getMVOption() Gets the materialized view option for the cube that is associated with this AWCubeOrganization.
java.lang.String	getNullStorage() Gets the null storage type of the measures of the cube that is associated with this AWCubeOrganization.
MdmHierarchyLevel	getPartitionLevel() Gets the dimension level that is the basis for the partitioning of the cube that is associated with this AWCubeOrganization.
SymmetricCondition	getPrecomputeCondition() Gets the SymmetricCondition that specifies the dimension members for which Oracle OLAP computes and stores aggregate measure values during a build or refresh operation.
int	getPrecomputePercent() Gets the percentage of the aggregate measure values for a compressed cube that Oracle OLAP computes and stores during a build or refresh operation.
int	getPrecomputePercentTop() Gets the percentage of the measure values for the top level of a hierarchy of a compressed and partitioned cube that Oracle OLAP computes and stores during a build or refresh operation.
java.lang.String	getSparseType() Gets the sparsity type of the cube that is associated with this AWCubeOrganization.
void	removeBuildSpecification(BuildSpecification spec) Removes a BuildSpecification from the list of those associated with this AWCubeOrganization.
void	setAW(AW aw) Sets the AW that the associated MdmCube will be create in
void	setCubeStorageType(java.lang.String exp) Specifies the data type for the shared measure storage for the cube that is associated with this AWCubeOrganization.
void	setDefaultBuildSpecification(BuildSpecification spec) Specifies a BuildSpecification to use as the default for this AWCubeOrganization.
void	setETViewOption(java.lang.String option) Specifies whether Oracle OLAP creates ET views for the cube.
void	setMeasureStorage(java.lang.String type) Specifies the measure storage type for the cube that is associated with this AWCubeOrganization.
void	setMVCreationOptions(MVCreationOptions mvCreationOptions)
void	setMVOption(java.lang.String option) Specifies the materialized view option for the cube that is associated with this AWCubeOrganization.
void	setNullStorage(java.lang.String type) Specifies the null storage type for the cube that is associated with this AWCubeOrganization.
void	setPartitionLevel(MdmHierarchyLevel level) Specifies the dimension level to use as the basis for the partitioning of the cube that is associated with this AWCubeOrganization.
void	setPrecomputeCondition(SymmetricCondition cond) Specifies a SymmetricCondition that identifies the dimension members for which Oracle OLAP computes and stores aggregate measure values during a build or refresh operation.
void	setPrecomputePercent(int val) Specifies the percentage of the aggregate measure values of a compressed cube for Oracle OLAP to compute and store during a build or refresh operation.
void	setPrecomputePercentTop(int val) Specifies the percentage of the measure values for the top level of a hierarchy for Oracle OLAP to compute and store during a build or refresh operation.
void	setSparseType(java.lang.String type) Specifies the sparsity type for the cube that is associated with this AWCubeOrganization.

Methods inherited from class oracle.olapi.metadata.deployment.CubeOrganization

addSparseDimension, getCube, getSparseDimensions, removeSparseDimension

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getID, getOwner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DENSE_SPARSE_TYPE

public static final java.lang.String DENSE_SPARSE_TYPE

A constant that represents a dense sparsity type, which indicates a dense cube.

See Also:

Constant Field Values

COMPRESSED_SPARSE_TYPE

public static final java.lang.String COMPRESSED_SPARSE_TYPE

A constant that represents a compressed sparsity type, which indicates an extremely sparse cube.

See Also:

Constant Field Values

SPARSE_SPARSE_TYPE

public static final java.lang.String SPARSE_SPARSE_TYPE

A constant that represents a sparse sparsity type, which indicates a sparse cube.

See Also:

Constant Field Values

SPARSE_GLOBAL_SPARSE_TYPE

public static final java.lang.String SPARSE_GLOBAL_SPARSE_TYPE

A constant that represents a sparse global sparsity type, which indicates a sparse cube that has partitions and that stores all of the partitioned data in a single object.

See Also:

Constant Field Values

VALID_SPARSE_TYPES

public static final java.lang.String[] VALID_SPARSE_TYPES

A constant that has the valid values for sparsity type.

NONE_MV_OPTION

public static final java.lang.String NONE_MV_OPTION

A constant that represents the none option, which indicates that Oracle OLAP does not refresh materialized views or use them for rewriting queries.

See Also:

Constant Field Values

COMPLETE_REFRESH_MV_OPTION

public static final java.lang.String COMPLETE_REFRESH_MV_OPTION

A constant that represents the complete refresh option, which indicates that Oracle OLAP performs a complete refresh of the materialized views for the cube.

See Also:

Constant Field Values

FAST_REFRESH_MV_OPTION

public static final java.lang.String FAST_REFRESH_MV_OPTION

A constant that represents the fast refresh option, which indicates that Oracle OLAP performs an incremental refresh of the materialized views for the cube based on changes to the relational sources, if possible.

See Also:

Constant Field Values

REWRITE_MV_OPTION

public static final java.lang.String REWRITE_MV_OPTION

A constant that represents the rewrite option, which indicates that Oracle OLAP uses the rewrite materialized view for the cube.

See Also:

Constant Field Values

VALID_MV_OPTIONS

public static final java.lang.String[] VALID_MV_OPTIONS

A constant that has the valid values for materialized view options.

SHARED_MEASURE_STORAGE

public static final java.lang.String SHARED_MEASURE_STORAGE

A constant that represents shared measure storage, which indicates that Oracle OLAP stores the values of all of the measures of the cube in the same object.

See Also:

Constant Field Values

INDEPENDENT_MEASURE_STORAGE

public static final java.lang.String INDEPENDENT_MEASURE_STORAGE

A constant that represents independent measure storage, which indicates that Oracle OLAP stores the values of each of the measures of the cube in separate objects.

See Also:

Constant Field Values

VALID_MEASURE_STORAGE_TYPES

public static final java.lang.String[] VALID_MEASURE_STORAGE_TYPES

A constant that has the valid values for the types of measure storage.

GENERIC_NULL_STORAGE

public static final java.lang.String GENERIC_NULL_STORAGE

A constant that represents generic null storage, which indicates that Oracle OLAP does not distinguish between a true NA value and an NA value that exists because Oracle OLAP has not yet calculated the value.

See Also:

Constant Field Values

MV_READY_NULL_STORAGE

public static final java.lang.String MV_READY_NULL_STORAGE

A constant that represents materialized view ready null storage, which indicates that Oracle OLAP makes a distinction between a true NA value and an NA value that exists because Oracle OLAP has not yet calculated the value.

See Also:

Constant Field Values

VALID_NULL_STORAGE_TYPES

public static final java.lang.String[] VALID_NULL_STORAGE_TYPES

A constant that has the valid values for the types of storage of null values.

NONE_ET_VIEW_OPTION

public static final java.lang.String NONE_ET_VIEW_OPTION

A constant that represents the none ET view option, which indicates that Oracle OLAP does not create ET views.

See Also:

Constant Field Values

CREATE_ET_VIEW_OPTION

public static final java.lang.String CREATE_ET_VIEW_OPTION

A constant that represents the create ET view option, which indicates that Oracle OLAP does create ET views.

See Also:

Constant Field Values

VALID_ET_VIEW_OPTIONS

public static final java.lang.String[] VALID_ET_VIEW_OPTIONS

A constant that has the valid values for the ET view options.

Method Detail

findOrCreateMVCreationOptions

public MVCreationOptions findOrCreateMVCreationOptions()

setAW

public final void setAW(AW aw)

Sets the AW that the associated MdmCube will be create in

getPartitionLevel

public final MdmHierarchyLevel getPartitionLevel()

Gets the dimension level that is the basis for the partitioning of the cube that is associated with this AWCubeOrganization.

Returns:

The MdmHierarchyLevel that is the basis for the partitioning the cube associated with this AWCubeOrganization.

setPartitionLevel

public final void setPartitionLevel(MdmHierarchyLevel level)

Specifies the dimension level to use as the basis for the partitioning of the cube that is associated with this AWCubeOrganization.

Parameters:

level - The MdmHierarchyLevel to use as the basis for partitioning the cube associated with this AWCubeOrganization.

getSparseType

public final java.lang.String getSparseType()

Gets the sparsity type of the cube that is associated with this AWCubeOrganization. The sparsity type is one of the values indicated by the VALID_SPARSE_TYPES constant.

Returns:

A String that contains the sparsity type of the cube.

setSparseType

public final void setSparseType(java.lang.String type)

Specifies the sparsity type for the cube that is associated with this AWCubeOrganization. The following table lists the constants that represent the valid values for the type parameter.

Constant	Description
DENSE_SPARSE_TYPE	Specifies that the data in the cube is dense, which means that data exists for 80% or more of the measure values of the cube.
SPARSE_SPARSE_TYPE	Specifies that the data in the cube is sparse, which means that no data exists for more than 20% of the measure values of the cube.
COMPRESSED_SPARSE_TYPE	Specifies that the data in the cube is extremely sparse, which means that the cube has seven or more dimensions, some of which have hundreds of thousands of members, and some dimension hierarchies have many levels in which a parent has only one child.
SPARSE_GLOBAL_SPARSE_TYPE	For a sparse cube that is partitioned, indicates the use of a single object to store data for all of the partitions. This type exists for backward compatibility. Do not specify this type for a new cube.

Parameters:

type - A String that contains a sparsity type for the cube.

getMVOption

public final java.lang.String getMVOption()

Gets the materialized view option for the cube that is associated with this AWCubeOrganization. The materialized view option is one of the values indicated by the VALID_MV_OPTIONS constant.

Returns:

A String that contains the materialized view option for the cube.

setMVOption

public final void setMVOption(java.lang.String option)

Specifies the materialized view option for the cube that is associated with this AWCubeOrganization. The following table lists the constants that represent the valid values for the option parameter.

Constant	Description
NONE_MV_OPTION	Specifies that Oracle OLAP does not refresh materialized views or use them for rewriting queries.
COMPLETE_REFRESH_MV_OPTION	Specifies that Oracle OLAP performs a complete refresh of the materialized views for the cube.
FAST_REFRESH_MV_OPTION	Specifies that Oracle OLAP performs an incremental refresh of the materialized views for the cube based on changes to the relational sources, if possible.
REWRITE_MV_OPTION	Specifies that Oracle OLAP uses the rewrite materialized view for the cube.

Parameters:

option - A String that contains a materialized view option for the cube.

getMeasureStorage

public final java.lang.String getMeasureStorage()

Gets the storage type of the measures of the cube that is associated with this AWCubeOrganization. The measure storage type is one of the values indicated by the VALID_MEASURE_STORAGE_TYPES constant.

Returns:

A String that contains the measure storage type of the cube.

setMeasureStorage

public final void setMeasureStorage(java.lang.String type)

Specifies the measure storage type for the cube that is associated with this AWCubeOrganization. The following table lists the constants that represent the valid values for the type parameter.

Constant	Description
INDEPENDENT_MEASURE_STORAGE	Specifies that Oracle OLAP stores the values of each of the measures of the cube in separate objects.
SHARED_MEASURE_STORAGE	Specifies that Oracle OLAP stores the values of all of the measures of the cube in the same object. Specify the shared measure storage type only if all of the measures have the same data type. If you use this type of storage, specify the data type with the setCubeStorageType method.

Parameters:

type - A String that contains a measure storage type for the cube.

getNullStorage

public final java.lang.String getNullStorage()

Gets the null storage type of the measures of the cube that is associated with this AWCubeOrganization. The null storage type is one of the values indicated by the VALID_NULL_STORAGE_TYPES constant.

Returns:

A String that contains the null storage type of the cube.

setNullStorage

public final void setNullStorage(java.lang.String type)

Specifies the null storage type for the cube that is associated with this AWCubeOrganization. The following table lists the constants that represent the valid values for the type parameter.

Constant	Description
GENERIC_NULL_STORAGE	Specifies that Oracle OLAP does not distinguish between a true NA value and an NA value that exists because Oracle OLAP has not yet calculated the value.
MV_READY_NULL_STORAGE	Specifies that Oracle OLAP makes a distinction between a true NA value and an NA value that exists because Oracle OLAP has not yet calculated the value.

Parameters:

type - A String that contains a null storage type for the cube.

getCubeStorageType

public final java.lang.String getCubeStorageType()

Gets the data type for the shared measure storage.

Returns:

A String that contains data type for the shared measure storage.

setCubeStorageType

public final void setCubeStorageType(java.lang.String exp)

Specifies the data type for the shared measure storage for the cube that is associated with this AWCubeOrganization. If the measure storage type is SHARED_MEASURE_STORAGE, then use this method to specify the data type of the measure values.

Parameters:

exp - A String that contains an expression that resolves to the data type shared by all of the measures of the cube.

See Also:

setMeasureStorage(java.lang.String)

getPrecomputeCondition

public SymmetricCondition getPrecomputeCondition()

Gets the SymmetricCondition that specifies the dimension members for which Oracle OLAP computes and stores aggregate measure values during a build or refresh operation.

Returns:

The SymmetricCondition that specifies the dimension members for which Oracle OLAP precomputes measure values.

setPrecomputeCondition

public void setPrecomputeCondition(SymmetricCondition cond)

Specifies a SymmetricCondition that identifies the dimension members for which Oracle OLAP computes and stores aggregate measure values during a build or refresh operation. This precompute condition applies to any type of cube. If you specify a precompute condition, do not also specify precompute percent values.

Parameters:

cond - The SymmetricCondition that specifies the dimension members for which Oracle OLAP precomputes measure values.

getPrecomputePercent

public final int getPrecomputePercent()

Gets the percentage of the aggregate measure values for a compressed cube that Oracle OLAP computes and stores during a build or refresh operation.

Returns:

An integer that represents the percentage of the measure values that Oracle OLAP precomputes.

setPrecomputePercent

public final void setPrecomputePercent(int val)

Specifies the percentage of the aggregate measure values of a compressed cube for Oracle OLAP to compute and store during a build or refresh operation.

Parameters:

val - An integer that represents the percentage of the measure values for Oracle OLAP to precompute. The value can be 0 (zero) or greater.

getPrecomputePercentTop

public final int getPrecomputePercentTop()

Gets the percentage of the measure values for the top level of a hierarchy of a compressed and partitioned cube that Oracle OLAP computes and stores during a build or refresh operation.

Returns:

An integer that represents the percentage of the measure values for the top level of a hierarchy of a compressed and partitioned cube that Oracle OLAP precomputes.

setPrecomputePercentTop

public final void setPrecomputePercentTop(int val)

Specifies the percentage of the measure values for the top level of a hierarchy for Oracle OLAP to compute and store during a build or refresh operation.

Parameters:

val - An integer, which must be greater than 0 (zero), that represents the percentage of the measure values for the top level of a hierarchy of a compressed and partitioned cube for Oracle OLAP to precompute.

getAW

public final AW getAW()

Gets the analytic workspace associated with this AWCubeOrganization.

Returns:

The AW associated with this AWCubeOrganization.

addBuildSpecification

public void addBuildSpecification(BuildSpecification spec)

Adds a BuildSpecification to the list of those associated with this AWCubeOrganization.

Parameters:

spec - The BuildSpecification to add to this AWCubeOrganization.

removeBuildSpecification

public void removeBuildSpecification(BuildSpecification spec)

Removes a BuildSpecification from the list of those associated with this AWCubeOrganization.

Parameters:

spec - The BuildSpecification to remove from this AWCubeOrganization.

getBuildSpecifications

public java.util.List<BuildSpecification> getBuildSpecifications()

Gets the BuildSpecification objects associated with this AWCubeOrganization.

Returns:

A List of the BuildSpecification objects associated with this AWCubeOrganization.

getDefaultBuildSpecification

public BuildSpecification getDefaultBuildSpecification()

Gets the default BuildSpecification of this AWCubeOrganization.

Returns:

The default BuildSpecification for this AWCubeOrganization.

setDefaultBuildSpecification

public void setDefaultBuildSpecification(BuildSpecification spec)

Specifies a BuildSpecification to use as the default for this AWCubeOrganization.

Parameters:

spec - The BuildSpecification to use as the default for this AWCubeOrganization.

getETViewOption

public final java.lang.String getETViewOption()

Gets the ET view option for this AWCubeOrganization, which indicates whether Oracle OLAP creates ET views for the cube.

Returns:

A String that contains the ET view option for this AWCubeOrganization.

setETViewOption

public final void setETViewOption(java.lang.String option)

Specifies whether Oracle OLAP creates ET views for the cube. The VALID_ET_VIEW_OPTIONS array contains the valid ET view options, which are NONE_ET_VIEW_OPTION and CREATE_ET_VIEW_OPTION.

Parameters:

option - A String that contains an ET view option for this AWCubeOrganization.

setMVCreationOptions

public final void setMVCreationOptions(MVCreationOptions mvCreationOptions)

Skip navigation links