*** This class is subject to change. ***

com.sas.iquery.metadata.expr
Class FractionOfTotalExpression

com.sas.iquery.metadata.expr.FractionOfTotalExpression

All Implemented Interfaces:

Base, BusinessModelResourceReferencer, ModelItem, UsabilityInterface, ExpressionInterface, PropertyChangeListenee, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class FractionOfTotalExpression
implements ExpressionInterface

Models a numeric expression that represents a fraction of a total value in a business query.

This modeled fraction is of the form A/B where A is a numeric measure data item on one axis of the query and B is a category data item on the other axis of the query. By axis we mean the ROW or COLUMN Role applied to a data item that is a result item in the query. The A/B expression is a division, or comparison, that results in a fractional value. If desired, this fractional value can be formatted with the SAS PERCENTw.d format (for example, PERCENT4.1) so that it may be easily displayed in visual percentage form.

The numerator, A, as a numeric measure data item is straightforward to specify. Specifying the denominator is a bit more complex. This is because the specific axis the denominator is set on affects the results of the query.

• Specifying a null denominator represents a comparison against the grand total.
• Specifying the innermost row category item as the denominator represents a comparison against the row's total.
• Specifying the innermost column category item as the denominator represents a comparison against the column's total.
• Specifying any other category item as the denominator represents a comparison against sub-totals related to the given category on that category's axis.

  This expression is only supported when directly set on a DataItem and used as a result item in a query. Use of this expression as a subexpression is not supported.

  Field Summary

  static int	DENOMINATOR_IS_COLUMN_SUBTOTAL A constant used to indicate that the denominator to be used in calculating the fraction is the subtotal values on column axis.
  static int	DENOMINATOR_IS_COLUMN_TOTAL A constant used to indicate that the denominator to be used in calculating the fraction is the column total value.
  static int	DENOMINATOR_IS_GRAND_TOTAL A constant used to indicate that the denominator to be used in calculating the fraction is the grand total value.
  static int	DENOMINATOR_IS_ROW_SUBTOTAL A constant used to indicate that the denominator to be used in calculating the fraction is the subtotal values on row axis.
  static int	DENOMINATOR_IS_ROW_TOTAL A constant used to indicate that the denominator to be used in calculating the fraction is the row total value.
  static int	DENOMINATOR_IS_SUBTOTAL_OF_CATEGORY_DATA_ITEM A constant used to indicate that the denominator to be used in calculating the fraction is the subtotal values for the category data item set on this expression.
  static java.lang.String	EVENT_DENOMINATOR_CHANGED Indication that the denominator specification (the category data item or denominator value) have changed.
  static java.lang.String	EVENT_NUMERATOR_CHANGED Indication that the numerator has changed.

  Fields inherited from interface com.sas.iquery.metadata.business.ModelItem

  EVENT_OBJECT_PROPERTY_CHANGED

  Fields inherited from interface com.sas.iquery.metadata.business.Base

  EVENT_OBJECT_DEFINITION_CHANGED

  Constructor Summary

  FractionOfTotalExpression()
  Instantiates a new FractionOfTotalExpression object with no numerator or denominator set.

  Method Summary

  DataItem	getDenominator() Returns the denominator of this fraction expression.
  int	getDenominatorType() Returns a value indicating which type of denominator value to use.
  int	getExpressionType() Return the integer form of the expression type.
  DataItem	getNumerator() Returns the numerator data item used in the computation of the fractional value.
  void	setDenominator(DataItem denominator) Sets the denominator of this fraction expression to be the subtotal values for the given category data item.
  void	setDenominatorType(int denominatorType) Sets the denominator of this expression to the given value -- from the list of constant values in this class that start with the letters "DENOMINATOR_IS_".
  void	setNumerator(DataItem numerator) Sets the numerator used in the computation of the fractional value to be the specified data item.

  Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResourceReferencer

  getResources

  Methods inherited from interface com.sas.iquery.metadata.PropertyChangeListenee

  addListener, getListeners, removeListener

  Methods inherited from interface com.sas.iquery.metadata.business.UsabilityInterface

  getReasonsUnusable, isUsableInQuery

  Field Detail

  *** This field is subject to change. ***

  EVENT_NUMERATOR_CHANGED

  public static final java.lang.String EVENT_NUMERATOR_CHANGED

  Indication that the numerator has changed.

  See Also:

  Constant Field Values

  *** This field is subject to change. ***

  EVENT_DENOMINATOR_CHANGED

  public static final java.lang.String EVENT_DENOMINATOR_CHANGED

  Indication that the denominator specification (the category data item or denominator value) have changed.

  See Also:

  Constant Field Values

  *** This field is subject to change. ***

  DENOMINATOR_IS_SUBTOTAL_OF_CATEGORY_DATA_ITEM

  public static final int DENOMINATOR_IS_SUBTOTAL_OF_CATEGORY_DATA_ITEM

  A constant used to indicate that the denominator to be used in calculating the fraction is the subtotal values for the category data item set on this expression. When this object is created or instantiated, this is the default value set in the object.

  Note: This value is only applicable to relational table or ROLAP (as of Version 9.2)

  See Also:

  Constant Field Values

  *** This field is subject to change. ***

  DENOMINATOR_IS_GRAND_TOTAL

  public static final int DENOMINATOR_IS_GRAND_TOTAL

  A constant used to indicate that the denominator to be used in calculating the fraction is the grand total value.

  See Also:

  Constant Field Values

  *** This field is subject to change. ***

  DENOMINATOR_IS_ROW_TOTAL

  public static final int DENOMINATOR_IS_ROW_TOTAL

  A constant used to indicate that the denominator to be used in calculating the fraction is the row total value.

  See Also:

  Constant Field Values

  *** This field is subject to change. ***

  DENOMINATOR_IS_COLUMN_TOTAL

  public static final int DENOMINATOR_IS_COLUMN_TOTAL

  A constant used to indicate that the denominator to be used in calculating the fraction is the column total value.

  See Also:

  Constant Field Values

  *** This field is subject to change. ***

  DENOMINATOR_IS_ROW_SUBTOTAL

  public static final int DENOMINATOR_IS_ROW_SUBTOTAL

  A constant used to indicate that the denominator to be used in calculating the fraction is the subtotal values on row axis.

  See Also:

  Constant Field Values

  *** This field is subject to change. ***

  DENOMINATOR_IS_COLUMN_SUBTOTAL

  public static final int DENOMINATOR_IS_COLUMN_SUBTOTAL

  A constant used to indicate that the denominator to be used in calculating the fraction is the subtotal values on column axis.

  See Also:

  Constant Field Values

  Constructor Detail

  *** This constructor is subject to change. ***

  FractionOfTotalExpression

  public FractionOfTotalExpression()

  Instantiates a new FractionOfTotalExpression object with no numerator or denominator set.

  Method Detail

  *** This method is subject to change. ***

  getNumerator

  public DataItem getNumerator()

  Returns the numerator data item used in the computation of the fractional value.

  Returns:

  a data item representing the numerator

  *** This method is subject to change. ***

  setNumerator

  public void setNumerator(DataItem numerator)
                    throws MetadataException

  Sets the numerator used in the computation of the fractional value to be the specified data item.

  Parameters:

  numerator - to be used in the computation of the fractional value

  Throws:

  java.lang.IllegalArgumentException - when a non-null measure data item is given as the numerator.

  MetadataException

  *** This method is subject to change. ***

  getDenominator

  public DataItem getDenominator()

  Returns the denominator of this fraction expression.

  Returns:

  a data item representing the denominator

  *** This method is subject to change. ***

  setDenominator

  public void setDenominator(DataItem denominator)
                      throws MetadataException

  Sets the denominator of this fraction expression to be the subtotal values for the given category data item. Setting a category data item via this method also causes the "denominator type" to be set to DENOMINATOR_IS_SUBTOTAL_OF_CATEGORY_DATA_ITEM.

  Parameters:

  denominator - a category data item (getUsage() returns DataItemActionType.USAGE_CATEGORY) to be used as the denominator in this expression.

  Throws:

  java.lang.IllegalArgumentException - when a non-null non-category data item is given as the denominator.

  MetadataException

  *** This method is subject to change. ***

  setDenominatorType

  public void setDenominatorType(int denominatorType)

  Sets the denominator of this expression to the given value -- from the list of constant values in this class that start with the letters "DENOMINATOR_IS_". Calling this method with a valid value other than DENOMINATOR_IS_SUBTOTAL_OF_CATEGORY_DATA_ITEM will cause any denominator data item specified by setDenominator(DataItem) to be cleared. That is, a later call to getDenominator() will return null.

  Parameters:

  denominatorType - a value indicating how the denominator portion of the fraction should be determined. Values set on this method should be static constant integers from this class that start with the letters "DENOMINATOR_IS_".

  Throws:

  java.lang.IllegalArgumentException - when a value other than one of the valid constants is specified.

  *** This method is subject to change. ***

  getDenominatorType

  public int getDenominatorType()

  Returns a value indicating which type of denominator value to use. The integer value returned should be compared against the static constant integer values in this class that start with the letters "DENOMINATOR_IS_".

  Returns:

  an integer value indicating which type of denominator value to use in the fraction.

  *** This method is subject to change. ***

  getExpressionType

  public int getExpressionType()

  Description copied from interface: ExpressionInterface

  Return the integer form of the expression type.

  Specified by:

  getExpressionType in interface ExpressionInterface

  Returns:

  an expression type from class ExpressionTypes

  *** This class is subject to change. ***