|
Oracle® OLAP Java API Reference 11g Release 2 (11.2) E10794-01 Beta Draft |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectoracle.olapi.syntax.SyntaxObject
oracle.olapi.syntax.BuildCommand
oracle.olapi.syntax.SimpleCommand
oracle.olapi.syntax.SolveStepCommand
oracle.olapi.syntax.AggregationCommand
public final class AggregationCommand
A SolveStepCommand that represents an aggregation command
in a BuildSpecification.
| Field Summary | |
|---|---|
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 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,
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. |
|
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,
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. |
|
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. |
Condition |
getMembersCondition()
Gets a Condition that specifies a set of dimension members to
use as a floor for aggregation. |
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, toSyntax |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static boolean IGNORE_NULLS_DEFAULT
null
values by default.
public static boolean ALLOW_OVERFLOW_DEFAULT
public static boolean ALLOW_DIVISION_BY_ZERO_DEFAULT
public static boolean MAINTAIN_COUNT_DEFAULT
| Constructor Detail |
|---|
public AggregationCommand(java.lang.String functionName)
AggregationCommand that specifies the
aggregation of all of the summary data of the measures of a cube.
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.
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
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.
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.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.
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 measuresdim - The MdmPrimaryDimension for which to aggregate
the measure values.hiers - A List of MdmHierarchy objects for
which to aggregate the measure values.
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.
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 measuresdim - The MdmPrimaryDimension for which to aggregate
the measure values.hiers - A List of MdmHierarchy objects for
which to aggregate the measure values.membersCondition - specifies the set of members to use as a floor for aggregation
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 - 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 |
|---|
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 SyntaxObjectvisitor - A SyntaxObjectVisitor.context - An Object.
Object returned by the
visitAggregationCommand method.public MdmHierarchy[] getHierarchies()
AggregationCommand.
MdmHierarchy objects of this
AggregationCommand.public AggregationCase[] getAggregationCases()
AggregationCase that are associated with this
AggregationCommand.
AggregationCase associated with this
AggregationCommand.public MdmPrimaryDimension getPrimaryDimension()
AggregationCommand.
MdmPrimaryDimension 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 aggregation.
Condition that specifies a set of dimension members or
null if this AggregationCommand does not
have such a Condition.
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||