|
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.SolveDefinition
oracle.AWXML.ForecastDefinition
public class ForecastDefinition
A SolveDefinition that specifies
forecasting instructions for a ForecastSolve.
For a diagram of the class associations of ForecastSolve, see
ForecastDefinition
Associations.
A ForecastDefinition is owned by a Cube.
A ForecastDefinition owns ForecastArgument objects
that specify the forecasting method and other characteristics of the forecast.
Each characteristic is represented by a ForecastArgument.
A
Oracle OLAP supports a number of forecasting methods, including
linear and non-linear regressions, single and double exponential smoothing,
and the Holt-Winters method.
You can specify a method, but the Oracle OLAP determines the best method
to use for your data based on past performance and overrides your choice if
it is inappropriate for your data.
The AUTOMATIC method, which is the default, is the best choice because it
defers to the best fit.
The
ForecastArgument has a ForeCastKeyWord and a
ForecastArgumentValue.
Together the keyword and the argument value specify an argument that affects
the forecasting operation.
For a list of the forecast argument keywords and associated argument values,
and descriptions of them, see
Forecast Argument Keywords and Values.
ForecastDefinition class includes methods for
identifying the time dimension and specifying seasonal and
semi-seasonal targets (if they are used by the chosen forecasting method).
For more information on OLAP forecasting, see the
Oracle OLAP Application Developer's Guide.
ForecastSolve
| Field Summary |
|---|
| Fields inherited from class oracle.AWXML.BaseObject |
|---|
DATABASENULL |
| Constructor Summary | |
|---|---|
ForecastDefinition(BaseObject input)
Creates a ForecastDefinition for the specified
Cube. |
|
| Method Summary | |
|---|---|
void |
addForecastArgument(ForecastArgument input)
Adds a ForecastArgument to the list of
ForecastArgument objects owned by the
ForecastDefinition. |
java.lang.String |
Create(AWConnection connection)
Creates a ForecastDefinition in the current analytic workspace
of the specified database connection. |
ForecastArgument |
createForecastArgument()
Creates a ForecastArgument and adds it to the list of
ForecastArgument objects owned by the
ForecastDefinition. |
java.lang.String |
Delete(AWConnection connection)
Deletes the ForecastDefinition in the current analytic
workspace of the specified database connection. |
java.util.Vector |
getForecastArguments()
Gets the list of ForecastArgument objects owned by the
ForecastDefinition. |
Measure |
getSeasonalTarget()
Gets the Measure that is the seasonal target for the
ForecastDefinition. |
Measure |
getSemiSeasonalTarget()
Gets the Measure that is the semi-seasonal target for the
ForecastDefinition. |
Dimension |
getTimeDimension()
Gets the Time Dimension specified for the
ForecastDefinition. |
void |
removeForecastArgument(ForecastArgument input)
Removes a ForecastArgument from the list of
ForecastArgument objects owned by the
ForecastDefinition. |
void |
setSeasonalTarget(Measure input)
Specifies a Measure as the seasonal target for the
ForecastDefinition. |
void |
setSemiSeasonalTarget(Measure input)
Specifies a Measure as the semi-seasonal target for the
ForecastDefinition. |
void |
setTimeDimension(Dimension input)
Specifies a Time Dimension for the
ForecastDefinition. |
java.lang.String |
WriteToXML()
Gets an XML representation of the ForecastDefinition. |
| 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 ForecastDefinition(BaseObject input)
ForecastDefinition for the specified
Cube.
input - The Cube to own the
ForecastDefinition.| Method Detail |
|---|
public java.lang.String Create(AWConnection connection)
ForecastDefinition in the current analytic workspace
of the specified database connection.
Create in class BaseObjectconnection - The AWConnection that specifies the database
connection.
String that contains success if this
method successfully creates the ForecastDefinition.public java.lang.String Delete(AWConnection connection)
ForecastDefinition 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 this
method successfully deletes the ForecastDefinition.public java.lang.String WriteToXML()
ForecastDefinition.
WriteToXML in class SolveDefinitionString that represents the
ForecastDefinition.public Dimension getTimeDimension()
Dimension specified for the
ForecastDefinition.
Dimension for the
ForecastDefinition.public void setTimeDimension(Dimension input)
Dimension for the
ForecastDefinition.
input - The Time Dimension for the
ForecastDefinition.public Measure getSeasonalTarget()
Measure that is the seasonal target for the
ForecastDefinition.
Measure that is the seasonal target for the
ForecastDefinition.public void setSeasonalTarget(Measure input)
Measure as the seasonal target for the
ForecastDefinition.
input - The Measure to specify as the seasonal target
for the ForecastDefinition.public Measure getSemiSeasonalTarget()
Measure that is the semi-seasonal target for the
ForecastDefinition.
Measure that is the semi-seasonal target for the
ForecastDefinition.public void setSemiSeasonalTarget(Measure input)
Measure as the semi-seasonal target for the
ForecastDefinition.
input - The Measure to specify as the semi-seasonal
target for the ForecastDefinition.public void addForecastArgument(ForecastArgument input)
ForecastArgument to the list of
ForecastArgument objects owned by the
ForecastDefinition.
A ForecastArgument has a pair of
ForeCastKeyWord and ForecastArgumentValue objects
that together specify a characteristic of the forecasting operation.
input - The ForecastArgument to add.public void removeForecastArgument(ForecastArgument input)
ForecastArgument from the list of
ForecastArgument objects owned by the
ForecastDefinition.
input - The ForecastArgument to remove.public java.util.Vector getForecastArguments()
ForecastArgument objects owned by the
ForecastDefinition.
Vector that contains the
ForecastArgument objects owned by the
ForecastDefinition.public ForecastArgument createForecastArgument()
ForecastArgument and adds it to the list of
ForecastArgument objects owned by the
ForecastDefinition.
A ForecastArgument has a pair of
ForeCastKeyWord and ForecastArgumentValue objects
that together specify a characteristic of the forecasting operation.
ForecastArgument.
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||