|
Oracle® OLAP Analytic Workspace Java API Reference 10g Release 2 (10.2.0.3) B14351-03 Beta Draft |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectoracle.AWXML.BaseObject
oracle.AWXML.Measure
oracle.AWXML.OlapMeasure
public class OlapMeasure
A Measure that has values that result from certain OLAP
operations, such as a lead, lag, or moving average operation.
The operations are time series calculations that are based on values of
another Measure, which is the referenced Measure
for the operation.
The values of the referenced Measure are specified by the
members of a time Dimension.
Some operations involve members of Hierarchy or
Level.
Some operations use scalar or other values to identify values of the
referenced Measure that are involved in the calculation.
An OlapMeasure has an OLAP operator that determines the type of
OLAP operation.
You specify the OLAP operator with the setOlapOperator method.
The default value of the OLAP operator is LEAD.
The Measure and other objects that the operation references and
the values that it uses are specified by OlapMeasureInput
objects.
The following list has the OLAP operations that produce the values of an
OlapMeasure.
For descriptions of the operations, and for a table of the OLAP operator
values and the OlapMeasureInput keywords, objects, and values
required by the operations, see
OlapMeasure OLAP Operator
Values and OlapMeasureInput Keywords and Objects or Values.
To see the OLAP operator value and the OlapMeasureInput
referenced objects and values required for a specific operation, select an
item from the list.
An OlapMeasure is owned by a Cube.
To create an OlapMeasure object, use the
createOlapMeasure method of a Cube.
To create the OlapMeasure in the analytic workspace, call the
Create method of the OlapMeasure.
You can get a specific OlapMeasure object from a
Cube by calling the findDerivedMeasure method
of the Cube.
You can get all of the OlapMeasure and
DerivedMeasure objects by calling the
getDerivedMeasures method of the Cube.
To update the analytic workspace so that it retains the definition of the
OlapMeasure, call the Commit method of the
AW.
Because the analytic workspace dynamically calculates the values of an
OlapMeasure, you do not need to create
AWAction.BuildDatabase and AWAction.Interaction
objects to load the data in the measure.
Cube,
OlapMeasureInput| Field Summary |
|---|
| Fields inherited from class oracle.AWXML.BaseObject |
|---|
DATABASENULL |
| Constructor Summary | |
|---|---|
OlapMeasure(BaseObject input)
Creates an OlapMeasure for the specified Cube. |
|
| Method Summary | |
|---|---|
void |
addOlapMeasureInput(OlapMeasureInput input)
Adds the specified OlapMeasureInput to the list of
OlapMeasureInput objects of the OlapMeasure. |
java.lang.String |
Alter(AWConnection connection)
Alters the OlapMeasure in the current analytic workspace
of the specified database connection. |
java.lang.String |
Create(AWConnection connection)
Creates an OlapMeasure in the current analytic workspace
of the specified database connection. |
OlapMeasureInput |
createOlapMeasureInput()
Creates an OlapMeasureInput and adds it to the list
of OlapMeasureInput objects of the OlapMeasure. |
java.lang.String |
Delete(AWConnection connection)
Deletes the OlapMeasure in the current analytic workspace
of the specified database connection. |
java.lang.String |
getId()
Gets the identifier of the OlapMeasure. |
java.util.Vector |
getOlapMeasureInputs()
Gets the list of OlapMeasureInput objects of the
OlapMeasure. |
java.lang.String |
getOlapOperator()
Gets the operation specified for the OlapMeasure. |
boolean |
isValid()
Indicates whether the OlapMeasure is a valid object in
the analytic workspace. |
void |
removeOlapMeasureInput(OlapMeasureInput input)
Removes the specified OlapMeasureInput from the list of
OlapMeasureInput objects of the OlapMeasure. |
void |
setOlapOperator(java.lang.String input)
Specifies the OLAP operation for the OlapMeasure. |
java.lang.String |
WriteToXML()
Gets an XML representation of the OlapMeasure. |
| Methods inherited from class oracle.AWXML.Measure |
|---|
getAutoSolve, getDataType, getSolveDefinition, setAutoSolve, setDataType, setSolveDefinition |
| Methods inherited from class oracle.AWXML.BaseObject |
|---|
CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, 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 OlapMeasure(BaseObject input)
OlapMeasure for the specified Cube.
An application should create an OlapMeasure by using the
createOlapMeasure method of a Cube.
input - The Cube to own the OlapMeasure.| Method Detail |
|---|
public java.lang.String getId()
OlapMeasure.
For more information on object identifiers, see
Object Identifiers.
getId in class BaseObjectString that contains the identifier of the
OlapMeasure.public void setOlapOperator(java.lang.String input)
OlapMeasure.
The valid values for the input parameter are the following.
CUMLATIVE_TOTAL_TOTAL CUMULATIVE_TOTAL_PARENT LAG LEAD FUTURE_PERIOD MOVINGAVERAGE MOVINGMAX MOVINGMIN MOVINGTOTAL PERIOD_TO_DATE PRIOR_PERIOD PRIOR_PERIOD_VARIANCE PRIOR_PERIOD_VARIANCE_PERCENTAGE RANK_PARENT RANK_TOTAL SAME_PERIOD_ANCESTORS_AGO SAME_PERIOD_ANCESTORS_AGO_FVD SAME_PERIOD_ANCESTORS_AGO_VARIANCE SAME_PERIOD_ANCESTORS_AGO_VARIANCE_PERCENT SHARE_TO_LEVEL SHARE_TO_PARENT SHARE_TO_TOTAL YEAR_TO_DATE
For descriptions of these operations, see OlapMeasure OLAP Operator Values and OlapMeasureInput Keywords and Objects or Values.
input - A String that specifies an operation for the
OlapMeasure.public java.lang.String getOlapOperator()
OlapMeasure.
String that contains the operation specified for the
OlapMeasure.public void addOlapMeasureInput(OlapMeasureInput input)
OlapMeasureInput to the list of
OlapMeasureInput objects of the OlapMeasure.
input - The OlapMeasureInput to add.public void removeOlapMeasureInput(OlapMeasureInput input)
OlapMeasureInput from the list of
OlapMeasureInput objects of the OlapMeasure.
input - The OlapMeasureInput to remove.public java.util.Vector getOlapMeasureInputs()
OlapMeasureInput objects of the
OlapMeasure.
Vector containing the OlapMeasureInput
objects of the OlapMeasure.public OlapMeasureInput createOlapMeasureInput()
OlapMeasureInput and adds it to the list
of OlapMeasureInput objects of the OlapMeasure.
OlapMeasureInput.public java.lang.String WriteToXML()
OlapMeasure.
WriteToXML in class MeasureString that represents the
OlapMeasure.public java.lang.String Create(AWConnection connection)
OlapMeasure in the current analytic workspace
of the specified database connection.
To create an OlapMeasure, an application should use the
createOlapMeasure method of a Cube.
Create in class Measureconnection - The AWConnection that specifies the
database connection.
String if this method successfully creates
the OlapMeasure.public java.lang.String Alter(AWConnection connection)
OlapMeasure in the current analytic workspace
of the specified database connection.
Alter in class Measureconnection - The AWConnection that specifies the
database connection.
String that contains success if this
method successfully alters the OlapMeasure.public boolean isValid()
OlapMeasure is a valid object in
the analytic workspace.
boolean that is true if the
OlapMeasure is valid or false
if it is not valid.public java.lang.String Delete(AWConnection connection)
OlapMeasure in the current analytic workspace
of the specified database connection.
If it cannot delete the OlapMeasure, then this method throws
an AWException exception.
Delete in class Measureconnection - The AWConnection that represents the
database connection.
String that contains success if
the method deletes the OlapMeasure.
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||