|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.4) B14351-04 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectoracle.AWXML.BaseObject
oracle.AWXML.SolveDefinition
oracle.AWXML.AggregationDefinition
A SolveDefinition that specifies aggregation instructions
for an AggregationSolve.
For a diagram of AggregationDefinition associations, see
AggregationDefinition Class
Associations.
An AggregationDefinition is owned by a Cube.
An AggregationDefinition owns an ordered set of
CalculationSpecification objects, each one
specifying how to aggregate the data along one of its dimensions.
Position within the calculation list determines when each calculation is
performed.
A CalculationSpecification can be either an
Aggregation or a ModelRef.
An Aggregation specifies the aggregation instructions for a
hierarchical dimension.
A ModelRef uses a Model to specify aggregation
instructions, typically for a non-hierarchical Dimension such
as a dimension of line items or for a CalculatedMember.
AggregationSolve| Field Summary |
| Fields inherited from class oracle.AWXML.BaseObject |
DATABASENULL |
| Constructor Summary | |
AggregationDefinition(BaseObject input)
Creates an AggregationDefinition for the specified
Cube. |
|
| Method Summary | |
void |
addCalculationSpecification(CalculationSpecification input)
Adds the specified CalculationSpecification to the end of the
list of CalculationSpecification objects for the
AggregationDefinition. |
void |
addCalculationSpecificationAfter(CalculationSpecification input,
BaseObject reference)
Adds the specified CalculationSpecification after the
referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition. |
void |
addCalculationSpecificationBefore(CalculationSpecification input,
BaseObject reference)
Adds the specified CalculationSpecification before the
referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition. |
void |
addCalculationSpecificationFirst(CalculationSpecification input)
Adds the specified CalculationSpecification to the beginning
of the list of CalculationSpecification objects for the
AggregationDefinition. |
void |
addSolveDefDimRef(SolveDefDimRef input)
Adds the specified solve definition dimension reference to the AggregationDefinition. |
java.lang.String |
Create(AWConnection connection)
Creates the AggregationDefinition in the current analytic
workspace of the specified database connection. |
AggregationHierarchySpecification |
createAggregationHierarchySpecification()
Creates an AggregationHierarchySpecification and adds it to
the end of the list of CalculationSpecification objects for
the AggregationDefinition. |
AggregationHierarchySpecification |
createAggregationHierarchySpecificationAfter(CalculationSpecification input)
Creates an AggregationHierarchySpecification and adds it after
the referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition. |
AggregationHierarchySpecification |
createAggregationHierarchySpecificationBefore(CalculationSpecification input)
Creates an AggregationHierarchySpecification and adds it before
the referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition. |
AggregationHierarchySpecification |
createAggregationHierarchySpecificationFirst()
Creates an AggregationHierarchySpecification and adds it to
the beginning of the list of CalculationSpecification objects
for the AggregationDefinition. |
ModelRef |
createModelRef()
Creates a new ModelRef and adds it to the end of the list of
CalculationSpecification objects for the
AggregationDefinition. |
ModelRef |
createModelRefAfter(CalculationSpecification input)
Creates a ModelRef and adds it after
the referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition. |
ModelRef |
createModelRefBefore(CalculationSpecification input)
Creates a ModelRef and adds it before
the referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition. |
ModelRef |
createModelRefFirst()
Creates a new ModelRef and adds it to the beginning of the
list of CalculationSpecification objects for the
AggregationDefinition. |
SolveDefDimRef |
createSolveDefDimRef()
Creates a solve definition dimension reference and adds it to the list of SolveDefDimRef objects for the
AggregationDefinition. |
java.lang.String |
Delete(AWConnection connection)
Deletes the AggregationDefinition in the current analytic
workspace of the specified database connection. |
java.lang.String |
getAggIndex()
Gets a value that indicates whether the AggregationDefinition
specifies the creation of indexes for data that is calculated by the
aggregation operation. |
java.lang.String |
getCacheNa()
Gets a value that indicates whether the AggregationDefinition
specifies the storing of NA values that result from the
aggregation operation. |
java.lang.String |
getCacheStore()
Gets a value that indicates whether the AggregationDefinition
specifies the storing of data that is calculated by the aggregation
operation. |
java.util.Vector |
getCalculationSpecification()
Gets the list of CalculationSpecification objects
for the AggregationDefinition. |
java.util.Vector |
getSolveDefDimRefs()
Gets the list of solve definition dimension references for the AggregationDefinition. |
void |
removeCalculationSpecification(CalculationSpecification input)
Removes the specified CalculationSpecification from the
list of CalculationSpecification objects
for the AggregationDefinition. |
void |
removeSolveDefDimRef(SolveDefDimRef input)
Removes the specified solve definition dimension reference from the AggregationDefinition. |
void |
setAggIndex(java.lang.String input)
Specifies whether the AggregationDefinition creates indexes
for values that are calculated by the aggregation operation. |
void |
setCacheNa(java.lang.String input)
Specifies whether the analytic workspace stores NA values that
result from the calculations of the aggregation operation. |
void |
setCacheStore(java.lang.String input)
Specifies whether Oracle OLAP stores the data calculated by the aggregation operation. |
java.lang.String |
WriteToXML()
Gets an XML representation of the AggregationDefinition. |
| Methods inherited from class oracle.AWXML.BaseObject |
Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, 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 |
public AggregationDefinition(BaseObject input)
AggregationDefinition for the specified
Cube.
input - The Cube that you want to own the
AggregationDefinition.| Method Detail |
public java.lang.String getAggIndex()
AggregationDefinition
specifies the creation of indexes for data that is calculated by the
aggregation operation.
String that contains YES if the
AggregationDefinition specifies the creation of
indexes or NO if it does not.public void setAggIndex(java.lang.String input)
AggregationDefinition creates indexes
for values that are calculated by the aggregation operation.
If you want the aggregation to create indexes, then specify YES
as the input value.
If you do not want to create indexes, then specify NO.
input - A String that contains YES if you
want the aggregation operation to create indexes for data
values that it calculates or NO if you do not.public java.lang.String getCacheStore()
AggregationDefinition
specifies the storing of data that is calculated by the aggregation
operation.
String that contains STORES if the
AggregationDefinition specifies the storing of
aggregated data or NOSTORE if it does not.public void setCacheStore(java.lang.String input)
STORE
as the input value.
If you do not want to store the aggregated data, specify
NOSTORE.
input - A String that contains STORE if you
want to store the data calculated by the aggregation operation
or NOSTORE if you do not.public java.lang.String getCacheNa()
AggregationDefinition
specifies the storing of NA values that result from the
aggregation operation.
String that contains NA if the
AggregationDefinition specifies the storing of
NA values or NONA if it does not.public void setCacheNa(java.lang.String input)
NA values that
result from the calculations of the aggregation operation.
If you want to store the calcualted NA values, then specify
NA as the input value.
If you do not want to store NA values, then specify
NONA.
input - A String that contains NA if you
want to store NA values calculated by the
aggregation operation or NONA if you do not.public java.lang.String WriteToXML()
AggregationDefinition.
WriteToXML in class SolveDefinitionString that represents the
AggregationDefinition.public java.util.Vector getCalculationSpecification()
CalculationSpecification objects
for the AggregationDefinition.
Vector that contains
CalculationSpecification objects.public void removeCalculationSpecification(CalculationSpecification input)
CalculationSpecification from the
list of CalculationSpecification objects
for the AggregationDefinition.
input - The CalculationSpecification to remove from
the list.public void addCalculationSpecification(CalculationSpecification input)
CalculationSpecification to the end of the
list of CalculationSpecification objects for the
AggregationDefinition.
input - The CalculationSpecification to add to the end of
the list.
public void addCalculationSpecificationAfter(CalculationSpecification input,
BaseObject reference)
CalculationSpecification after the
referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition.
input - The CalculationSpecification to add to the list.reference - The CalculationSpecification in the list
after which to add the
CalculationSpecification.
public void addCalculationSpecificationBefore(CalculationSpecification input,
BaseObject reference)
CalculationSpecification before the
referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition.
input - The CalculationSpecification to add to the list.reference - The CalculationSpecification in the list
before which to add the
CalculationSpecification.public void addCalculationSpecificationFirst(CalculationSpecification input)
CalculationSpecification to the beginning
of the list of CalculationSpecification objects for the
AggregationDefinition.
input - The CalculationSpecification to add to the
beginning of the list.public void addSolveDefDimRef(SolveDefDimRef input)
AggregationDefinition.
input - The SolveDefDimRef to add to the
AggregationDefinition.public void removeSolveDefDimRef(SolveDefDimRef input)
AggregationDefinition.
input - The SolveDefDimRef to remove from the
AggregationDefinition.public java.util.Vector getSolveDefDimRefs()
AggregationDefinition.
Vector of the SolveDefDimRef objects
owned by the AggregationDefinition.public SolveDefDimRef createSolveDefDimRef()
SolveDefDimRef objects for the
AggregationDefinition.
SolveDefDimRef for the
AggregationDefinition.public AggregationHierarchySpecification createAggregationHierarchySpecification()
AggregationHierarchySpecification and adds it to
the end of the list of CalculationSpecification objects for
the AggregationDefinition.
AggregationHierarchySpecification for the
AggregationDefinition.public AggregationHierarchySpecification createAggregationHierarchySpecificationAfter(CalculationSpecification input)
AggregationHierarchySpecification and adds it after
the referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition.
input - The CalculationSpecification in the list
after which to add the new
AggregationHierarchySpecification.
AggregationHierarchySpecification.public AggregationHierarchySpecification createAggregationHierarchySpecificationBefore(CalculationSpecification input)
AggregationHierarchySpecification and adds it before
the referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition.
input - The CalculationSpecification in the list
before which to add the new
CalculationSpecification.
AggregationHierarchySpecification.public AggregationHierarchySpecification createAggregationHierarchySpecificationFirst()
AggregationHierarchySpecification and adds it to
the beginning of the list of CalculationSpecification objects
for the AggregationDefinition.
AggregationHierarchySpecification for the
AggregationDefinition.public ModelRef createModelRef()
ModelRef and adds it to the end of the list of
CalculationSpecification objects for the
AggregationDefinition.
ModelRef for the
AggregationDefinition.public ModelRef createModelRefAfter(CalculationSpecification input)
ModelRef and adds it after
the referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition.
input - The CalculationSpecification in the list
after which to add the new ModelRef.
ModelRef.public ModelRef createModelRefBefore(CalculationSpecification input)
ModelRef and adds it before
the referenced CalculationSpecification in the list of
CalculationSpecification objects for the
AggregationDefinition.
input - The CalculationSpecification in the list
before which to add the new ModelRef.
ModelRef.public ModelRef createModelRefFirst()
ModelRef and adds it to the beginning of the
list of CalculationSpecification objects for the
AggregationDefinition.
ModelRef for the
AggregationDefinition.public java.lang.String Create(AWConnection connection)
AggregationDefinition in the current analytic
workspace of the specified database connection.
Create in class BaseObjectconnection - The AWConnection that represents the
database connection.
String that contains success if the
method creates the AggregationDefinition.public java.lang.String Delete(AWConnection connection)
AggregationDefinition in the current analytic
workspace of the specified database connection.
Delete in class BaseObjectconnection - The AWConnection that specifies the database
connection.
String that contains success if the
method deletes the AggregationDefinition.
|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.4) B14351-04 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||