Skip navigation links

Oracle® OLAP Java API Reference
11g Release 1 (11.1)

B28128-01


oracle.olapi.metadata.deployment
Class MVCreationOptions

java.lang.Object
  extended by oracle.olapi.metadata.BaseMetadataObject
      extended by oracle.olapi.metadata.deployment.MVCreationOptions

All Implemented Interfaces:
MetadataObject

public class MVCreationOptions
extends BaseMetadataObject

Field Summary
static java.lang.String FIXED_NAME
           
static java.lang.String REFRESH_ON_COMMIT
          A constant that represents the refresh on commit mode, which indicates that a refresh occurs when the database commits a transaction that affects a source table.
static java.lang.String REFRESH_ON_DEFAULT
          A constant that represents the refresh on default mode, which indicates that a refresh occurs on the default setting.
static java.lang.String REFRESH_ON_DEMAND
          A constant that represents the refresh on demand mode, which indicates that a refresh occurs on demand.
static java.lang.String REFRESH_TYPE_COMPLETE
          A constant that represents a complete refresh type.
static java.lang.String REFRESH_TYPE_DEFAULT
          A constant that represents the default refresh type.
static java.lang.String REFRESH_TYPE_FAST
          A constant that represents a fast refresh type.
static java.lang.String REFRESH_TYPE_FORCE
          A constant that represents a force refresh type.
static java.lang.String[] VALID_REFRESH_ON_OPTIONS
          A constant that indicates the valid values for the conditions that initiate a refresh.
static java.lang.String[] VALID_REFRESH_TYPES
          A constant that has the valid values for the refresh type.

 

Constructor Summary
MVCreationOptions(java.lang.String fullID, short persistenceType, BaseMetadataObject container)
           

 

Method Summary
 boolean enableRewriteMV()
          Indicates whether this AWCubeSpecification specifies the use of materialized views to rewrite a query of the measures of the cube.
 java.lang.String getRefreshNextExpression()
          Gets the expression that indicates when the next refresh of the materialized views occurs.
 java.lang.String getRefreshOnOption()
          Gets the mode that Oracle OLAP uses to determine when to refresh the data contained in the materialized views that are associated with the dimension or cube.
 java.lang.String getRefreshStartWithExpression()
          Gets the expression that indicates when the initial refresh of the materialized views occurs.
 java.lang.String getRefreshType()
          Gets a value that indicates the type of operation that Oracle OLAP performs when it refreshes the data contained in the materialized views that are associated with the dimension or cube.
 java.lang.String getUsingConstraints()
          Gets the expression that indicates whether the USING_CONSTRAINST_CLAUSE specified is ENFORCED or TRUSTED
protected  interface getXMLTag()
           
 void setEnableRewriteMV(boolean val)
          Specifies whether to enable the use of materialized views to rewrite a query of the measures of the cube.
 void setRefreshNextExpression(java.lang.String exp)
          Specifies an expression that determines when the next refresh of the materialized views occurs.
 void setRefreshOnOption(java.lang.String option)
          Specifies the mode that Oracle OLAP uses to determine when to refresh the data contained in the materialized views that are associated with the cube or dimension.
 void setRefreshStartWithExpression(java.lang.String exp)
          Specifies an expression that determines when the initial refresh of the materialized views occurs.
 void setRefreshType(java.lang.String type)
          Specifies the refresh method that Oracle OLAP uses when it refreshes the data contained in the materialized views that are associated with the cube or dimension.
 void setUsingConstraints(java.lang.String exp)
          Specifies an expression that determines the Using Constraints clause for the materialized views.

 

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

FIXED_NAME

public static final java.lang.String FIXED_NAME
See Also:
Constant Field Values

REFRESH_TYPE_FAST

public static final java.lang.String REFRESH_TYPE_FAST
A constant that represents a fast refresh type.
See Also:
Constant Field Values

REFRESH_TYPE_COMPLETE

public static final java.lang.String REFRESH_TYPE_COMPLETE
A constant that represents a complete refresh type.
See Also:
Constant Field Values

REFRESH_TYPE_FORCE

public static final java.lang.String REFRESH_TYPE_FORCE
A constant that represents a force refresh type.
See Also:
Constant Field Values

REFRESH_TYPE_DEFAULT

public static final java.lang.String REFRESH_TYPE_DEFAULT
A constant that represents the default refresh type.
See Also:
Constant Field Values

VALID_REFRESH_TYPES

public static final java.lang.String[] VALID_REFRESH_TYPES
A constant that has the valid values for the refresh type.

VALID_REFRESH_ON_OPTIONS

public static final java.lang.String[] VALID_REFRESH_ON_OPTIONS
A constant that indicates the valid values for the conditions that initiate a refresh.

REFRESH_ON_DEFAULT

public static final java.lang.String REFRESH_ON_DEFAULT
A constant that represents the refresh on default mode, which indicates that a refresh occurs on the default setting.
See Also:
Constant Field Values

REFRESH_ON_DEMAND

public static final java.lang.String REFRESH_ON_DEMAND
A constant that represents the refresh on demand mode, which indicates that a refresh occurs on demand.
See Also:
Constant Field Values

REFRESH_ON_COMMIT

public static final java.lang.String REFRESH_ON_COMMIT
A constant that represents the refresh on commit mode, which indicates that a refresh occurs when the database commits a transaction that affects a source table.
See Also:
Constant Field Values

Constructor Detail

MVCreationOptions

public MVCreationOptions(java.lang.String fullID,
                         short persistenceType,
                         BaseMetadataObject container)

Method Detail

enableRewriteMV

public final boolean enableRewriteMV()
Indicates whether this AWCubeSpecification specifies the use of materialized views to rewrite a query of the measures of the cube.
Returns:
A boolean that is true if the use of rewrite MVs is enabled or false otherwise.

setEnableRewriteMV

public final void setEnableRewriteMV(boolean val)
Specifies whether to enable the use of materialized views to rewrite a query of the measures of the cube.
Parameters:
val - A boolean that is true to enable the use of rewrite MVs or false to disable the use of them.

getRefreshType

public final java.lang.String getRefreshType()
Gets a value that indicates the type of operation that Oracle OLAP performs when it refreshes the data contained in the materialized views that are associated with the dimension or cube.
Returns:
A String that contains the refresh type of the dimension or cube.

setRefreshType

public final void setRefreshType(java.lang.String type)
Specifies the refresh method that Oracle OLAP uses when it refreshes the data contained in the materialized views that are associated with the cube or dimension.

Note: The refresh type must match the materialized view option. If an application sets the MV option to none, then the refresh type has no affect. For an MV option of complete, the refresh type should be complete. For an MV option of fast, the refresh type should be fast. For an MV option of rewrite, the refresh type should be force.

The following table lists the constants that represent the valid values for the type parameter.

Constant Description
REFRESH_TYPE_COMPLETE Refresh all of the data in the cube.
REFRESH_TYPE_FAST Refresh only the data in the cube that needs to change due to changes to the relational source tables. A fast refresh is possible only if the relational source tables support the operation. If fast refresh is not possible, the operation does not succeed.
REFRESH_TYPE_FORCE Perform a fast refresh if possible, otherwise perform a complete refresh.
REFRESH_TYPE_DEFAULT Use the default refresh type, which is force.
Parameters:
type - A String that contains a refresh type for the cube.

getRefreshStartWithExpression

public final java.lang.String getRefreshStartWithExpression()
Gets the expression that indicates when the initial refresh of the materialized views occurs.
Returns:
A String that contains an expression that indicates when the initial refresh of the materialized views occurs.

setRefreshStartWithExpression

public final void setRefreshStartWithExpression(java.lang.String exp)
Specifies an expression that determines when the initial refresh of the materialized views occurs.
Parameters:
exp - A String that contains an expression that resolves to a datetime value.

getRefreshNextExpression

public final java.lang.String getRefreshNextExpression()
Gets the expression that indicates when the next refresh of the materialized views occurs.
Returns:
A String that contains an expression that indicates when the next refresh of the materialized views occurs.

setRefreshNextExpression

public final void setRefreshNextExpression(java.lang.String exp)
Specifies an expression that determines when the next refresh of the materialized views occurs. If an application sets a next refresh time, then it should also set the time for the initial refresh.
Parameters:
exp - A String that contains an expression that resolves to a datetime value.
See Also:
setRefreshStartWithExpression(java.lang.String)

getRefreshOnOption

public final java.lang.String getRefreshOnOption()
Gets the mode that Oracle OLAP uses to determine when to refresh the data contained in the materialized views that are associated with the dimension or cube. The mode is one of those indicated by the VALID_REFRESH_ON_OPTIONS constant.
Returns:
A String that contains the mode that determines when Oracle OLAP refreshes the data in the materialized views.

setRefreshOnOption

public final void setRefreshOnOption(java.lang.String option)
Specifies the mode that Oracle OLAP uses to determine when to refresh the data contained in the materialized views that are associated with the cube or dimension. The following table lists the constants that represent the valid values for the option parameter.
Constant Description
REFRESH_ON_DEMAND Specifies that Oracle OLAP refreshes the materialized views on demand.
REFRESH_ON_COMMIT Specifies that Oracle OLAP refreshes the materialized views when the database commits a transaction that affects a source table.
REFRESH_ON_DEFAULT Specifies that Oracle OLAP refreshes the materialized views on the default setting.
Parameters:
option - A String that contains a refresh on option for the cube.

getUsingConstraints

public final java.lang.String getUsingConstraints()
Gets the expression that indicates whether the USING_CONSTRAINST_CLAUSE specified is ENFORCED or TRUSTED
Returns:
A String that contains an expression that specifies the refresh constraints for the materialized views

setUsingConstraints

public final void setUsingConstraints(java.lang.String exp)
Specifies an expression that determines the Using Constraints clause for the materialized views.
Parameters:
exp - A String that contains an expression that determines the Using Constraints within the Refresh clasue for the materialized views

getXMLTag

protected getXMLTag()

Skip navigation links

Copyright © 2002, 2007, Oracle. All rights reserved.