oracle.olapi.metadata.mtm
Class MtmAWView

java.lang.Object
  |
  +--oracle.olapi.metadata.BaseMetadataObject
        |
        +--oracle.olapi.metadata.mtm.MtmObject
              |
              +--oracle.olapi.metadata.mtm.MtmTabularSource
                    |
                    +--oracle.olapi.metadata.mtm.MtmTableOrView
                          |
                          +--oracle.olapi.metadata.mtm.MtmAWView

public class MtmAWView

extends MtmTableOrView

An MtmTableOrView that is mapped to a dynamically generated inline view, for a dynamic analytic workspace, or to a static relational view, for a non-dynamic analytic workspace. By calling the isDynamicView method, you can determine whether an MtmAWView represents an object that is mapped to a dynamic analytic workspace.

A dynamic analytic workspace is created using the Oracle OLAP Analytic Workspace Java API. A non-dynamic analytic workspace can be created by a database administrator through Oracle Enterprise Manager.

Method Summary

java.lang.Object	acceptVisitor(MtmObjectVisitor visitor, java.lang.Object context) Calls the visitMtmAWView method of the specified MtmObjectVisitor and passes that method this MtmAWView and the specified Object.
MtmColumnExpression	addColumn(java.lang.String columnName) Adds the specified column to the MtmTableOrView.
java.lang.String	getAWName() Gets the name of the view for the analytic workspace to which this MtmAWView is mapped.
MtmColumnExpression	getRowToCellExpression() Gets the MtmColumnExpression that represents the column specified as the r2c parameter in the OLAP_EXPRESSION function call for this MtmAWView.
boolean	isDynamicView() Indicates whether the view to which this object is mapped is a static relational view or a dynamically generated inline view.
void	setAWName(java.lang.String awName) Specifies the name of the view for the analytic workspace to which the object that this MtmAWView represents is mapped.
void	setIsDynamicView(boolean isDynamicView) Specifies whether this MtmAWView is mapped to a view for a dynamic analytic workspace.
void	setRowToCellExpression(MtmColumnExpression exp) Specifies the MtmColumnExpression that should represent the column indicated as the r2c parameter in the OLAP_EXPRESSION function call for this MtmAWView.

Methods inherited from class oracle.olapi.metadata.mtm.MtmTableOrView

getColumns, getName, setName

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getID

Methods inherited from class java.lang.Object

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

Method Detail

acceptVisitor

public java.lang.Object acceptVisitor(MtmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMtmAWView method of the specified MtmObjectVisitor and passes that method this MtmAWView and the specified Object.

Overrides:

acceptVisitor in class MtmObject

Parameters:

visitor - An MtmObjectVisitor.

context - An Object.

Returns:

The Object returned by the visitMtmAWView method.

getRowToCellExpression

public MtmColumnExpression getRowToCellExpression()

Gets the MtmColumnExpression that represents the column specified as the r2c parameter in the OLAP_EXPRESSION function call for this MtmAWView. The OLAP_EXPRESSION function works together with an OLAP_TABLE function to create a SQL expression. For information about these two functions, see the Oracle OLAP Reference.

Use this method only for an MtmAWView that represents a relational view, which is one for which the isDynamicView method returns false.

Returns:

The MtmColumnExpression that represents the r2c column for this MtmAWView.

setRowToCellExpression

public void setRowToCellExpression(MtmColumnExpression exp)

Specifies the MtmColumnExpression that should represent the column indicated as the r2c parameter in the OLAP_EXPRESSION function call for this MtmAWView. The OLAP_EXPRESSION function works together with an OLAP_TABLE function to create a SQL expression. For information about these two functions, see the Oracle OLAP Reference.

Use this method only for an MtmAWView that represents a relational view, which is one for which the isDynamicView method returns false.

Parameters:

exp - An MtmColumnExpression that specifies a column for the r2c parameter in the OLAP_EXPRESSION function call for this MtmAWView.

setAWName

public void setAWName(java.lang.String awName)

Specifies the name of the view for the analytic workspace to which the object that this MtmAWView represents is mapped. Use this method only for an object that is mapped to a static analytic workspace view and not for one that is mapped to a dynamic analytic workspace view.

Parameters:

awName - An String that specifies a name for the analytic workspace view to which this MtmAWView is mapped.

getAWName

public java.lang.String getAWName()

Gets the name of the view for the analytic workspace to which this MtmAWView is mapped. If the view for the analytic workspace is a static relational view, then you can use in a SQL expression the name that this method returns. For example, you could use the name in the FROM clause in a SELECT expression.

Returns:

A String that contains the name of the analytic workspace.

isDynamicView

public boolean isDynamicView()

Indicates whether the view to which this object is mapped is a static relational view or a dynamically generated inline view. A dynamic analytic workspace has a dynamically generated inline view, and an analytic workspace created by a database administrator through Oracle Enterprise Manager has a static relational view.

Returns:

true if this MtmAWView is mapped to a dynamically generated inline view, or false if it is not.

setIsDynamicView

public void setIsDynamicView(boolean isDynamicView)

Specifies whether this MtmAWView is mapped to a view for a dynamic analytic workspace. Oracle OLAP uses this method when an Oracle OLAP Analytic Workspace Java API program creates a dynamic analytic workspace.

In an OLAP API application, use this method only for an MtmAWView that is mapped to a static a relational view; therefore, do not specify true with this method.

Parameters:

isDynamicView - A boolean that specifies whether this MtmAWView is mapped to a view for a dynamic analytic workspace.

addColumn

public MtmColumnExpression addColumn(java.lang.String columnName)

Adds the specified column to the MtmTableOrView. The column must exist in the data store. This method creates an MtmColumnExpression that represents the new column and provides the MtmColumnExpression as a return value.

Use this method only for an MtmAWView that represents a relational view, which is one for which the isDynamicView method returns false.

Overrides:

addColumn in class MtmTableOrView

Parameters:

columnName - A String that contains the name of the relational column to add to this MtmTableOrView.

Returns:

An MtmColumnExpression that represents the relational column that is being added to this MtmTableOrView.