Skip navigation links

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

B28128-03


oracle.olapi.syntax
Class AggregationCommand

java.lang.Object
  extended by oracle.olapi.syntax.SyntaxObject
      extended by oracle.olapi.syntax.BuildCommand
          extended by oracle.olapi.syntax.SimpleCommand
              extended by oracle.olapi.syntax.SolveStepCommand
                  extended by oracle.olapi.syntax.AggregationCommand

All Implemented Interfaces:
ConsistentSolveCommand

public final class AggregationCommand
extends SolveStepCommand
implements ConsistentSolveCommand

A SolveStepCommand that represents an aggregation command in a BuildSpecification.


Field Summary
static boolean ALLOW_DIVISION_BY_ZERO_DEFAULT
          A constant that idicates whether the aggregation allows division by zero by default.
static boolean ALLOW_OVERFLOW_DEFAULT
          A constant that indicates whether the aggregation allows overflow by default.
static boolean IGNORE_NULLS_DEFAULT
          A constant that indicates whether the aggregation ignores null values by default.
static boolean MAINTAIN_COUNT_DEFAULT
          A constant that idicates whether the aggregation maintains a count by default.

 

Constructor Summary
AggregationCommand(java.lang.String functionName)
          Creates an AggregationCommand that specifies the aggregation of all of the summary data of the measures of a cube.
AggregationCommand(java.lang.String functionName, FunctionArgument[] args, AggregationCase[] aggCases, MdmPrimaryDimension dim, MdmHierarchy[] hiers, boolean ignoreNulls, boolean allowOverflow, boolean allowDivisionByZero, boolean maintainCount)
          Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.
AggregationCommand(java.lang.String functionName, FunctionArgument[] args, MdmPrimaryDimension dim)
          Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension.
AggregationCommand(java.lang.String functionName, FunctionArgument[] args, MdmPrimaryDimension dim, MdmHierarchy[] hiers)
          Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.
AggregationCommand(java.lang.String functionName, java.util.List<FunctionArgument> args, java.util.List<AggregationCase> aggCases, MdmPrimaryDimension dim, java.util.List<MdmHierarchy> hiers, boolean ignoreNulls, boolean allowOverflow, boolean allowDivisionByZero, boolean maintainCount)
          Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.
AggregationCommand(java.lang.String functionName, java.util.List<FunctionArgument> args, MdmPrimaryDimension dim, java.util.List<MdmHierarchy> hiers)
          Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.

 

Method Summary
 AggregationCase[] getAggregationCases()
          Gets the AggregationCase that are associated with this AggregationCommand.
 boolean getAllowDivisionByZero()
          Indicates whether the aggregation allows division by zero.
 boolean getAllowOverflow()
          Indicates whether the aggregation allows overflows.
 MdmHierarchy[] getHierarchies()
          Gets the hierarchies that are associated with this AggregationCommand.
 boolean getIgnoreNulls()
          Indicates whether the aggregation ignores null values.
 boolean getMaintainCount()
          Indicates whether the aggregation maintains a count.
 MdmPrimaryDimension getPrimaryDimension()
          Gets the dimension that is associated with this AggregationCommand.
 java.lang.Object visit(SyntaxObjectVisitor visitor, java.lang.Object context)
          Calls the visitAggregationCommand method of the SyntaxObjectVisitor and passes that method this AggregationCommand and an Object.

 

Methods inherited from class oracle.olapi.syntax.SolveStepCommand
getArguments, getFunctionDescriptor, getFunctionName

 

Methods inherited from class oracle.olapi.syntax.SyntaxObject
equals, equals, fromSyntax, fromSyntax, fromSyntax, fromSyntax, fromSyntax, isValid, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

IGNORE_NULLS_DEFAULT

public static boolean IGNORE_NULLS_DEFAULT
A constant that indicates whether the aggregation ignores null values by default.

ALLOW_OVERFLOW_DEFAULT

public static boolean ALLOW_OVERFLOW_DEFAULT
A constant that indicates whether the aggregation allows overflow by default.

ALLOW_DIVISION_BY_ZERO_DEFAULT

public static boolean ALLOW_DIVISION_BY_ZERO_DEFAULT
A constant that idicates whether the aggregation allows division by zero by default.

MAINTAIN_COUNT_DEFAULT

public static boolean MAINTAIN_COUNT_DEFAULT
A constant that idicates whether the aggregation maintains a count by default.

Constructor Detail

AggregationCommand

public AggregationCommand(java.lang.String functionName)
Creates an AggregationCommand that specifies the aggregation of all of the summary data of the measures of a cube.

AggregationCommand

public AggregationCommand(java.lang.String functionName,
                          FunctionArgument[] args,
                          MdmPrimaryDimension dim)
Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension.
Parameters:
functionName - A String that contains the name of the function to use for the aggregation.
args - An array of FunctionArgument objects that specify aspects of the aggregation.
dim - The MdmPrimaryDimension for which to aggregate the measure values.

AggregationCommand

public AggregationCommand(java.lang.String functionName,
                          FunctionArgument[] args,
                          MdmPrimaryDimension dim,
                          MdmHierarchy[] hiers)
Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.
Parameters:
functionName - A String that contains the name of the function to use for the aggregation.
args - An array of FunctionArgument objects that specify aspects of the aggregation.
dim - The MdmPrimaryDimension for which to aggregate the measure values.
hiers - An array of MdmHierarchy objects for which to aggregate the measure values.

AggregationCommand

public AggregationCommand(java.lang.String functionName,
                          FunctionArgument[] args,
                          AggregationCase[] aggCases,
                          MdmPrimaryDimension dim,
                          MdmHierarchy[] hiers,
                          boolean ignoreNulls,
                          boolean allowOverflow,
                          boolean allowDivisionByZero,
                          boolean maintainCount)
Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.
Parameters:
functionName - A String that contains the name of the function to use for the aggregation.
args - An array of FunctionArgument objects that specify aspects of the aggregation.
dim - The MdmPrimaryDimension for which to aggregate the measure values.
hiers - An array of MdmHierarchy objects for which to aggregate the measure values.
aggCases - An array of AggregationCase objects that redefine the aggregation for specific measures

AggregationCommand

public AggregationCommand(java.lang.String functionName,
                          java.util.List<FunctionArgument> args,
                          java.util.List<AggregationCase> aggCases,
                          MdmPrimaryDimension dim,
                          java.util.List<MdmHierarchy> hiers,
                          boolean ignoreNulls,
                          boolean allowOverflow,
                          boolean allowDivisionByZero,
                          boolean maintainCount)
Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.
Parameters:
functionName - A String that contains the name of the function to use for the aggregation.
args - An array of FunctionArgument objects that specify aspects of the aggregation.
aggCases - A List of AggregationCase objects that redefine the aggregation for specific measures
dim - The MdmPrimaryDimension for which to aggregate the measure values.
hiers - A List of MdmHierarchy objects for which to aggregate the measure values.

AggregationCommand

public AggregationCommand(java.lang.String functionName,
                          java.util.List<FunctionArgument> args,
                          MdmPrimaryDimension dim,
                          java.util.List<MdmHierarchy> hiers)
Creates an AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.
Parameters:
functionName - A String that contains the name of the function to use for the aggregation.
args - An array of FunctionArgument objects that specify aspects of the aggregation.
dim - The MdmPrimaryDimension for which to aggregate the measure values.
hiers - A List of MdmHierarchy objects for which to aggregate the measure values.

Method Detail

visit

public java.lang.Object visit(SyntaxObjectVisitor visitor,
                              java.lang.Object context)
Calls the visitAggregationCommand method of the SyntaxObjectVisitor and passes that method this AggregationCommand and an Object.
Specified by:
visit in class SyntaxObject
Parameters:
visitor - A SyntaxObjectVisitor.
context - An Object.
Returns:
The Object returned by the visitAggregationCommand method.

getHierarchies

public MdmHierarchy[] getHierarchies()
Gets the hierarchies that are associated with this AggregationCommand.
Returns:
An array of the MdmHierarchy objects of this AggregationCommand.

getAggregationCases

public AggregationCase[] getAggregationCases()
Gets the AggregationCase that are associated with this AggregationCommand.
Returns:
An array of the AggregationCase associated with this AggregationCommand.

getPrimaryDimension

public MdmPrimaryDimension getPrimaryDimension()
Gets the dimension that is associated with this AggregationCommand.
Returns:
The MdmPrimaryDimension of this AggregationCommand.

getIgnoreNulls

public boolean getIgnoreNulls()
Indicates whether the aggregation ignores null values.
Returns:
A boolean that indicates whether the aggregation ignores null values.

getAllowOverflow

public boolean getAllowOverflow()
Indicates whether the aggregation allows overflows.
Returns:
A boolean that indicates whether the aggregation allows overflows.

getAllowDivisionByZero

public boolean getAllowDivisionByZero()
Indicates whether the aggregation allows division by zero.
Returns:
A boolean that indicates whether the aggregation allows division by zero.

getMaintainCount

public boolean getMaintainCount()
Indicates whether the aggregation maintains a count.
Returns:
A boolean that indicates whether the aggregation maintains a count.

Skip navigation links

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