oracle.AWXML
Class ForecastDefinition

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.SolveDefinition
              |
              +--oracle.AWXML.ForecastDefinition

public class ForecastDefinition

extends SolveDefinition

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 arguments that specify the forecasting method and other characteristics of the forecast. These arguments are implemented as keyword-value pairs by the OLAP DML FCSET command.

The OLAP DML supports a number of forecasting methods, including linear and non-linear regressions, single and double exponential smoothing, and the Holt-Winters method. If you are unsure of which method to use, then specify AUTOMATIC as the value for the METHOD keyword in a ForecastArgument.

The 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 OLAP DML Reference and the OLAP Application Developer's Guide.

See Also:

ForecastSolve

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 the specified argument to the ForecastDefinition.
java.lang.String	Create(AWConnection connection) Creates the ForecastDefinition in the current analytic workspace of the specified database connection.
ForecastArgument	createForecastArgument() Creates an argument for 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() Returns the arguments of the ForecastDefinition.
Measure	getSeasonalTarget() Returns the measure that holds the seasonal target of the forecast.
Measure	getSemiSeasonalTarget() Returns the measure that holds the semi-seasonal target of the forecast.
Dimension	getTimeDimension() Returns the time dimension of the source measure.
void	readAWDefinitions(AWConnection connection, boolean readType) Reads the objects owned by the ForecastDefinition into memory, making them available for processing within the current analytic workspace of the specified database connection.
void	removeForecastArgument(ForecastArgument input) Removes the specified argument from the ForecastDefinition.
void	setSeasonalTarget(Measure input) Sets the measure that holds the seasonal target of the forecast.
void	setSemiSeasonalTarget(Measure input) Sets the measure that holds the semi-seasonal target of the forecast.
void	setTimeDimension(Dimension input) Sets the time dimension of the source measure.
java.lang.String	WriteToXML() Returns the ForecastDefinition as an XML string.

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

ForecastDefinition

public ForecastDefinition(BaseObject input)

Creates a ForecastDefinition for the specified Cube.

Parameters:

input - The Cube that owns the ForecastDefinition.

Method Detail

Create

public java.lang.String Create(AWConnection connection)

Creates the ForecastDefinition in the current analytic workspace of the specified database connection.

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

Delete

public java.lang.String Delete(AWConnection connection)

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

Overrides:

Delete in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

WriteToXML

public java.lang.String WriteToXML()

Returns the ForecastDefinition as an XML string.

Overrides:

WriteToXML in class SolveDefinition

Returns:

A String containing the XML that represents the ForecastDefinition.

getTimeDimension

public Dimension getTimeDimension()

Returns the time dimension of the source measure.

Returns:

The Dimension that indexes the source data by time period.

setTimeDimension

public void setTimeDimension(Dimension input)

Sets the time dimension of the source measure.

Parameters:

input - The Dimension that indexes the source data by time period.

getSeasonalTarget

public Measure getSeasonalTarget()

Returns the measure that holds the seasonal target of the forecast.

Returns:

The seasonal target Measure.

setSeasonalTarget

public void setSeasonalTarget(Measure input)

Sets the measure that holds the seasonal target of the forecast.

Parameters:

input - The seasonal target Measure.

getSemiSeasonalTarget

public Measure getSemiSeasonalTarget()

Returns the measure that holds the semi-seasonal target of the forecast.

Returns:

The semi-seasonal target Measure.

setSemiSeasonalTarget

public void setSemiSeasonalTarget(Measure input)

Sets the measure that holds the semi-seasonal target of the forecast.

Parameters:

input - The Measure to specify as the semi-seasonal target.

addForecastArgument

public void addForecastArgument(ForecastArgument input)

Adds the specified argument to the ForecastDefinition.

Forecast arguments specify the forecast method and other characteristics of the forecast.

Parameters:

input - The ForecastArgument to add.

removeForecastArgument

public void removeForecastArgument(ForecastArgument input)

Removes the specified argument from the ForecastDefinition.

Parameters:

input - The ForecastArgument to remove.

getForecastArguments

public java.util.Vector getForecastArguments()

Returns the arguments of the ForecastDefinition.

Returns:

A Vector of ForecastArgument objects.

createForecastArgument

public ForecastArgument createForecastArgument()

Creates an argument for the ForecastDefinition.

Forecast arguments specify the forecast method and other characteristics of the forecast.

Returns:

The new ForecastArgument.

readAWDefinitions

public void readAWDefinitions(AWConnection connection,
                              boolean readType)

Reads the objects owned by the ForecastDefinition into memory, making them available for processing within the current analytic workspace of the specified database connection.

Parameters:

connection - The AWConnection that specifies the database connection.

readType - Specify True to read the ForecastDefinition and all its child objects. Specify False to read the ForecastDefinition but omit specific child objects.