oracle.AWXML
Class ForecastArgument

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.ForecastArgument

public class ForecastArgument

extends BaseObject

An argument to a ForecastDefinition.

An argument consists of a keyword-value pair. In most cases, the keyword has a single value.

The forecasting keywords, listed below, are accepted by the OLAP DML FCSET command. See the OLAP DML Reference for a complete explanation of each keyword.

    Keyword             Values
    ALLOCLAST          'YES'|'NO' 
    ALPHA MAX           decimal
    ALPHA MIN           decimal
    ALPHA STEP          decimal 
    APPROACH           'APPAUTO'|'APPMANUAL'|'APPHYBRID' 
    BETA MAX            decimal
    BETA MIN            decimal
    BETA STEP           decimal 
    COMPSMOOTH         'YES'|'NO' 
    CYCDECAY MAX        decimal
    CYCDECAY MIN        decimal 
    GAMMA MAX           decimal
    GAMMA MIN           decimal
    GAMMA STEP          decimal 
    HISTPERIODS         integer 
    MAXFACTOR           decimal 
    METHOD             'AUTOMATIC'|'LINREG'|'NLREG1'|'NLREG2'|
                       'NLREG3'|'NLREG4'|'NLREG5'|'SESMOOTH'| 
                       'DESMOOTH'|'HOLT/WINTERS' 
    MINFCFACTOR         decimal 
    MPTDECAY MAX        decimal
    MPTDECAY MIN        decimal 
    NTRIALS             integer 
    NUMFORECASTPERIODS  integer
    PERIODICITY         integer| up to 6 comma-separated integers
                        enclosed in parantheses 
    RATIO               decimal 
    SMOOTHING          'YES'|'NO' 
    TRANSFORM          'TRNOSEA'|'TRSEA'|'TRMPT' 
    TRENDHOLD MAX       decimal
    TRENDHOLD MIN       decimal
    TRENDHOLD STEP      decimal 
    WINDOWLEN           integer
 

See Also:

ForecastDefinition

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

ForecastArgument(BaseObject input)
Creates a ForecastArgument for the specified ForecastDefinition.

Method Summary

ForecastArgumentValue	createForecastAgrumentValue() Creates a ForecastArgumentValue for the forecasting keyword.
ForecastArgumentValue	getForecastArgumentValue() Returns the value for the forecasting keyword.
ForeCastKeyWord	getForecastKeyWord() Returns the forecasting keyword in the argument.
void	setForecastArgumentValue(ForecastArgumentValue input) Sets the value for the forecasting keyword.
void	setForecastKeyWord(ForeCastKeyWord input) Sets the forecasting keyword to the specified ForecastKeyWord.
void	setForecastKeyWord(java.lang.String input) Sets the forecasting keyword to the specified String.
java.lang.String	WriteToXML() Returns the ForecastArgument as an XML string.

Methods inherited from class oracle.AWXML.BaseObject

Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, 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

ForecastArgument

public ForecastArgument(BaseObject input)

Creates a ForecastArgument for the specified ForecastDefinition.

Parameters:

input - The ForecastDefinition that owns the new ForecastArgument.

Method Detail

WriteToXML

public java.lang.String WriteToXML()

Returns the ForecastArgument as an XML string.

Overrides:

WriteToXML in class BaseObject

Returns:

A String containing the XML that represents the ForecastArgument.

getForecastKeyWord

public ForeCastKeyWord getForecastKeyWord()

Returns the forecasting keyword in the argument.

Returns:

The ForeCastKeyWord in this ForecastArgument.

setForecastKeyWord

public void setForecastKeyWord(ForeCastKeyWord input)

Sets the forecasting keyword to the specified ForecastKeyWord.

Parameters:

input - The ForecastKeyWord to use in this ForecastArgument.

setForecastKeyWord

public void setForecastKeyWord(java.lang.String input)

Sets the forecasting keyword to the specified String. The string must be a valid value accepted by the OLAP DML FCSET command.

Parameters:

input - The name of the forecasting keyword.

setForecastArgumentValue

public void setForecastArgumentValue(ForecastArgumentValue input)

Sets the value for the forecasting keyword.

Parameters:

input - The ForecastArgumentValue of the ForecastKeyWord.

getForecastArgumentValue

public ForecastArgumentValue getForecastArgumentValue()

Returns the value for the forecasting keyword.

Returns:

The ForecastArgumentValue of the ForecastKeyWord.

createForecastAgrumentValue

public ForecastArgumentValue createForecastAgrumentValue()

Creates a ForecastArgumentValue for the forecasting keyword.

Returns:

The new ForecastArgumentValue.