public final class AggregationCommand extends SolveStepCommand implements ConsistentSolveCommand
SolveStepCommand
that represents an aggregation command in a BuildSpecification
.Modifier and Type | Field and Description |
---|---|
static boolean |
ALLOW_DIVISION_BY_ZERO_DEFAULT
A constant that indicates 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 indicates whether the aggregation maintains a count by default.
|
Constructor and Description |
---|
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 and that has the characteristics specified by the boolean parameters. |
AggregationCommand(java.lang.String functionName, FunctionArgument[] args, AggregationCase[] aggCases, MdmPrimaryDimension dim, MdmHierarchy[] hiers, boolean ignoreNulls, boolean allowOverflow, boolean allowDivisionByZero, boolean maintainCount, Condition membersCondition)
Creates an
AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies, that specifies a floor for the aggregation, and that has the characteristics specified by the boolean parameters. |
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 and that has the characteristics specified by the boolean parameters. |
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, Condition membersCondition)
Creates an
AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies, that specifies a floor for the aggregation, and that has the characteristics specified by the boolean parameters. |
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, Condition membersCondition, MdmBaseAttribute aggregationSwitch)
Creates an
AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies, that has the characteristics specified by the boolean parameters, that specifies a floor for the aggregation, and that specifies an attribute by which varying aggregation methods are specified. |
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, Condition membersCondition, MdmPrimaryDimension aggregationSwitch)
Creates an
AggregationCommand that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies, that has the characteristics specified by the boolean parameters, that specifies a floor for the aggregation, and that specifies a dimension by which varying aggregation methods are specified. |
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. |
Modifier and Type | Method and Description |
---|---|
AggregationCase[] |
getAggregationCases()
Gets the
AggregationCase objects that are associated with this AggregationCommand . |
MdmObject |
getAggregationSwitch()
Gets the aggregation switch that is associated with this
AggregationCommand . |
java.lang.String |
getAggregationSwitchID()
Gets the ID of the aggregation switch that is 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 . |
java.lang.String[] |
getHierarchyIDs()
Gets the IDs of 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.
|
Condition |
getMembersCondition()
Gets a
Condition that specifies a set of dimension members to use as a floor for the aggregation. |
MdmPrimaryDimension |
getPrimaryDimension()
Gets the dimension that is associated with this
AggregationCommand . |
java.lang.String |
getPrimaryDimensionID()
Gets the ID of 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 . |
getArguments, getFunctionDescriptor, getFunctionName
equals, equals, fromSyntax, fromSyntax, fromSyntax, fromSyntax, fromSyntax, isValid, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax, toSyntax
public static final boolean IGNORE_NULLS_DEFAULT
null
values by default.public static final boolean ALLOW_OVERFLOW_DEFAULT
public static final boolean ALLOW_DIVISION_BY_ZERO_DEFAULT
public static final boolean MAINTAIN_COUNT_DEFAULT
public AggregationCommand(java.lang.String functionName)
AggregationCommand
that specifies the aggregation of all of the summary data of the measures of a cube.functionName
- A String
that contains the name of the function to use for the aggregation.public AggregationCommand(java.lang.String functionName, FunctionArgument[] args, MdmPrimaryDimension dim)
AggregationCommand
that specifies the aggregation of the summary data of the measures of a cube for the specified dimension.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.public AggregationCommand(java.lang.String functionName, FunctionArgument[] args, MdmPrimaryDimension dim, MdmHierarchy[] hiers)
AggregationCommand
that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.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.public AggregationCommand(java.lang.String functionName, FunctionArgument[] args, AggregationCase[] aggCases, MdmPrimaryDimension dim, MdmHierarchy[] hiers, boolean ignoreNulls, boolean allowOverflow, boolean allowDivisionByZero, boolean maintainCount)
AggregationCommand
that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies and that has the characteristics specified by the boolean
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
- An array of AggregationCase
objects that redefine the aggregation for specific measures.dim
- The MdmPrimaryDimension
for which to aggregate the measure values.hiers
- An array of MdmHierarchy
objects for which to aggregate the measure values.ignoreNulls
- A boolean
that is true
to ignore null values or false
to not ignore them.allowOverflow
- A boolean
that is true
to allow overflows or false
to not allow them.allowDivisionByZero
- A boolean
that is true
to allow division by zero or false
to not allow it.maintainCount
- A boolean
that is true
to maintain a count or false
to not maintain one.public AggregationCommand(java.lang.String functionName, FunctionArgument[] args, AggregationCase[] aggCases, MdmPrimaryDimension dim, MdmHierarchy[] hiers, boolean ignoreNulls, boolean allowOverflow, boolean allowDivisionByZero, boolean maintainCount, Condition membersCondition)
AggregationCommand
that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies, that specifies a floor for the aggregation, and that has the characteristics specified by the boolean
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
- An array of AggregationCase
objects that redefine the aggregation for specific measures.dim
- The MdmPrimaryDimension
for which to aggregate the measure values.hiers
- An array of MdmHierarchy
objects for which to aggregate the measure values.ignoreNulls
- A boolean
that is true
to ignore null values or false
to not ignore them.allowOverflow
- A boolean
that is true
to allow overflows or false
to not allow them.allowDivisionByZero
- A boolean
that is true
to allow division by zero or false
to not allow it.maintainCount
- A boolean
that is true
to maintain a count or false
to not maintain one.membersCondition
- A Condition
that specifies a set of dimension members to use as a floor for aggregation.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)
AggregationCommand
that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies and that has the characteristics specified by the boolean
parameters.functionName
- A String
that contains the name of the function to use for the aggregation.args
- A List
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.ignoreNulls
- A boolean
that is true
to ignore null values or false
to not ignore them.allowOverflow
- A boolean
that is true
to allow overflows or false
to not allow them.allowDivisionByZero
- A boolean
that is true
to allow division by zero or false
to not allow it.maintainCount
- A boolean
that is true
to maintain a count or false
to not maintain one.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, Condition membersCondition)
AggregationCommand
that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies, that specifies a floor for the aggregation, and that has the characteristics specified by the boolean
parameters.functionName
- A String
that contains the name of the function to use for the aggregation.args
- A List
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.ignoreNulls
- A boolean
that is true
to ignore null values or false
to not ignore them.allowOverflow
- A boolean
that is true
to allow overflows or false
to not allow them.allowDivisionByZero
- A boolean
that is true
to allow division by zero or false
to not allow it.maintainCount
- A boolean
that is true
to maintain a count or false
to not maintain one.membersCondition
- A Condition
that specifies a set of dimension members to use as a floor for aggregation.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, Condition membersCondition, MdmPrimaryDimension aggregationSwitch)
AggregationCommand
that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies, that has the characteristics specified by the boolean
parameters, that specifies a floor for the aggregation, and that specifies a dimension by which varying aggregation methods are specified.
With the aggregationSwitch
, you can vary the aggregation method by dimension member. You specify a dimension member with the aggregationSwitchValue
of an AggregationCase
. You specify the aggregation function to use for that member with the functionName
parameter of the AggregationCase
.
If the AggregationCommand
has an AggregationCase
that has a null aggregationSwitchValue
, then the aggregation varies by measure.
functionName
- A String
that contains the name of the function to use for the aggregation.args
- A List
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.ignoreNulls
- A boolean
that is true
to ignore null values or false
to not ignore them.allowOverflow
- A boolean
that is true
to allow overflows or false
to not allow them.allowDivisionByZero
- A boolean
that is true
to allow division by zero or false
to not allow it.maintainCount
- A boolean
that is true
to maintain a count or false
to not maintain one.membersCondition
- A Condition
that specifies a set of dimension members to use as a floor for aggregation.aggregationSwitch
- The MdmPrimaryDimension
by which varying aggregation methods are specified.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, Condition membersCondition, MdmBaseAttribute aggregationSwitch)
AggregationCommand
that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies, that has the characteristics specified by the boolean
parameters, that specifies a floor for the aggregation, and that specifies an attribute by which varying aggregation methods are specified.
With the aggregationSwitch
, you can vary the aggregation method by attribute value. You specify an attribute value with the aggregationSwitchValue
of an AggregationCase
. You specify the aggregation function to use for that attribute value with the functionName
parameter of the AggregationCase
.
If the AggregationCommand
has an AggregationCase
that has a null aggregationSwitchValue
, then the aggregation varies by measure.
functionName
- A String
that contains the name of the function to use for the aggregation.args
- A List
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.ignoreNulls
- A boolean
that is true
to ignore null values or false
to not ignore them.allowOverflow
- A boolean
that is true
to allow overflows or false
to not allow them.allowDivisionByZero
- A boolean
that is true
to allow division by zero or false
to not allow it.maintainCount
- A boolean
that is true
to maintain a count or false
to not maintain one.membersCondition
- A Condition
that specifies a set of dimension members to use as a floor for aggregation.aggregationSwitch
- The MdmBaseAttribute
by which varying aggregation methods are specified.public AggregationCommand(java.lang.String functionName, java.util.List<FunctionArgument> args, MdmPrimaryDimension dim, java.util.List<MdmHierarchy> hiers)
AggregationCommand
that specifies the aggregation of the summary data of the measures of a cube for the specified dimension hierarchies.functionName
- A String
that contains the name of the function to use for the aggregation.args
- A List
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.public java.lang.Object visit(SyntaxObjectVisitor visitor, java.lang.Object context)
visitAggregationCommand
method of the SyntaxObjectVisitor
and passes that method this AggregationCommand
and an Object
.visit
in class SyntaxObject
visitor
- A SyntaxObjectVisitor
.context
- An Object
.Object
returned by the visitAggregationCommand
method.public MdmHierarchy[] getHierarchies()
AggregationCommand
.MdmHierarchy
objects of this AggregationCommand
.public java.lang.String[] getHierarchyIDs()
AggregationCommand
.String
objects that contain the IDs of the MdmHierarchy
objects of this AggregationCommand
.public AggregationCase[] getAggregationCases()
AggregationCase
objects that are associated with this AggregationCommand
.AggregationCase
associated with this AggregationCommand
.public MdmPrimaryDimension getPrimaryDimension()
AggregationCommand
.MdmPrimaryDimension
of this AggregationCommand
.public java.lang.String getPrimaryDimensionID()
AggregationCommand
.String
that contains the ID of the dimension of this AggregationCommand
.public MdmObject getAggregationSwitch()
AggregationCommand
.MdmObject
that is the aggregation switch of this AggregationCommand
.public java.lang.String getAggregationSwitchID()
AggregationCommand
.String
that contains the ID of the MdmObject
that is the aggregation switch of this AggregationCommand
.public boolean getIgnoreNulls()
null
values.boolean
that indicates whether the aggregation ignores null
values.public boolean getAllowOverflow()
boolean
that indicates whether the aggregation allows overflows.public boolean getAllowDivisionByZero()
boolean
that indicates whether the aggregation allows division by zero.public boolean getMaintainCount()
boolean
that indicates whether the aggregation maintains a count.public Condition getMembersCondition()
Condition
that specifies a set of dimension members to use as a floor for the aggregation.Condition
that specifies a set of dimension members or null
if this AggregationCommand
does not have such a Condition
.