oracle.AWXML
Class ForecastSolve

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

public class ForecastSolve

extends Solve

A Solve that calculates a forecast in an analytic workspace.

Forecasting is the process of projecting data into future time periods based on past performance. The OLAP DML supports linear and non-linear regressions, single and double exponential smoothing, and the Holt-Winters method.

A ForecastSolve uses a ForecastDefinition to specify the criteria for the forecast. A ForecastDefinition includes a set of arguments that specify the forecasting method and other characteristics of the forecast.

For more information on OLAP forecasting, see the OLAP DML Reference and the 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 in the specified SolveGroup.

Method Summary

java.lang.String	Alter(AWConnection connection) Alters the class attributes of the object in the current analytic workspace of the specified database connection.
java.lang.String	Create(AWConnection connection) Creates the ForecastSolve in the current analytic workspace of the specified database connection, and adds it to the end of the list of solves in the owning SolveGroup
java.lang.String	CreateAfter(AWConnection connection, BaseObject referencedObj) Creates the ForecastSolve in the current analytic workspace of the specified database connection, and inserts it in the SolveGroup after the specified Solve.
java.lang.String	CreateBefore(AWConnection connection, BaseObject referencedObj) Creates the ForecastSolve in the current analytic workspace of the specified database connection, and inserts it in the SolveGroup before the specified Solve.
java.lang.String	CreateFirst(AWConnection connection) Creates the ForecastSolve in the current analytic workspace of the specified database connection, and appends it to the beginning of the list of solves in the owning SolveGroup.
java.lang.String	Delete(AWConnection connection) Deletes the ForecastSolve in the current analytic workspace of the specified database connection.
ForecastDefinition	getForecastDefinition() Returns the ForecastDefinition that defines the rules for this ForecastSolve.
Measure	getSource() Returns the measure that contains the source data.
Measure	getTarget() Returns the target for the results of the forecast.
void	setForecastDefinition(ForecastDefinition input) Sets the ForecastDefinition that defines the rules for this ForecastSolve.
void	setSource(Measure input) Sets the measure that contains the source data.
void	setTarget(Measure input) Sets the target for the results of the forecast.
java.lang.String	WriteToXML() Returns the ForecastSolve as an XML string.

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 in the specified SolveGroup.

Parameters:

input - The SolveGroup that owns the ForecastSolve.

Method Detail

setTarget

public void setTarget(Measure input)

Sets the target for the results of the forecast.

Parameters:

input - The target Measure.

getTarget

public Measure getTarget()

Returns the target for the results of the forecast.

Returns:

The target Measure.

setSource

public void setSource(Measure input)

Sets the measure that contains the source data.

Parameters:

input - The source Measure.

getSource

public Measure getSource()

Returns the measure that contains the source data.

Returns:

The source Measure.

setForecastDefinition

public void setForecastDefinition(ForecastDefinition input)

Sets the ForecastDefinition that defines the rules for this ForecastSolve.

Parameters:

input - The ForecastDefinition to use.

getForecastDefinition

public ForecastDefinition getForecastDefinition()

Returns the ForecastDefinition that defines the rules for this ForecastSolve.

Returns:

The ForecastDefinition used by this ForecastSolve.

Create

public java.lang.String Create(AWConnection connection)

Creates the ForecastSolve in the current analytic workspace of the specified database connection, and adds it to the end of the list of solves in the owning SolveGroup

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

CreateFirst

public java.lang.String CreateFirst(AWConnection connection)

Creates the ForecastSolve in the current analytic workspace of the specified database connection, and appends it to the beginning of the list of solves in the owning SolveGroup.

Overrides:

CreateFirst in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

CreateAfter

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

Creates the ForecastSolve in the current analytic workspace of the specified database connection, and inserts it in the SolveGroup after the specified Solve.

Overrides:

CreateAfter in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

referencedObj - The referenced Solve.

Returns:

"success" if successful.

CreateBefore

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

Creates the ForecastSolve in the current analytic workspace of the specified database connection, and inserts it in the SolveGroup before the specified Solve.

Overrides:

CreateBefore in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

referencedObj - The referenced Solve.

Returns:

"success" if successful.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the ForecastSolve in the current analytic workspace of the specified database connection.

Overrides:

Delete in class Solve

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

WriteToXML

public java.lang.String WriteToXML()

Returns the ForecastSolve as an XML string.

Overrides:

WriteToXML in class Solve

Returns:

A String containing the XML that represents the ForecastSolve.

Alter

public java.lang.String Alter(AWConnection connection)

Description copied from class: BaseObject

Alters the class attributes of the object in the current analytic workspace of the specified database connection. You can use the Alter method to change descriptive names of the object or to reset the schema of a top-level object. To alter the structural definition of a BaseObject, you must create, modify, or remove its owned objects.

Overrides:

Alter in class BaseObject

Tags copied from class: BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

If successful, a String that contains success.