Oracle OLAP Analytic Workspace Java API Reference: Class ForecastDefinition

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle OLAP Analytic Workspace Java API Reference
10g Release 1 (10.1)
B12180-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.AWXML
Class ForecastDefinition

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

public class ForecastDefinition
extends SolveDefinition

The rules that define a forecast based on a measure or a group of measures within a cube. The forecast is formulated as a FORECAST command in the OLAP DML. A FORECAST command forecasts data using one of three methods: straight-line trend, exponential growth, or Holt-Winters extrapolation.

Use the following link to view a graphical representation of oracle.AWXML.ForecastDefinition.

OLAP Analytic Workspace Forecasting Model

Fields inherited from class oracle.AWXML.BaseObject

AWNULL, DATABASENULL, m_commandResults, m_commandResultText, m_id, m_listResults, m_longName, m_name, m_owner, m_pluralName, m_schema, m_shortName, s_EndElementTag, s_EndEndTag, s_EndStartTag, s_EndTag, s_Indent, s_JAVA_LINEEND, s_NEWLINE, s_objectCounter, s_StartEndTag, s_StartStartTag

Constructor Summary
`ForecastDefinition(BaseObject input)` Constructor that takes the owner of this object.

Method Summary
`void`	`addForecastArgument(ForecastArgument input)`
`java.lang.String`	`Create(AWConnection connection)` Creates a new forecast in the analytic workspace.
`ForecastArgument`	`createForecastArgument()`
`java.lang.String`	`Delete(AWConnection connection)` Removes a forecast from the analytic workspace.
`java.util.Vector`	`getForecastArguments()`
`Measure`	`getSeasonalTarget()`
`Measure`	`getSemiSeasonalTarget()`
`Dimension`	`getTimeDimension()`
`void`	`readAWMetaData(AWConnection connection)`
`void`	`removeForecastArgument(ForecastArgument input)`
`void`	`setSeasonalTarget(Measure input)`
`void`	`setSemiSeasonalTarget(Measure input)`
`void`	`setTimeDimension(Dimension input)`
`java.lang.String`	`WriteToXML()` Returns the object as an XML string.

Methods inherited from class oracle.AWXML.SolveDefinition

getId, getParentId

Methods inherited from class oracle.AWXML.BaseObject

Alter, CreateAfter, CreateBefore, CreateFirst, getLongName, getName, getOwner, getPluralName, getSchema, getShortName, setLongName, setName, setPluralName, setSchema, 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)

Constructor that takes the owner of this object.

Parameters:: input - BaseObject that is the owner of this object in the object model

Method Detail

Create

public java.lang.String Create(AWConnection connection)

Creates a new forecast in the analytic workspace.

Overrides:: Create in class BaseObject

Parameters:: connection - AWConnection

Delete

public java.lang.String Delete(AWConnection connection)

Removes a forecast from the analytic workspace.

Overrides:: Delete in class BaseObject

Parameters:: connection - AWConnection

WriteToXML

public java.lang.String WriteToXML()

Returns the object as an XML string.

Overrides:: WriteToXML in class SolveDefinition

Returns:: A String containing the XML that represents the object

getTimeDimension

public Dimension getTimeDimension()

Returns:

setTimeDimension

public void setTimeDimension(Dimension input)

Returns:

getSeasonalTarget

public Measure getSeasonalTarget()

Returns:

setSeasonalTarget

public void setSeasonalTarget(Measure input)

Returns:

getSemiSeasonalTarget

public Measure getSemiSeasonalTarget()

Returns:

setSemiSeasonalTarget

public void setSemiSeasonalTarget(Measure input)

Returns:

addForecastArgument

public void addForecastArgument(ForecastArgument input)

Returns:

removeForecastArgument

public void removeForecastArgument(ForecastArgument input)

Returns:

getForecastArguments

public java.util.Vector getForecastArguments()

Returns:

createForecastArgument

public ForecastArgument createForecastArgument()

Returns:

readAWMetaData

public void readAWMetaData(AWConnection connection)