|
Oracle® OLAP Java API Reference 11g Release 2 (11.2) E10794-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.olapi.metadata.BaseMetadataObject
oracle.olapi.metadata.deployment.CubeOrganization
oracle.olapi.metadata.deployment.AWCubeOrganization
public class AWCubeOrganization
A CubeOrganization
for an analytic workspace. An AWCubeOrganization
contains options that affect the data loading, aggregation method, storage, and querying of an MdmCube
. To get an existing AWCubeOrganization
or to create a new one, use the
method of the findOrCreateAWCubeOrganization
MdmCube
.
One option controls the creation of materialized views (MVs) for the measures and dimensions that are associated with the cube. MVs can be automatically refreshed, which can be useful in maintaining the analytic workspace. An MV can be used by the database query rewrite system, which can result in significantly enhanced performance of SQL queries. However, a cube that uses MVs has limitations because the cube must meet certain requirements, which are listed in the description of the setMVOption
method. Another limitation is that a cube that has MVs cannot have a derived measure.
Oracle Database has systems for refreshing the data associated with an MV and for transparently rewriting a query so that it uses an MV. With the setMVOption
method, you can specify whether or not to create an MV and the type of MV to create. The options that specify the creation of an MV determine the structure of the MV and the conditions required for the creation of the MV. If you specify the creation of a MV, then you can use an MVCreationOptions
object to set values that affect the actual creation of the MV and that can replace the default values.
A Java application can demand a refresh by calling the DataProvider.executeBuild
method for the cube. Building the cube refreshes the MV. You can specify properties that affect the building of the cube by passing a BuildProperties
object to the executeBuild
method.
For more information on cube partitioning, sparsity types, storage types, and the use of MVs, see Oracle OLAP User's Guide.
Field Summary | |
---|---|
static java.lang.String |
COMPLETE_REFRESH_MV_OPTION A constant that indicates that Oracle OLAP creates a materialized view that supports a complete refresh operation. |
static java.lang.String |
COMPRESSED_SPARSE_TYPE A constant that indicates an extremely sparse cube. |
static java.lang.String |
DENSE_SPARSE_TYPE A constant that indicates a dense cube. |
static java.lang.String |
FAST_REFRESH_MV_OPTION A constant that indicates that Oracle OLAP creates a materialized view that supports a fast refresh operation. |
static java.lang.String |
FAST_REFRESH_READY_MV_OPTION A constant that indicates that Oracle OLAP determines that the conditions exist that permit the future creation of a materialized view that is capable of a fast refresh. |
static java.lang.String |
GENERIC_NULL_STORAGE A constant that 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 indicates that Oracle OLAP stores the values of each of the measures of the cube in a separate object. |
static java.lang.String |
MV_READY_NULL_STORAGE A constant that 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_MV_OPTION A constant that indicates that Oracle OLAP does not a create materialized view for the cube. |
static java.lang.String |
REWRITE_MV_OPTION A constant that indicates that Oracle OLAP creates a materialized view that is accessible to the database query rewrite system. |
static java.lang.String |
REWRITE_READY_MV_OPTION A constant that indicates that Oracle OLAP determines that the conditions exist that permit the future creation of an materialized viewt that is accessible to the database query rewrite system. |
static java.lang.String |
REWRITE_WITH_ATTRIBUTES_MV_OPTION A constant that indicates that Oracle OLAP creates a materialized view that has query rewrite enabled and that includes columns for all MdmDimensionLevel attributes for which the method returns true . |
static java.lang.String |
SHARED_MEASURE_STORAGE A constant that 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 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 indicates a sparse cube. |
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 that are contained by this AWCubeOrganization . |
void |
addSecondaryPartitionLevel(SecondaryPartitionLevel level, int levelNumber) Adds a SecondaryPartitionLevel to the List of those that are contained by this AWCubeOrganization . |
MVCreationOptions |
findOrCreateMVCreationOptions() Gets the MVCreationOptions that is contained by this AWCubeOrganization or creates one if it does not already exist. |
SecondaryPartitionLevel |
findOrCreateSecondaryPartitionLevel(java.lang.String name) Gets the specified SecondaryPartitionLevel that is contained by this AWCubeOrganization or creates one if it does not already exist. |
AW |
getAW() Gets the analytic workspace that is associated with this AWCubeOrganization . |
java.util.List<BuildSpecification> |
getBuildSpecifications() Gets the BuildSpecification objects that are contained by this AWCubeOrganization . |
java.lang.String |
getCubeStorageType() Gets the Oracle OLAP DML data type for the shared measure storage. |
BuildSpecification |
getDefaultBuildSpecification() Gets the default BuildSpecification of this AWCubeOrganization . |
java.lang.String |
getMeasureStorage() Gets the storage type of the measures of the cube that contains this AWCubeOrganization . |
MVCreationOptions |
getMVCreationOptions() Gets the MVCreationOptions object of the AWCubeOrganization |
java.lang.String |
getMVOption() Gets the materialized view option for the cube that contains this AWCubeOrganization . |
java.lang.String |
getNullStorage() Gets the null storage type of the measures of the cube that contains this AWCubeOrganization . |
MdmHierarchyLevel |
getPartitionLevel() Gets the dimension level that is the basis for the primary partitioning of the cube that contains 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.util.List<SecondaryPartitionLevel> |
getSecondaryPartitionLevels() Gets the SecondaryPartitionLevel objects that are contained by this AWCubeOrganization . |
java.lang.String |
getSparseType() Gets the sparsity type of the cube that contains this AWCubeOrganization . |
SQLDataType |
getSQLCubeStorageType() Gets the SQL data type for the shared measure storage. |
void |
removeBuildSpecification(BuildSpecification spec) Removes a BuildSpecification from the list of those that are contained by this AWCubeOrganization . |
void |
removeSecondaryPartitionLevel(SecondaryPartitionLevel partitionLevel) Removes the specified SecondaryPartitionLevel from those that are contained by this AWCubeOrganization . |
void |
setAW(AW aw) Specifies an AW as the container of the MdmCube that contains this AWCubeOrganization . |
void |
setCubeStorageType(java.lang.String exp) Specifies the Oracle OLAP DML data type for the shared measure storage for the cube that contains this AWCubeOrganization . |
void |
setDefaultBuildSpecification(BuildSpecification spec) Specifies a BuildSpecification to use as the default for this AWCubeOrganization . |
void |
setMeasureStorage(java.lang.String type) Specifies the measure storage type for the cube that contains this AWCubeOrganization . |
void |
setMVCreationOptions(MVCreationOptions mvCreationOptions) Specifies an MVCreationOptions for this AWCubeOrganization . |
void |
setMVOption(java.lang.String option) Specifies the materialized view option for the cube that contains this AWCubeOrganization . |
void |
setNullStorage(java.lang.String type) Specifies the null storage type for the cube that contains this AWCubeOrganization . |
void |
setPartitionLevel(MdmHierarchyLevel level) Specifies the dimension level to use as the basis for the primary partitioning of the cube that contains 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 contains this AWCubeOrganization . |
void |
setSQLCubeStorageType(SQLDataType type) Specifies a SQL data type for the shared measure storage for the cube that contains this AWCubeOrganization . |
Methods inherited from class oracle.olapi.metadata.deployment.CubeOrganization |
---|
addSparseDimension, clearSparseDimensions, getCube, getSparseDimensions, removeSparseDimension |
Methods inherited from class oracle.olapi.metadata.BaseMetadataObject |
---|
getContainedByObject, getID, getName, getNewName, getOwner |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DENSE_SPARSE_TYPE
public static final java.lang.String COMPRESSED_SPARSE_TYPE
public static final java.lang.String SPARSE_SPARSE_TYPE
public static final java.lang.String SPARSE_GLOBAL_SPARSE_TYPE
public static final java.lang.String[] VALID_SPARSE_TYPES
public static final java.lang.String NONE_MV_OPTION
public static final java.lang.String COMPLETE_REFRESH_MV_OPTION
public static final java.lang.String FAST_REFRESH_MV_OPTION
public static final java.lang.String FAST_REFRESH_READY_MV_OPTION
public static final java.lang.String REWRITE_MV_OPTION
public static final java.lang.String REWRITE_WITH_ATTRIBUTES_MV_OPTION
MdmDimensionLevel
attributes for which the MdmBaseAttribute.isPopulateLineage
method returns true
.
public static final java.lang.String REWRITE_READY_MV_OPTION
public static final java.lang.String[] VALID_MV_OPTIONS
public static final java.lang.String SHARED_MEASURE_STORAGE
public static final java.lang.String INDEPENDENT_MEASURE_STORAGE
public static final java.lang.String[] VALID_MEASURE_STORAGE_TYPES
public static final java.lang.String GENERIC_NULL_STORAGE
public static final java.lang.String MV_READY_NULL_STORAGE
public static final java.lang.String[] VALID_NULL_STORAGE_TYPES
Method Detail |
---|
public MVCreationOptions findOrCreateMVCreationOptions()
MVCreationOptions
that is contained by this AWCubeOrganization
or creates one if it does not already exist. The MVCreationOptions
specifies options that Oracle OLAP uses when it creates a materialized view for the MdmCube
that contains this AWCubeOrganization
.
With the setMVOptions
method, you can specify the type of materialized view to create or you can specify not to create one for the cube. If you specify creating a type of materialized view, you can use an MVCreationOptions
object to specify values that Oracle OLAP uses when it actually creates the MV.
MVCreationOptions
that contains options that affect the creation of a materialized view.public final MVCreationOptions getMVCreationOptions()
MVCreationOptions
object of the AWCubeOrganizationMVCreationOptions
objectpublic final void setAW(AW aw)
AW
as the container of the MdmCube
that contains this AWCubeOrganization
.aw
- The AW
to contain the MdmCube
of this AWCubeOrganization
.public final java.util.List<SecondaryPartitionLevel> getSecondaryPartitionLevels()
SecondaryPartitionLevel
objects that are contained by this AWCubeOrganization
.List
of the SecondaryPartitionLevel
objects of this AWCubeOrganization
.public final void removeSecondaryPartitionLevel(SecondaryPartitionLevel partitionLevel)
SecondaryPartitionLevel
from those that are contained by this AWCubeOrganization
.partitionLevel
- The SecondaryPartitionLevel
to remove from this AWCubeOrganization
.public void addSecondaryPartitionLevel(SecondaryPartitionLevel level, int levelNumber)
SecondaryPartitionLevel
to the List
of those that are contained by this AWCubeOrganization
. The levelNumber
parameter specifies the position in the list of the SecondaryPartitionLevel
. Be sure to order the list so that the levels are in ascending order, with the lowest secondary partitioning level in the first position in the list. You can change the order of the SecondaryPartitionLevel
objects in the list by removing a SecondaryPartitionLevel
and then by specifying a different position when you add it back to the AWCubeOrganization
. Oracle OLAP automatically reorders the positions of the subsequent members of the list.level
- The SecondaryPartitionLevel
to add to this AWCubeOrganization
.levelNumber
- An integer that specifies a position in the List
of SecondaryPartitionLevel
objects.public final SecondaryPartitionLevel findOrCreateSecondaryPartitionLevel(java.lang.String name)
SecondaryPartitionLevel
that is contained by this AWCubeOrganization
or creates one if it does not already exist. An AWCubeOrganization
can have up to three secondary partition levels in addition to the primary partition level that is specified by the setPartitionLevel
method.name
- A String
that contains the name of an existing SecondaryPartitionLevel
or a name for a new one.SecondaryPartitionLevel
.public final MdmHierarchyLevel getPartitionLevel()
AWCubeOrganization
.MdmHierarchyLevel
that is the basis for the primary partitioning of the cube that contains this AWCubeOrganization
.public final void setPartitionLevel(MdmHierarchyLevel level)
AWCubeOrganization
.level
- The MdmHierarchyLevel
to use as the basis for the primary partitioning of the cube that contains this AWCubeOrganization
.public final java.lang.String getSparseType()
AWCubeOrganization
.String
that contains the sparsity type of the cube.public final void setSparseType(java.lang.String type)
AWCubeOrganization
. You can specify a sparsity type for all of the dimensions of the cube by using this method or you can specify individual dimensions as sparse by using the addSparseDimension
method.
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. |
type
- A String
that contains a sparsity type for the cube.public final java.lang.String getMVOption()
AWCubeOrganization
.String
that contains the materialized view option for the cube.public final void setMVOption(java.lang.String option)
AWCubeOrganization
. This option determines the structure of the materialized view. The different types of materialized view have different requirements.
To specify an MV option of COMPLETE_REFRESH_MV_OPTION
, the cube must meet the following requirements.
MV_READY_NULL_STORAGE
, which is the default if the MV option is other than NONE_MV_OPTION
.COMPRESSED_SPARSE_TYPE
.COMPLETE_REFRESH_MV_OPTION
.To specify an MV option of FAST_REFRESH_MV_OPTION
or FAST_REFRESH_READY_MV_OPTION
, the cube must meet the following requirements in addition to the requirements for the COMPLETE_REFRESH_MV_OPTION
.
To specify an MV option of REWRITE_MV_OPTION
or REWRITE_READY_MV_OPTION
, the cube must meet the following requirements in addition to the requirements for the COMPLETE_REFRESH_MV_OPTION
.
ConsistentSolveSpecification
for the cube specify a single aggregation method over all of the hierarchies of all of the dimensions.SUM
, MAX
, or MIN
.ConsistentSolveSpecification
.HIERARCHY_RULE_STAR_CONSISTENT
.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 create a materialized view for the cube. |
COMPLETE_REFRESH_MV_OPTION |
Specifies that Oracle OLAP creates a materialized view for the cube. |
FAST_REFRESH_MV_OPTION |
Specifies that Oracle OLAP creates a materialized view that supports an incremental refresh. |
FAST_REFRESH_READY_MV_OPTION |
Specifies that Oracle OLAP determines that the conditions exist for the creation of a materialized view that is capable of a fast refresh but does not actually create the MV. |
REWRITE_MV_OPTION |
Specifies that Oracle OLAP creates a materialized view that the database query rewrite system can use. |
REWRITE_READY_MV_OPTION |
Specifies that Oracle OLAP determines that the conditions exist for the creation of a rewrite materialized view but does not actually create the MV. |
REWRITE_MV_OPTION |
Specifies that Oracle OLAP creates a materialized view that the database query rewrite system can use. |
REWRITE_WITH_ATTRIBUTES_MV_OPTION |
Specifies that Oracle OLAP creates a materialized view that has query rewrite enabled and that includes columns for all MdmDimensionLevel attributes for which the MdmBaseAttribute.isPopulateLineage method returns true . |
MVCreationOptions
object to specify options that Oracle OLAP uses when it actually creates the MV.option
- A String
that contains a materialized view option for the cube.public final java.lang.String getMeasureStorage()
AWCubeOrganization
.String
that contains the measure storage type of the cube.public final void setMeasureStorage(java.lang.String type)
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, then specify the data type with the method. |
type
- A String
that contains a measure storage type for the cube.public final java.lang.String getNullStorage()
AWCubeOrganization
.String
that contains the null storage type of the cube.public final void setNullStorage(java.lang.String type)
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. |
type
- A String
that contains a null storage type for the cube.public final java.lang.String getCubeStorageType()
String
that contains the OLAP DML data type for the shared measure storage.setCubeStorageType(java.lang.String)
, setSQLCubeStorageType(oracle.olapi.syntax.SQLDataType)
public final void setCubeStorageType(java.lang.String exp)
AWCubeOrganization
. The OLAP DML data type applies to every measure of the cube. For information on the OLAP DML data types, see Oracle OLAP DML Reference.
To specify an OLAP DML data type for the cube storage type, do the following:
SHARED_MEASURE_STORAGE
with the setMeasureStorage
method.getSQLCubeStorageType
method. If that method returns a value other than null
, then clear the value by calling the setSQLCubeStorageType
method and passing it null
.String
that contains an OLAP DML data type.exp
- A String
that contains an expression that resolves to the OLAP DML data type shared by all of the measures of the cube.setMeasureStorage(java.lang.String)
, setSQLCubeStorageType(oracle.olapi.syntax.SQLDataType)
public final SQLDataType getSQLCubeStorageType()
SQLDataType
for the shared measure storage or null
if the SQL data type has not been specified by the setSQLCubeStorageType
method.public final void setSQLCubeStorageType(SQLDataType type)
AWCubeOrganization
. The SQL data type applies to every measure of the cube.
To specify a SQL data type for the cube storage type, do the following:
SHARED_MEASURE_STORAGE
with the setMeasureStorage
method.getCubeStorageType
method. If that method returns a value other than null
, then clear the value by calling the setCubeStorageType
method and passing it null
.SQLDataType
.type
- A SQLDataType
that contains the SQL data type that is shared by all of the measures of the cube.setMeasureStorage(java.lang.String)
, setCubeStorageType(java.lang.String)
public SymmetricCondition getPrecomputeCondition()
SymmetricCondition
that specifies the dimension members for which Oracle OLAP computes and stores aggregate measure values during a build or refresh operation.SymmetricCondition
that specifies the dimension members for which Oracle OLAP precomputes measure values.public void setPrecomputeCondition(SymmetricCondition cond)
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.cond
- The SymmetricCondition
that specifies the dimension members for which Oracle OLAP precomputes measure values.public final int getPrecomputePercent()
public final void setPrecomputePercent(int val)
val
- An integer that represents the percentage of the measure values for Oracle OLAP to precompute. The value can be 0 (zero) or greater.public final int getPrecomputePercentTop()
public final void setPrecomputePercentTop(int val)
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.public final AW getAW()
AWCubeOrganization
.AW
associated with this AWCubeOrganization
.public void addBuildSpecification(BuildSpecification spec)
BuildSpecification
to the list of those that are contained by this AWCubeOrganization
.spec
- The BuildSpecification
to add to this AWCubeOrganization
.public void removeBuildSpecification(BuildSpecification spec)
BuildSpecification
from the list of those that are contained by this AWCubeOrganization
.spec
- The BuildSpecification
to remove from this AWCubeOrganization
.public java.util.List<BuildSpecification> getBuildSpecifications()
BuildSpecification
objects that are contained by this AWCubeOrganization
.List
of the BuildSpecification
objects contained by this AWCubeOrganization
.public BuildSpecification getDefaultBuildSpecification()
BuildSpecification
of this AWCubeOrganization
.BuildSpecification
for this AWCubeOrganization
.public void setDefaultBuildSpecification(BuildSpecification spec)
BuildSpecification
to use as the default for this AWCubeOrganization
.spec
- The BuildSpecification
to use as the default for this AWCubeOrganization
.public final void setMVCreationOptions(MVCreationOptions mvCreationOptions)
MVCreationOptions
for this AWCubeOrganization
. An MVCreationOptions
contains options that Oracle OLAP uses when it creates a materialized view (MV) for an analytic workspace cube.mvCreationOptions
- The MVCreationOptions
contained by this AWCubeOrganization
.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |