oracle.AWXML
Class ForecastSolve

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.Solve
              |
              +--oracle.AWXML.ForecastSolve

public class ForecastSolve

extends Solve

A Solve that specifies a forecast operation in an analytic workspace. A forecast projects data into future time periods based on past performance. Oracle OLAP supports linear and non-linear regressions, single and double exponential smoothing, and Holt-Winters as methods of forecasting.

A ForecastSolve has a ForecastDefinition that specifies the criteria for the forecast. The ForecastDefinition has ForecastArgument objects that specifiy the forecasting method and other characteristics of the forecast.

For more information on OLAP forecasting, see the Oracle OLAP Application Developer's Guide.

See Also:

ForecastDefinition, SolveGroup

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

ForecastSolve(BaseObject input)
Creates a ForecastSolve and adds it to the specified SolveGroup.

Method Summary

java.lang.String	Alter(AWConnection connection) Alters the text attributes of the ForecastSolve in an analytic workspace.
java.lang.String	Create(AWConnection connection) Creates a ForecastSolve and adds it to the end of the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.
java.lang.String	CreateAfter(AWConnection connection, BaseObject referencedObj) Creates a ForecastSolve and adds it after the referenced ForecastSolve to the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.
java.lang.String	CreateBefore(AWConnection connection, BaseObject referencedObj) Creates a ForecastSolve and adds it before the referenced ForecastSolve to the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.
java.lang.String	CreateFirst(AWConnection connection) Creates a ForecastSolve and adds it at the beginning of the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.
java.lang.String	Delete(AWConnection connection) Deletes the ForecastSolve from the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.
ForecastDefinition	getForecastDefinition() Gets the ForecastDefinition that defines the forecasting rules for this ForecastSolve.
Measure	getSource() Gets the Measure that is the source of the data on which to base the forecast.
Measure	getTarget() Gets the Measure that is the target for the results of the forecast.
void	setForecastDefinition(ForecastDefinition input) Specifies the ForecastDefinition that defines the forecasting rules for this ForecastSolve.
void	setSource(Measure input) Specifies a Measure as the source of the data that is the basis of the forecast.
void	setTarget(Measure input) Specifies a Measure as the target for the results of the forecast.
java.lang.String	WriteToXML() Gets an XML representation of the ForecastSolve.

Methods inherited from class oracle.AWXML.Solve

addDimensionMemberSelection, createDimensionMemberSelection, getDimensionMemberSelection, getSolveOrder, readAWDefinitions, removeDimensionMemberSelection, setSolveOrder, setSolveOrder

Methods inherited from class oracle.AWXML.BaseObject

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

ForecastSolve

public ForecastSolve(BaseObject input)

Creates a ForecastSolve and adds it to the specified SolveGroup.

Parameters:

input - The SolveGroup to which to add the new ForecastSolve.

Method Detail

setTarget

public void setTarget(Measure input)

Specifies a Measure as the target for the results of the forecast.

Parameters:

input - The Measure that you want to be the target of the forecast.

getTarget

public Measure getTarget()

Gets the Measure that is the target for the results of the forecast.

Returns:

The Measure that is the target of the forecast.

setSource

public void setSource(Measure input)

Specifies a Measure as the source of the data that is the basis of the forecast.

Parameters:

input - The Measure that you want to be the source of the data for the forecast.

getSource

public Measure getSource()

Gets the Measure that is the source of the data on which to base the forecast.

Returns:

The Measure that is the source of the data for the forecast.

setForecastDefinition

public void setForecastDefinition(ForecastDefinition input)

Specifies the ForecastDefinition that defines the forecasting rules for this ForecastSolve.

Parameters:

input - The ForecastDefinition that you want this ForecastSolve to have.

getForecastDefinition

public ForecastDefinition getForecastDefinition()

Gets the ForecastDefinition that defines the forecasting rules for this ForecastSolve.

Returns:

The ForecastDefinition for the ForecastSolve.

Create

public java.lang.String Create(AWConnection connection)

Creates a ForecastSolve and adds it to the end of the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

A String that contains success if the method successfully creates the ForecastSolve.

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)

Creates a ForecastSolve and adds it at the beginning of the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.

Overrides:

CreateFirst in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

A String that contains success if the method successfully creates the ForecastSolve.

CreateAfter

public java.lang.String CreateAfter(AWConnection connection,
                                    BaseObject referencedObj)

Creates a ForecastSolve and adds it after the referenced ForecastSolve to the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.

Overrides:

CreateAfter in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

referencedObj - The ForecastSolve after which you want to add the new ForecastSolve.

Returns:

A String that contains success if the method successfully creates the ForecastSolve.

CreateBefore

public java.lang.String CreateBefore(AWConnection connection,
                                     BaseObject referencedObj)

Creates a ForecastSolve and adds it before the referenced ForecastSolve to the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.

Overrides:

CreateBefore in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

referencedObj - The ForecastSolve before which you want to add the new ForecastSolve.

Returns:

A String that contains success if the method successfully creates the ForecastSolve.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the ForecastSolve from the list of Solve objects of the SolveGroup that is owned by the AW object that represents the current analytic workspace of the specified database connection.

Overrides:

Delete in class Solve

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

A String that contains success if this method successfully deletes the ForecastSolve.

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the ForecastSolve.

Overrides:

WriteToXML in class Solve

Returns:

An XML String that represents the ForecastSolve.

Alter

public java.lang.String Alter(AWConnection connection)

Alters the text attributes of the ForecastSolve in an analytic workspace.

Overrides:

Alter in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

A String that contains success if the method successfully alters the ForecastSolve.