|
Oracle® OLAP Java API Reference 11g Release 1 (11.1) B28128-01 |
||||||||
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.PrimaryDimensionOrganization
oracle.olapi.metadata.deployment.AWPrimaryDimensionOrganization
public final class AWPrimaryDimensionOrganization
A PrimaryDimensionOrganization
for an analytic workspace. An AWPrimaryDimensionOrganization
contains information about how the data for an MdmPrimaryDimension
is organized and maintained by Oracle OLAP. It contains an AWAttributeOrganization
for each of the MdmAttribute
objects owned by the dimension. It also contains a default BuildSpecification
object that specifies how Oracle OLAP builds the dimension.
An application creates an AWPrimaryDimensionOrganization
with the
method of an createAWOrganization
MdmPrimaryDimension
.
For information on using and refreshing 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 dimension. |
static java.lang.String |
COMPLETE_REFRESH_READY_MV_OPTION A constant that represents the complete refresh ready option, which indicates that Oracle OLAP is ready to perform a complete refresh of the materialized views for the dimension. |
static java.lang.String |
CREATE_ET_VIEW_OPTION A constant that represents the create ET view option, which indicates that Oracle OLAP creates ET views for the dimension. |
static java.lang.String |
HIERARCHY_RULE_CONSISTENT A constant that represents the consistent hierarchy rule, which indicates that the parent-child relationships are consistent across the hierarchies of the dimension. |
static java.lang.String |
HIERARCHY_RULE_SOLVE_CONSISTENT A constant that represents the solve consistent hierarchy rule, which indicates that the parent-child relationships only need to be consistent across hierarchies of the dimension when they appear together in a solve. |
static java.lang.String |
HIERARCHY_RULE_STAR_CONSISTENT A constant that represents the star consistent hierarchy rule, which indicates that the hierarchies of the dimension are consistent with a star schema organization. |
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 for the dimension. |
static java.lang.String |
NONE_MV_OPTION A constant that represents the none option, which indicates that Oracle OLAP does not refresh materialized views. |
static java.lang.String[] |
VALID_ET_VIEW_OPTIONS A constant that has the valid values for ET view options. |
static java.lang.String[] |
VALID_HIERARCHY_RULES A constant that has the valid values for hierarchy rules. |
static java.lang.String[] |
VALID_MV_OPTIONS A constant that has the valid values for materialized view options. |
Method Summary | |
---|---|
MVCreationOptions |
findOrCreateMVCreationOptions() |
boolean |
getAddUniqueKeyPrefix() Indicates whether or not each member of this dimension will have a unique level-based prefix added to the key expressions when the data is loaded into the AW. |
AWAttributeOrganization |
getAttributeOrganization(MdmBaseAttribute attr) Gets the AWAttributeOrganization that is associated with the specified MdmBaseAttribute . |
java.util.List |
getAttributeOrganizations() Gets the AWAttributeOrganization objects that are associated with this AWPrimaryDimensionOrganization . |
AW |
getAW() Gets the analytic workspace associated with this AWPrimaryDimensionOrganization . |
BuildSpecification |
getDefaultBuildSpecification() Gets the default BuildSpecification of this AWPrimaryDimensionOrganization . |
java.lang.String |
getETViewOption() Gets the ET view option of the AWPrimaryDimensionOrganization , which specifies whether Oracle OLAP does or does not creates ET (embedded total) views for the dimension. |
java.lang.String |
getHierarchyConsistencyRule() Gets the hierarchy consistency rule, which is one of the values indicated by the VALID_HIERARCHY_RULES constant. |
java.lang.String |
getMVOption() Gets the materialized view option for the dimension that is associated with this AWPrimaryDimensionOrganization . |
void |
removeAttributeOrganization(AWAttributeOrganization org) Removes the AWAttributeOrganization that is associated with the specified MdmBaseAttribute . |
void |
setAddUniqueKeyPrefix(boolean val) Specifies whether each member of this dimension has a unique level-based prefix added to the key expressions when the data is loaded into the AW. |
void |
setAW(AW aw) Sets the AW that the associated MdmCube will be create in |
void |
setDefaultBuildSpecification(BuildSpecification spec) Specifies a BuildSpecification to use as the default for this AWPrimaryDimensionOrganization . |
void |
setETViewOption(java.lang.String option) Specifies an ET view option for the AWPrimaryDimensionOrganization . |
void |
setHierarchyConsistencyRule(java.lang.String option) Specifies the hierarchy consistency rule for the dimension that is associated with this AWPrimaryDimensionOrganization . |
void |
setMVCreationOptions(MVCreationOptions mvCreationOptions) |
void |
setMVOption(java.lang.String option) Specifies the materialized view option for the dimension that is associated with this AWPrimaryDimensionOrganization . |
Methods inherited from class oracle.olapi.metadata.deployment.PrimaryDimensionOrganization |
---|
getPrimaryDimension |
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 |
---|
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 COMPLETE_REFRESH_READY_MV_OPTION
public static final java.lang.String[] VALID_MV_OPTIONS
public static final java.lang.String HIERARCHY_RULE_CONSISTENT
public static final java.lang.String HIERARCHY_RULE_SOLVE_CONSISTENT
public static final java.lang.String HIERARCHY_RULE_STAR_CONSISTENT
public static final java.lang.String[] VALID_HIERARCHY_RULES
public static final java.lang.String NONE_ET_VIEW_OPTION
public static final java.lang.String CREATE_ET_VIEW_OPTION
public static final java.lang.String[] VALID_ET_VIEW_OPTIONS
Method Detail |
---|
public MVCreationOptions findOrCreateMVCreationOptions()
public final boolean getAddUniqueKeyPrefix()
boolean
that is true
if a unique prefix is added to the key expressions or false
otherwise.public final void setAddUniqueKeyPrefix(boolean val)
val
- A boolean
that is true
if this a unique prefix is added to the key expressions or false
otherwise.public final java.lang.String getHierarchyConsistencyRule()
VALID_HIERARCHY_RULES
constant.String
that contains the hierarchy consistency rule for the dimension.public final void setHierarchyConsistencyRule(java.lang.String option)
AWPrimaryDimensionOrganization
. The following table lists the constants that represent the valid values for the option
parameter.
Note: To use materialized views, the hierarchies of a dimension must be consistent with a star schema organization.
Constant | Description |
---|---|
HIERARCHY_RULE_CONSISTENT |
Specifies that the parent-child relationships are consistent across the hierarchies of the dimension. |
HIERARCHY_RULE_SOLVE_CONSISTENT |
Specifies that the parent-child relationships are not consistent across the hierarchies of the dimension. An example of inconsistent hierarchies occurs when the parent-child relationship is reversed in two hierarchies. For example, in hierarchy 1, dimension member A is the parent of member B, while and in hierarchy 2, member B is the parent of member A. |
HIERARCHY_RULE_STAR_CONSISTENT |
Specifies that the hierarchies of the dimension are consistent with a star schema organization. |
option
- A String
that contains a hierarchy consistency rule for the dimension.public final AW getAW()
AWPrimaryDimensionOrganization
.AW
associated with this AWPrimaryDimensionOrganization
.public final void setAW(AW aw)
AW
that the associated MdmCube
will be create inpublic java.util.List getAttributeOrganizations()
AWAttributeOrganization
objects that are associated with this AWPrimaryDimensionOrganization
.List
of the AWAttributeOrganization
objects associated with this AWPrimaryDimensionOrganization
.public AWAttributeOrganization getAttributeOrganization(MdmBaseAttribute attr)
AWAttributeOrganization
that is associated with the specified MdmBaseAttribute
. If the AWAttributeOrganization
does not already exit, then this method creates one and adds it to the list of AWAttributeOrganization
objects for this AWPrimaryDimensionOrganization
.attr
- The AWAttributeOrganization
associated with the specified MdmBaseAttribute
.AWAttributeOrganization
associated with the specified MdmBaseAttribute
.public void removeAttributeOrganization(AWAttributeOrganization org)
AWAttributeOrganization
that is associated with the specified MdmBaseAttribute
.org
- The AWAttributeOrganization
to remove from this AWPrimaryDimensionOrganization
.public final java.lang.String getMVOption()
AWPrimaryDimensionOrganization
. The materialized view option is one of the values indicated by the VALID_MV_OPTIONS
constant.String
that contains the materialized view option for the dimension.public final void setMVOption(java.lang.String option)
AWPrimaryDimensionOrganization
. 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. |
COMPLETE_REFRESH_MV_OPTION |
Specifies that Oracle OLAP performs a complete refresh of the materialized views for the dimension. |
COMPLETE_REFRESH_READY_MV_OPTION |
Specifies that Oracle OLAP is ready to perform a complete refresh of the materialized views for the dimension. |
option
- A String
that contains a materialized view option for the dimension.public final void setMVCreationOptions(MVCreationOptions mvCreationOptions)
public BuildSpecification getDefaultBuildSpecification()
BuildSpecification
of this AWPrimaryDimensionOrganization
.BuildSpecification
for this AWPrimaryDimensionOrganization
.public void setDefaultBuildSpecification(BuildSpecification spec)
BuildSpecification
to use as the default for this AWPrimaryDimensionOrganization
.spec
- The BuildSpecification
to use as the default for this AWPrimaryDimensionOrganization
.public final java.lang.String getETViewOption()
AWPrimaryDimensionOrganization
, which specifies whether Oracle OLAP does or does not creates ET (embedded total) views for the dimension. The options are NONE and CREATE.String
that contains the ET view option of the AWPrimaryDimensionOrganization
.public final void setETViewOption(java.lang.String option)
AWPrimaryDimensionOrganization
. The setting of the option determines whether Oracle OLAP does or does not creates ET (embedded total) views for the dimension. The following table lists the constants that represent the valid values for the option
parameter.
Constant | Description |
---|---|
NONE_ET_VIEW_OPTION |
Specifies that Oracle OLAP does not create ET views for the dimension. |
CREATE_ET_VIEW_OPTION |
Specifies that Oracle OLAP creates ET views for the dimension. |
option
- A String
that contains an ET view option for the dimension.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |