Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2.0.3)

B14351-03 Beta Draft

oracle.AWXML
Class DimensionMemberExpression

java.lang.Object
  extended by oracle.AWXML.BaseObject
      extended by oracle.AWXML.DimensionMemberExpression

public class DimensionMemberExpression
extends BaseObject

A set of dimension members for a DimensionMemberSelection or a PreComputeClause. A DimensionMemberExpression can specify a Level or an expression that identifies one or more dimension members. A DimensionMemberExpression also has an expression type that specifies whether to include or exclude the indicated members in the operation that uses the DimensionMemberExpression.


Field Summary
 
Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL
 
Constructor Summary
DimensionMemberExpression(BaseObject input)
          Creates a DimensionMemberExpression for the specified DimensionMemberSelection or PreComputeClause.
 
Method Summary
 java.lang.String getExpression()
          Gets the expression specified by the DimensionMemberExpression.
 java.lang.String getExpressionText()
          Gets the expression type and either the text expression or the identifier of the Level specified by the DimensionMemberExpression.
 java.lang.String getExpressionType()
          Gets the expression type specified for the DimensionMemberExpression.
 Level getLevel()
          Gets the Level specified by the DimensionMemberExpression.
 void setExpression(java.lang.String input)
          Specifies an expression that identifies one or more members of a Dimension.
 void setExpressionType(java.lang.String input)
          Specifies an expression type for the DimensionMemberExpression.
 void setLevel(Level input)
          Specifies the Level that has the members that you want to include or exclude from the selection.
 java.lang.String WriteToXML()
          Gets an XML representation of the DimensionMemberExpression.
 
Methods inherited from class oracle.AWXML.BaseObject
Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DimensionMemberExpression

public DimensionMemberExpression(BaseObject input)
Creates a DimensionMemberExpression for the specified DimensionMemberSelection or PreComputeClause. An application should create a DimensionMemberExpression by using the createDimensionMemberExpression method of the DimensionMemberSelection or PreComputeClause.

Parameters:
input - The DimensionMemberSelection or PreComputeClause to own the new DimensionMemberExpression.
Method Detail

getExpressionType

public java.lang.String getExpressionType()
Gets the expression type specified for the DimensionMemberExpression. The expression type can be INCLUDE or EXCLUDE.

Returns:
A String that contains the expression type specified for the DimensionMemberExpression.

setExpressionType

public void setExpressionType(java.lang.String input)
Specifies an expression type for the DimensionMemberExpression. The expression type can be INCLUDE or EXCLUDE. The expression type specifies whether the DimensionMemberSelection includes or excludes the members specified by the DimensionMemberExpression in the selection of members that it represents.

Parameters:
input - A String that contains INCLUDE if you want the DimensionMemberSelection to include the specified members or EXCLUDE if you want the selection to exclude the members.

getExpression

public java.lang.String getExpression()
Gets the expression specified by the DimensionMemberExpression.

Returns:
A String that contains the expression specified by the DimensionMemberExpression.

setExpression

public void setExpression(java.lang.String input)
Specifies an expression that identifies one or more members of a Dimension. You can specify all members, an individual member, or a group of members by attribute value or hierarchical relationship. If you specify Dimension members with this method, then do not use the setLevel method.

To indicate all members of a Dimension, specify ALL as the input parameter value.

You can specify an individual Dimension member by using the following syntax. Put the member value inside single quotes.

  Dimension_name.DIMENSION:'Member_value'

The following example specifies the member of the PRODUCT_AW Dimension that has the value 13.

  dimMemberExpr.setExpression("PRODUCT_AW.DIMENSION:'13'");

To specify a list of Dimension members, use the following syntax. Use a space to separate member name values.

  Dimension_name.DIMENSION:LIST:'Member_value1' 'Member_value2' 'Member_value3'...

The following example specifies the members of the PRODUCT_AW Dimension that have the values 8, 9, 10, and 11.

  dimMemberExpr.setExpression("PRODUCT_AW.DIMENSION:LIST:'8' '9' '10' '11'");

You can specify dimension members by Attribute value. The syntax for specifying Dimension members by Attribute value is the following.

  Dimension_name.Attribute_name.ATTRIBUTE='Attribute_value'

The following example specifies the members of the PRODUCT_AW Dimension that have the related PACKAGE_AW Attribute value of Executive.

  dimMemberExpr.setExpression("PRODUCT_AW.PACKAGE_AW.ATTRIBUTE='Executive'");

The syntax for specifying Dimension members by hierarchical relationship is the following.

  Dimension_Name.PARENT.Hierarchy_name:'Child_dimension_member'

  Dimension_Name.CHILDREN.Hierarchy_name:'Parent_dimension_member'

  Dimension_Name.ANCESTORS.Hierarchy_name:'Descendent_dimension_member'

  Dimension_Name.DESCENDENTS.Hierarchy_name:'Ancestor_dimension_member'

The following example specifies the members of the PRODUCT_AW Dimension that are the children of Dimension member 7 in the PRODUCT_ROLLUP_AW Hierarchy.

  dimMemberExpr.setExpression("PRODUCT_AW.CHILDREN.PRODUCT_ROLLUP_AW:'7'");

Parameters:
input - A String that contains an expression that specifies one or more members of a Dimension.

setLevel

public void setLevel(Level input)
Specifies the Level that has the members that you want to include or exclude from the selection.

If you specify a Level with this method, then do not use the setExpression method.

Parameters:
input - The Level that has the members to select.

getLevel

public Level getLevel()
Gets the Level specified by the DimensionMemberExpression.

Returns:
The Level specified by the DimensionMemberExpression.

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the DimensionMemberExpression.

Overrides:
WriteToXML in class BaseObject
Returns:
An XML String that represents the DimensionMemberExpression.

getExpressionText

public java.lang.String getExpressionText()
Gets the expression type and either the text expression or the identifier of the Level specified by the DimensionMemberExpression.

Returns:
A String that contains the expression type and the text expression or Level identifier.

Copyright © 2003, 2006 Oracle. All rights reserved.